Amazon QuickSight 2018-04-01
- Client: Aws\QuickSight\QuickSightClient
- Service ID: quicksight
- Version: 2018-04-01
This page describes the parameters and results for the operations of the Amazon QuickSight (2018-04-01), and shows how to use the Aws\QuickSight\QuickSightClient object to call the described operations. This documentation is specific to the 2018-04-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateGroup ( array $params = [] )
Creates an Amazon QuickSight group.
- CreateGroupMembership ( array $params = [] )
Adds an Amazon QuickSight user to an Amazon QuickSight group.
- DeleteGroup ( array $params = [] )
Removes a user group from Amazon QuickSight.
- DeleteGroupMembership ( array $params = [] )
Removes a user from a group so that the user is no longer a member of the group.
- DeleteUser ( array $params = [] )
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call.
- DescribeGroup ( array $params = [] )
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
- DescribeUser ( array $params = [] )
Returns information about a user, given the user name.
- GetDashboardEmbedUrl ( array $params = [] )
Generates an embedded URL and authorization code.
- ListGroupMemberships ( array $params = [] )
Lists member users in a group.
- ListGroups ( array $params = [] )
Lists all user groups in Amazon QuickSight.
- ListUserGroups ( array $params = [] )
Lists the Amazon QuickSight groups that a user is part of.
- ListUsers ( array $params = [] )
Returns a list of all of the Amazon QuickSight users belonging to this account.
- RegisterUser ( array $params = [] )
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
- UpdateGroup ( array $params = [] )
Changes a group description.
- UpdateUser ( array $params = [] )
Updates an Amazon QuickSight user.
Operations
CreateGroup
$result = $client->createGroup([/* ... */]); $promise = $client->createGroupAsync([/* ... */]);
Creates an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is a group object.
Parameter Syntax
$result = $client->createGroup([
'AwsAccountId' => '<string>', // REQUIRED
'Description' => '<string>',
'GroupName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Description
-
- Type: string
A description for the group that you want to create.
- GroupName
-
- Required: Yes
- Type: string
A name for the group that you want to create.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'Group' => [
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Group
-
- Type: Group structure
The name of the group.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceExistsException:
The resource specified doesn't exist.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
PreconditionNotMetException:
One or more preconditions aren't met.
-
LimitExceededException:
A limit is exceeded.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
CreateGroupMembership
$result = $client->createGroupMembership([/* ... */]); $promise = $client->createGroupMembershipAsync([/* ... */]);
Adds an Amazon QuickSight user to an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
The response is the group member object.
Parameter Syntax
$result = $client->createGroupMembership([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'MemberName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to add the user to.
- MemberName
-
- Required: Yes
- Type: string
The name of the user that you want to add to the group membership.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'GroupMember' => [
'Arn' => '<string>',
'MemberName' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- GroupMember
-
- Type: GroupMember structure
The group member.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
PreconditionNotMetException:
One or more preconditions aren't met.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
DeleteGroup
$result = $client->deleteGroup([/* ... */]); $promise = $client->deleteGroupAsync([/* ... */]);
Removes a user group from Amazon QuickSight.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
Parameter Syntax
$result = $client->deleteGroup([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to delete.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
PreconditionNotMetException:
One or more preconditions aren't met.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
DeleteGroupMembership
$result = $client->deleteGroupMembership([/* ... */]); $promise = $client->deleteGroupMembershipAsync([/* ... */]);
Removes a user from a group so that the user is no longer a member of the group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
Parameter Syntax
$result = $client->deleteGroupMembership([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'MemberName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to delete the user from.
- MemberName
-
- Required: Yes
- Type: string
The name of the user that you want to delete from the group membership.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
PreconditionNotMetException:
One or more preconditions aren't met.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
DeleteUser
$result = $client->deleteUser([/* ... */]); $promise = $client->deleteUserAsync([/* ... */]);
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
Parameter Syntax
$result = $client->deleteUser([
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - UserName
-
- Required: Yes
- Type: string
The name of the user that you want to delete.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
DescribeGroup
$result = $client->describeGroup([/* ... */]); $promise = $client->describeGroupAsync([/* ... */]);
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is the group object.
Parameter Syntax
$result = $client->describeGroup([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to describe.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'Group' => [
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Group
-
- Type: Group structure
The name of the group.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
PreconditionNotMetException:
One or more preconditions aren't met.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
DescribeUser
$result = $client->describeUser([/* ... */]); $promise = $client->describeUserAsync([/* ... */]);
Returns information about a user, given the user name.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
Parameter Syntax
$result = $client->describeUser([
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - UserName
-
- Required: Yes
- Type: string
The name of the user that you want to describe.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'User' => [
'Active' => true || false,
'Arn' => '<string>',
'Email' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT',
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER',
'UserName' => '<string>',
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- User
-
- Type: User structure
The user name.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
GetDashboardEmbedUrl
$result = $client->getDashboardEmbedUrl([/* ... */]); $promise = $client->getDashboardEmbedUrlAsync([/* ... */]);
Generates an embedded URL and authorization code. Before this can work properly, you need to configure the dashboards and user permissions first.
Parameter Syntax
$result = $client->getDashboardEmbedUrl([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'IdentityType' => 'IAM|QUICKSIGHT', // REQUIRED
'ResetDisabled' => true || false,
'SessionLifetimeInMinutes' => <integer>,
'UndoRedoDisabled' => true || false,
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the dashboard you are embedding.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard, also added to IAM policy
- IdentityType
-
- Required: Yes
- Type: string
The authentication method the user uses to sign in (IAM or QUICKSIGHT).
- ResetDisabled
-
- Type: boolean
Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
- SessionLifetimeInMinutes
-
- Type: long (int|float)
How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
- UndoRedoDisabled
-
- Type: boolean
Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.
Result Syntax
[
'EmbedUrl' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- EmbedUrl
-
- Type: string
Call the GetDashboardEmbedUrl API to get the URL that you can embed in your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceExistsException:
The resource specified doesn't exist.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
PreconditionNotMetException:
One or more preconditions aren't met.
-
DomainNotWhitelistedException:
The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
-
QuickSightUserNotFoundException:
The user is not found. This could happen in any operation that requires finding a user based on the provided user name, such as DeleteUser, DescribeUser, and so on.
-
IdentityTypeNotSupportedException:
The identity type specified is not supported. Supported identity types include: IAM and QUICKSIGHT.
-
SessionLifetimeInMinutesInvalidException:
The number of minutes specified for the lifetime of a session is invalid. The session lifetime must be between 15 and 600 minutes.
-
UnsupportedUserEditionException:
Indicates that you are calling an operation on an Amazon QuickSight subscription where the edition does not include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
ListGroupMemberships
$result = $client->listGroupMemberships([/* ... */]); $promise = $client->listGroupMembershipsAsync([/* ... */]);
Lists member users in a group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a list of group member objects.
Parameter Syntax
$result = $client->listGroupMemberships([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to see a membership list of.
- MaxResults
-
- Type: int
The maximum number of results to return from this request.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
Result Syntax
[
'GroupMemberList' => [
[
'Arn' => '<string>',
'MemberName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- GroupMemberList
-
- Type: Array of GroupMember structures
The list of the members of the group.
- NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
InvalidNextTokenException:
The
NextTokenvalue isn't valid. -
PreconditionNotMetException:
One or more preconditions aren't met.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
ListGroups
$result = $client->listGroups([/* ... */]); $promise = $client->listGroupsAsync([/* ... */]);
Lists all user groups in Amazon QuickSight.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.
The response is a list of group objects.
Parameter Syntax
$result = $client->listGroups([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- MaxResults
-
- Type: int
The maximum number of results to return.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
Result Syntax
[
'GroupList' => [
[
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- GroupList
-
- Type: Array of Group structures
The list of the groups.
- NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
InvalidNextTokenException:
The
NextTokenvalue isn't valid. -
PreconditionNotMetException:
One or more preconditions aren't met.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
ListUserGroups
$result = $client->listUserGroups([/* ... */]); $promise = $client->listUserGroupsAsync([/* ... */]);
Lists the Amazon QuickSight groups that a user is part of.
Parameter Syntax
$result = $client->listUserGroups([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS Account ID that the user is in. Currently, use the AWS Account ID which contains your Amazon QuickSight account.
- MaxResults
-
- Type: int
The maximum number of results to return from this request.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- UserName
-
- Required: Yes
- Type: string
The name of the user that you want to list groups for.
Result Syntax
[
'GroupList' => [
[
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- GroupList
-
- Type: Array of Group structures
The list of groups the user is a member of.
- NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
ListUsers
$result = $client->listUsers([/* ... */]); $promise = $client->listUsersAsync([/* ... */]);
Returns a list of all of the Amazon QuickSight users belonging to this account.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* .
The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
Parameter Syntax
$result = $client->listUsers([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- MaxResults
-
- Type: int
The maximum number of results to return from this request.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
Result Syntax
[
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'UserList' => [
[
'Active' => true || false,
'Arn' => '<string>',
'Email' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT',
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER',
'UserName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- UserList
-
- Type: Array of User structures
The list of users.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
InvalidNextTokenException:
The
NextTokenvalue isn't valid. -
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
RegisterUser
$result = $client->registerUser([/* ... */]); $promise = $client->registerUserAsync([/* ... */]);
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.
The condition keys are quicksight:IamArn and quicksight:SessionName.
Parameter Syntax
$result = $client->registerUser([
'AwsAccountId' => '<string>', // REQUIRED
'Email' => '<string>', // REQUIRED
'IamArn' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'SessionName' => '<string>',
'UserName' => '<string>',
'UserRole' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
-
- Required: Yes
- Type: string
The email address of the user that you want to register.
- IamArn
-
- Type: string
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
- IdentityType
-
- Required: Yes
- Type: string
Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
-
IAM: A user whose identity maps to an existing IAM user or role. -
QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - SessionName
-
- Type: string
The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see
assume-rolein the AWS CLI Reference. - UserName
-
- Type: string
The Amazon QuickSight user name that you want to create for the user you are registering.
- UserRole
-
- Required: Yes
- Type: string
The Amazon QuickSight role of the user. The user role can be one of the following:
-
READER: A user who has read-only access to dashboards. -
AUTHOR: A user who can create data sources, data sets, analyses, and dashboards. -
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'User' => [
'Active' => true || false,
'Arn' => '<string>',
'Email' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT',
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER',
'UserName' => '<string>',
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- User
-
- Type: User structure
The user name.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
LimitExceededException:
A limit is exceeded.
-
ResourceExistsException:
The resource specified doesn't exist.
-
PreconditionNotMetException:
One or more preconditions aren't met.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
UpdateGroup
$result = $client->updateGroup([/* ... */]); $promise = $client->updateGroupAsync([/* ... */]);
Changes a group description.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a group object.
Parameter Syntax
$result = $client->updateGroup([
'AwsAccountId' => '<string>', // REQUIRED
'Description' => '<string>',
'GroupName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Description
-
- Type: string
The description for the group that you want to update.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to update.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'Group' => [
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Group
-
- Type: Group structure
The name of the group.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
PreconditionNotMetException:
One or more preconditions aren't met.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
UpdateUser
$result = $client->updateUser([/* ... */]); $promise = $client->updateUserAsync([/* ... */]);
Updates an Amazon QuickSight user.
Parameter Syntax
$result = $client->updateUser([
'AwsAccountId' => '<string>', // REQUIRED
'Email' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER', // REQUIRED
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
-
- Required: Yes
- Type: string
The email address of the user that you want to update.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - Role
-
- Required: Yes
- Type: string
The Amazon QuickSight role of the user. The user role can be one of the following:
-
READER: A user who has read-only access to dashboards. -
AUTHOR: A user who can create data sources, data sets, analyses, and dashboards. -
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
- UserName
-
- Required: Yes
- Type: string
The Amazon QuickSight user name that you want to update.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'User' => [
'Active' => true || false,
'Arn' => '<string>',
'Email' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT',
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER',
'UserName' => '<string>',
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- User
-
- Type: User structure
The Amazon QuickSight user.
Errors
-
AccessDeniedException:
You don't have access to this.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
ResourceNotFoundException:
One or more resources couldn't be found.
-
ThrottlingException:
Access is throttled.
-
InternalFailureException:
An internal failure occurred.
-
ResourceUnavailableException:
This resource is currently unavailable.
Shapes
AccessDeniedException
Description
You don't have access to this.
Members
DomainNotWhitelistedException
Description
The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
Members
Group
Description
A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups.
Members
GroupMember
Description
A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group.
Members
IdentityTypeNotSupportedException
Description
The identity type specified is not supported. Supported identity types include: IAM and QUICKSIGHT.
Members
InternalFailureException
Description
An internal failure occurred.
Members
InvalidNextTokenException
Description
The NextToken value isn't valid.
Members
InvalidParameterValueException
Description
One or more parameters don't have a valid value.
Members
LimitExceededException
Description
A limit is exceeded.
Members
PreconditionNotMetException
Description
One or more preconditions aren't met.
Members
QuickSightUserNotFoundException
Description
The user is not found. This could happen in any operation that requires finding a user based on the provided user name, such as DeleteUser, DescribeUser, and so on.
Members
ResourceExistsException
Description
The resource specified doesn't exist.
Members
ResourceNotFoundException
Description
One or more resources couldn't be found.
Members
ResourceUnavailableException
Description
This resource is currently unavailable.
Members
SessionLifetimeInMinutesInvalidException
Description
The number of minutes specified for the lifetime of a session is invalid. The session lifetime must be between 15 and 600 minutes.
Members
ThrottlingException
Description
Access is throttled.
Members
UnsupportedUserEditionException
Description
Indicates that you are calling an operation on an Amazon QuickSight subscription where the edition does not include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
Members
User
Description
A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.
Members
- Active
-
- Type: boolean
Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the user.
-
- Type: string
The user's email address.
- IdentityType
-
- Type: string
The type of identity authentication used by the user.
- Role
-
- Type: string
The Amazon QuickSight role for the user.
- UserName
-
- Type: string
The user's user name.
