AmazonQuickSight (AWS SDK for Java

All Known Subinterfaces:

AmazonQuickSightAsync

All Known Implementing Classes:

AbstractAmazonQuickSight, AbstractAmazonQuickSightAsync, AmazonQuickSightAsyncClient, AmazonQuickSightClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonQuickSight
```
Interface for accessing Amazon QuickSight.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonQuickSight instead.

Amazon QuickSight API Reference
Amazon QuickSight is a fully managed, serverless, cloud business intelligence service that makes it easy to extend data and insights to every user in your organization. This API interface reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateGroupResult`	`createGroup(CreateGroupRequest createGroupRequest)` Creates an Amazon QuickSight group.
`CreateGroupMembershipResult`	`createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)` Adds an Amazon QuickSight user to an Amazon QuickSight group.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest deleteGroupRequest)` Removes a user group from Amazon QuickSight.
`DeleteGroupMembershipResult`	`deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)` Removes a user from a group so that the user is no longer a member of the group.
`DeleteUserResult`	`deleteUser(DeleteUserRequest deleteUserRequest)` 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.
`DescribeGroupResult`	`describeGroup(DescribeGroupRequest describeGroupRequest)` Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
`DescribeUserResult`	`describeUser(DescribeUserRequest describeUserRequest)` Returns information about a user, given the user name.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDashboardEmbedUrlResult`	`getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)` Generates a server-side embeddable URL and authorization code.
`ListGroupMembershipsResult`	`listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)` Lists member users in a group.
`ListGroupsResult`	`listGroups(ListGroupsRequest listGroupsRequest)` Lists all user groups in Amazon QuickSight.
`ListUserGroupsResult`	`listUserGroups(ListUserGroupsRequest listUserGroupsRequest)` Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
`ListUsersResult`	`listUsers(ListUsersRequest listUsersRequest)` Returns a list of all of the Amazon QuickSight users belonging to this account.
`RegisterUserResult`	`registerUser(RegisterUserRequest registerUserRequest)` Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateGroupResult`	`updateGroup(UpdateGroupRequest updateGroupRequest)` Changes a group description.
`UpdateUserResult`	`updateUser(UpdateUserRequest updateUserRequest)` Updates an Amazon QuickSight user.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createGroup
```
CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"
    
    Parameters:
    
    createGroupRequest - The request object for this operation.
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceExistsException - The resource specified doesn't exist.
    
    ResourceNotFoundException - One or more resources can'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.
    
    See Also:
    
    AWS API Documentation
  - createGroupMembership
```
CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat
    
    Parameters:
    
    createGroupMembershipRequest -
    
    Returns:
    
    Result of the CreateGroupMembership operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can'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.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
```
    Removes a user group from Amazon QuickSight.
    
    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
    
    CLI Sample:
    
    aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management
    
    Parameters:
    
    deleteGroupRequest -
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can'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.
    
    See Also:
    
    AWS API Documentation
  - deleteGroupMembership
```
DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie
    
    Parameters:
    
    deleteGroupMembershipRequest -
    
    Returns:
    
    Result of the DeleteGroupMembership operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can'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.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    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> .
    
    CLI Sample:
    
    aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can't be found.
    
    ThrottlingException - Access is throttled.
    
    InternalFailureException - An internal failure occurred.
    
    ResourceUnavailableException - This resource is currently unavailable.
    
    See Also:
    
    AWS API Documentation
  - describeGroup
```
DescribeGroupResult describeGroup(DescribeGroupRequest describeGroupRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales
    
    Parameters:
    
    describeGroupRequest -
    
    Returns:
    
    Result of the DescribeGroup operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can'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.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
    
    Parameters:
    
    describeUserRequest -
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can't be found.
    
    ThrottlingException - Access is throttled.
    
    InternalFailureException - An internal failure occurred.
    
    ResourceUnavailableException - This resource is currently unavailable.
    
    See Also:
    
    AWS API Documentation
  - getDashboardEmbedUrl
```
GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
```
    Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.
    
    Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
    
    CLI Sample:
    
    Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml.
    
    aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession
    
    If the user does not exist in QuickSight, register the user:
    
    aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email [email protected] --region us-east-1
    
    Get the URL for the embedded dashboard
    
    aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM
    
    Parameters:
    
    getDashboardEmbedUrlRequest -
    
    Returns:
    
    Result of the GetDashboardEmbedUrl operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceExistsException - The resource specified doesn't exist.
    
    ResourceNotFoundException - One or more resources can'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 error can happen in any operation that requires finding a user based on a 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 not valid. The session lifetime must be from 15 to 600 minutes.
    
    UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't 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.
    
    See Also:
    
    AWS API Documentation
  - listGroupMemberships
```
ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default
    
    Parameters:
    
    listGroupMembershipsRequest -
    
    Returns:
    
    Result of the ListGroupMemberships operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can't be found.
    
    ThrottlingException - Access is throttled.
    
    InvalidNextTokenException - The NextToken value isn't valid.
    
    PreconditionNotMetException - One or more preconditions aren't met.
    
    InternalFailureException - An internal failure occurred.
    
    ResourceUnavailableException - This resource is currently unavailable.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default
    
    Parameters:
    
    listGroupsRequest -
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can't be found.
    
    ThrottlingException - Access is throttled.
    
    InvalidNextTokenException - The NextToken value isn't valid.
    
    PreconditionNotMetException - One or more preconditions aren't met.
    
    InternalFailureException - An internal failure occurred.
    
    ResourceUnavailableException - This resource is currently unavailable.
    
    See Also:
    
    AWS API Documentation
  - listUserGroups
```
ListUserGroupsResult listUserGroups(ListUserGroupsRequest listUserGroupsRequest)
```
    Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
    
    The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
    
    The response is a one or more group objects.
    
    CLI Sample:
    
    aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1
    
    Parameters:
    
    listUserGroupsRequest -
    
    Returns:
    
    Result of the ListUserGroups operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can't be found.
    
    ThrottlingException - Access is throttled.
    
    InternalFailureException - An internal failure occurred.
    
    ResourceUnavailableException - This resource is currently unavailable.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
ListUsersResult listUsers(ListUsersRequest listUsersRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight list-users --aws-account-id=111122223333 --namespace=default
    
    Parameters:
    
    listUsersRequest -
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can't be found.
    
    ThrottlingException - Access is throttled.
    
    InvalidNextTokenException - The NextToken value isn't valid.
    
    InternalFailureException - An internal failure occurred.
    
    ResourceUnavailableException - This resource is currently unavailable.
    
    See Also:
    
    AWS API Documentation
  - registerUser
```
RegisterUserResult registerUser(RegisterUserRequest registerUserRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\[email protected] -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat
    
    Parameters:
    
    registerUserRequest -
    
    Returns:
    
    Result of the RegisterUser operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can'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.
    
    See Also:
    
    AWS API Documentation
  - updateGroup
```
UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)
```
    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.
    
    CLI Sample:
    
    aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"
    
    Parameters:
    
    updateGroupRequest -
    
    Returns:
    
    Result of the UpdateGroup operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can'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.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
```
    Updates an Amazon QuickSight user.
    
    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 QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).
    
    CLI Sample:
    
    aws quicksight update-user --user-name=Pat --role=ADMIN [email protected] --aws-account-id=111122223333 --namespace=default --region=us-east-1
    
    Parameters:
    
    updateUserRequest -
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
    
    InvalidParameterValueException - One or more parameters don't have a valid value.
    
    ResourceNotFoundException - One or more resources can't be found.
    
    ThrottlingException - Access is throttled.
    
    InternalFailureException - An internal failure occurred.
    
    ResourceUnavailableException - This resource is currently unavailable.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonQuickSight

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createGroup

createGroupMembership

deleteGroup

deleteGroupMembership

deleteUser

describeGroup

describeUser

getDashboardEmbedUrl

listGroupMemberships

listGroups

listUserGroups

listUsers

registerUser

updateGroup

updateUser

shutdown

getCachedResponseMetadata