| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.QuickSight.CreateGroup
Description
Use the CreateGroup operation to create a group in Amazon QuickSight.
You can create up to 10,000 groups in a namespace. If you want to create
more than 10,000 groups in a namespace, contact AWS Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> .
The response is a group object.
Synopsis
- data CreateGroup = CreateGroup' {
- description :: Maybe Text
- groupName :: Text
- awsAccountId :: Text
- namespace :: Text
- newCreateGroup :: Text -> Text -> Text -> CreateGroup
- createGroup_description :: Lens' CreateGroup (Maybe Text)
- createGroup_groupName :: Lens' CreateGroup Text
- createGroup_awsAccountId :: Lens' CreateGroup Text
- createGroup_namespace :: Lens' CreateGroup Text
- data CreateGroupResponse = CreateGroupResponse' {}
- newCreateGroupResponse :: Int -> CreateGroupResponse
- createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group)
- createGroupResponse_requestId :: Lens' CreateGroupResponse (Maybe Text)
- createGroupResponse_status :: Lens' CreateGroupResponse Int
Creating a Request
data CreateGroup Source #
The request object for this operation.
See: newCreateGroup smart constructor.
Constructors
| CreateGroup' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateGroup |
Create a value of CreateGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateGroup, createGroup_description - A description for the group that you want to create.
CreateGroup, createGroup_groupName - A name for the group that you want to create.
CreateGroup, createGroup_awsAccountId - The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that
contains your Amazon QuickSight account.
CreateGroup, createGroup_namespace - The namespace that you want the group to be a part of.
Request Lenses
createGroup_description :: Lens' CreateGroup (Maybe Text) Source #
A description for the group that you want to create.
createGroup_groupName :: Lens' CreateGroup Text Source #
A name for the group that you want to create.
createGroup_awsAccountId :: Lens' CreateGroup Text Source #
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
createGroup_namespace :: Lens' CreateGroup Text Source #
The namespace that you want the group to be a part of.
Destructuring the Response
data CreateGroupResponse Source #
The response object for this operation.
See: newCreateGroupResponse smart constructor.
Constructors
| CreateGroupResponse' | |
Instances
newCreateGroupResponse Source #
Arguments
| :: Int | |
| -> CreateGroupResponse |
Create a value of CreateGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:group':CreateGroupResponse', createGroupResponse_group - The name of the group.
$sel:requestId:CreateGroupResponse', createGroupResponse_requestId - The Amazon Web Services request ID for this operation.
CreateGroupResponse, createGroupResponse_status - The HTTP status of the request.
Response Lenses
createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group) Source #
The name of the group.
createGroupResponse_requestId :: Lens' CreateGroupResponse (Maybe Text) Source #
The Amazon Web Services request ID for this operation.
createGroupResponse_status :: Lens' CreateGroupResponse Int Source #
The HTTP status of the request.