# Group operations
With group API operations, you can perform actions on groups. For more information, see the following API operations.
**Topics**
+ [Group membership operations](group-membership.md)
+ [CreateGroup](create-group.md)
+ [DeleteGroup](delete-group.md)
+ [DescribeGroup](describe-group.md)
+ [ListGroups](list-groups.md)
+ [SearchGroups](search-groups.md)
+ [UpdateGroup](update-group.md)
# Group membership operations
With group membership API operations, you can view and update permissions for members in a group. For more information, see the following API operations.
**Topics**
+ [CreateGroupMembership](create-group-membership.md)
+ [DeleteGroupMembership](delete-group-membership.md)
+ [DescribeGroupMembership](describe-group-membership.md)
+ [ListGroupMemberships](list-group-memberships.md)
# CreateGroupMembership
Use the `CreateGroupMembership` API operation to add an Amazon Quick Sight user to a Quick Sight group. You can find users in a certain group by calling the `ListGroups` API operation, and then the `ListGroupMemberships` API operation on the group of your choice.
Following is an example AWS CLI command for this operation. In the following examples, the member *`USERNAME`* is added to the group *`GROUPNAME`*.
------
#### [ AWS CLI ]
```
aws quicksight create-group-membership
--namespace default
--aws-account-id AWSACCOUNTID
--group-name GROUPNAME
--member-name USERNAME
```
You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md).
```
aws quicksight create-group-membership
--cli-input-json file://creategroupmembership.json
```
------
For more information about the `CreateGroupMembership` API operation, see [CreateGroupMembership](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateGroupMembership.html) in the *Amazon Quick Sight API Reference*.
# DeleteGroupMembership
Use the `DeleteGroupMembership` API operation to remove a user from a group so that the user is no longer a member of the group. You can find users in a certain group by calling the `ListGroups` API operation, and then the `ListGroupMemberships` operation on the group that you choose.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight delete-group-membership
--member-name USERNAME
--group-name GROUPNAME
--aws-account-id AWSACCOUNTID
--namespace NAMESPACE
```
------
For more information about the `DeleteGroupMembership` API operation, see [DeleteGroupMembership](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DeleteGroupMembership.html) in the *Amazon Quick Sight API Reference*.
# DescribeGroupMembership
Use the `DescribeGroupMembership` API operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated `GroupMember` object is returned.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
CLI Input:
```
aws quicksight describe-group-membership
--region us-west-2
--aws-account-id AWSACCOUNTID
--namespace NAMESPACE
--group-name Marketing-East
--member-name MEMBERNAME
```
------
For more information about the `ListGroups` API operation, see [DescribeGroupMembership](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeGroupMembership.html) in the *Amazon Quick Sight API Reference*.
# ListGroupMemberships
Use the `ListGroupMemberships` API operation to list member users in a group. To view a list of user groups in Amazon Quick Sight, call the `ListGroups` API operation.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight list-group-memberships
--group-name GROUPNAME
--max-results 100
--aws-account-id AWSACCOUNTID
--namespace NAMESPACE
```
------
For more information about the `ListGroupMemberships` API operation, see [ListGroupMemberships](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ListGroupMemberships.html) in the *Amazon Quick Sight API Reference*.
# CreateGroup
Use the `CreateGroup` API operation to create a user group in Amazon Quick Sight. Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight create-group
--namespace NAMESPACE
--aws-account-id AWSACCOUNTID
--group-name GROUPNAME
```
You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md).
```
aws quicksight create-group
--cli-input-json file://creategroup.json
```
------
For more information about the `CreateGroup` API operation, see [CreateGroup](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateGroup.html) in the *Amazon Quick Sight API Reference*.
# DeleteGroup
Use the `DeleteGroup` API operation to remove a user group from Amazon Quick Sight. You can find a group name by calling the `ListGroups` API operation.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight delete-group
--group-name GROUPNAME
--aws-account-id AWSACCOUNTID
--namespace default
```
------
For more information about the `DeleteGroup` API operation, see [DeleteGroup](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DeleteGroup.html) in the *Amazon Quick Sight API Reference*.
# DescribeGroup
Use the `DescribeGroup` API operation to view an Amazon Quick Sight group's description and Amazon Resource Name (ARN). You can find a group name by calling the `ListGroups` API operation.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight describe-group
--group-name GROUPNAME
--aws-account-id AWSACCOUNTID
--namespace default
```
------
For more information about the `DescribeGroup` API operation, see [DescribeGroup](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeGroup.html) in the *Amazon Quick Sight API Reference*.
# ListGroups
Use the `ListGroups` API operation to list all user groups in Amazon Quick Sight. Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight list-groups
--aws-account-id AWSACCOUNTID
--max-results 100
--namespace default
```
------
For more information about the `ListGroups` API operation, see [ListGroups](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ListGroups.html) in the *Amazon Quick Sight API Reference*.
# SearchGroups
Use the `SearchGroups` operation to search groups in a specified Quick Sight namespace using the supplied filters.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
CLI Input:
```
aws quicksight search-groups
--region us-west-2
--aws-account-id AWSACCOUNTID
--namespace default
--filters "[{\"Operator\": \"StringLike\", \"Name\": \"GROUP_NAME\", \"Value\": \"Mar\"}]"
```
------
For more information about the `SearchGroups` API operation, see [SearchGroups](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_SearchGroups.html) in the *Amazon Quick Sight API Reference*.
# UpdateGroup
Use the `UpdateGroup` API operation to change a group description. You can find a group name by calling the `ListGroups` API operation.
Following is an example AWS CLI command for this operation.
------
#### [ AWS CLI ]
```
aws quicksight update-group
--group-name GROUPNAME
--description "NEW DESCRIPTION"
--aws-account-id AWSACCOUNTID
--namespace default
```
You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md).
```
aws quicksight update-group
--cli-input-json file://updategroup.json
```
------
For more information about the `UpdateGroup` API operation, see [UpdateGroup](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateGroup.html) in the *Amazon Quick Sight API Reference*.