@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonQuickSightAsyncClient extends AmazonQuickSightClient implements AmazonQuickSightAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AmazonQuickSightAsyncClientBuilder |
asyncBuilder() |
Future<CreateGroupResult> |
createGroupAsync(CreateGroupRequest request)
Creates an Amazon QuickSight group.
|
Future<CreateGroupResult> |
createGroupAsync(CreateGroupRequest request,
AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
Creates an Amazon QuickSight group.
|
Future<CreateGroupMembershipResult> |
createGroupMembershipAsync(CreateGroupMembershipRequest request)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
|
Future<CreateGroupMembershipResult> |
createGroupMembershipAsync(CreateGroupMembershipRequest request,
AsyncHandler<CreateGroupMembershipRequest,CreateGroupMembershipResult> asyncHandler)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
|
Future<DeleteGroupResult> |
deleteGroupAsync(DeleteGroupRequest request)
Removes a user group from Amazon QuickSight.
|
Future<DeleteGroupResult> |
deleteGroupAsync(DeleteGroupRequest request,
AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
Removes a user group from Amazon QuickSight.
|
Future<DeleteGroupMembershipResult> |
deleteGroupMembershipAsync(DeleteGroupMembershipRequest request)
Removes a user from a group so that the user is no longer a member of the group.
|
Future<DeleteGroupMembershipResult> |
deleteGroupMembershipAsync(DeleteGroupMembershipRequest request,
AsyncHandler<DeleteGroupMembershipRequest,DeleteGroupMembershipResult> asyncHandler)
Removes a user from a group so that the user is no longer a member of the group.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest request)
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.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest request,
AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
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.
|
Future<DeleteUserByPrincipalIdResult> |
deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request)
Deletes a user after locating the user by its principal ID.
|
Future<DeleteUserByPrincipalIdResult> |
deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request,
AsyncHandler<DeleteUserByPrincipalIdRequest,DeleteUserByPrincipalIdResult> asyncHandler)
Deletes a user after locating the user by its principal ID.
|
Future<DescribeGroupResult> |
describeGroupAsync(DescribeGroupRequest request)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
|
Future<DescribeGroupResult> |
describeGroupAsync(DescribeGroupRequest request,
AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
|
Future<DescribeUserResult> |
describeUserAsync(DescribeUserRequest request)
Returns information about a user, given the user name.
|
Future<DescribeUserResult> |
describeUserAsync(DescribeUserRequest request,
AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Returns information about a user, given the user name.
|
Future<GetDashboardEmbedUrlResult> |
getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request)
Generates a server-side embeddable URL and authorization code.
|
Future<GetDashboardEmbedUrlResult> |
getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request,
AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler)
Generates a server-side embeddable URL and authorization code.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<ListGroupMembershipsResult> |
listGroupMembershipsAsync(ListGroupMembershipsRequest request)
Lists member users in a group.
|
Future<ListGroupMembershipsResult> |
listGroupMembershipsAsync(ListGroupMembershipsRequest request,
AsyncHandler<ListGroupMembershipsRequest,ListGroupMembershipsResult> asyncHandler)
Lists member users in a group.
|
Future<ListGroupsResult> |
listGroupsAsync(ListGroupsRequest request)
Lists all user groups in Amazon QuickSight.
|
Future<ListGroupsResult> |
listGroupsAsync(ListGroupsRequest request,
AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Lists all user groups in Amazon QuickSight.
|
Future<ListUserGroupsResult> |
listUserGroupsAsync(ListUserGroupsRequest request)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
Future<ListUserGroupsResult> |
listUserGroupsAsync(ListUserGroupsRequest request,
AsyncHandler<ListUserGroupsRequest,ListUserGroupsResult> asyncHandler)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest request)
Returns a list of all of the Amazon QuickSight users belonging to this account.
|
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest request,
AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Returns a list of all of the Amazon QuickSight users belonging to this account.
|
Future<RegisterUserResult> |
registerUserAsync(RegisterUserRequest request)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM)
identity or role specified in the request.
|
Future<RegisterUserResult> |
registerUserAsync(RegisterUserRequest request,
AsyncHandler<RegisterUserRequest,RegisterUserResult> asyncHandler)
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 the client, releasing all managed resources.
|
Future<UpdateGroupResult> |
updateGroupAsync(UpdateGroupRequest request)
Changes a group description.
|
Future<UpdateGroupResult> |
updateGroupAsync(UpdateGroupRequest request,
AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
Changes a group description.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest request)
Updates an Amazon QuickSight user.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest request,
AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Updates an Amazon QuickSight user.
|
builder, createGroup, createGroupMembership, deleteGroup, deleteGroupMembership, deleteUser, deleteUserByPrincipalId, describeGroup, describeUser, getCachedResponseMetadata, getDashboardEmbedUrl, listGroupMemberships, listGroups, listUserGroups, listUsers, registerUser, updateGroup, updateUseraddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateGroup, createGroupMembership, deleteGroup, deleteGroupMembership, deleteUser, deleteUserByPrincipalId, describeGroup, describeUser, getCachedResponseMetadata, getDashboardEmbedUrl, listGroupMemberships, listGroups, listUserGroups, listUsers, registerUser, updateGroup, updateUserpublic static AmazonQuickSightAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request)
AmazonQuickSightAsyncCreates 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"
createGroupAsync in interface AmazonQuickSightAsyncrequest - The request object for this operation.public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
AmazonQuickSightAsyncCreates 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"
createGroupAsync in interface AmazonQuickSightAsyncrequest - The request object for this operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest request)
AmazonQuickSightAsyncAdds 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
createGroupMembershipAsync in interface AmazonQuickSightAsyncpublic Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest request, AsyncHandler<CreateGroupMembershipRequest,CreateGroupMembershipResult> asyncHandler)
AmazonQuickSightAsyncAdds 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
createGroupMembershipAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)
AmazonQuickSightAsyncRemoves 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
deleteGroupAsync in interface AmazonQuickSightAsyncpublic Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AmazonQuickSightAsyncRemoves 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
deleteGroupAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest request)
AmazonQuickSightAsyncRemoves 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
deleteGroupMembershipAsync in interface AmazonQuickSightAsyncpublic Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest request, AsyncHandler<DeleteGroupMembershipRequest,DeleteGroupMembershipResult> asyncHandler)
AmazonQuickSightAsyncRemoves 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
deleteGroupMembershipAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AmazonQuickSightAsyncDeletes 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
deleteUserAsync in interface AmazonQuickSightAsyncpublic Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AmazonQuickSightAsyncDeletes 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
deleteUserAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request)
AmazonQuickSightAsyncDeletes a user after locating the user by its principal ID.
deleteUserByPrincipalIdAsync in interface AmazonQuickSightAsyncpublic Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request, AsyncHandler<DeleteUserByPrincipalIdRequest,DeleteUserByPrincipalIdResult> asyncHandler)
AmazonQuickSightAsyncDeletes a user after locating the user by its principal ID.
deleteUserByPrincipalIdAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request)
AmazonQuickSightAsyncReturns 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
describeGroupAsync in interface AmazonQuickSightAsyncpublic Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request, AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)
AmazonQuickSightAsyncReturns 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
describeGroupAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)
AmazonQuickSightAsyncReturns 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
describeUserAsync in interface AmazonQuickSightAsyncpublic Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
AmazonQuickSightAsyncReturns 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
describeUserAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request)
AmazonQuickSightAsyncGenerates 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
getDashboardEmbedUrlAsync in interface AmazonQuickSightAsyncpublic Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request, AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler)
AmazonQuickSightAsyncGenerates 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
getDashboardEmbedUrlAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest request)
AmazonQuickSightAsyncLists 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
listGroupMembershipsAsync in interface AmazonQuickSightAsyncpublic Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest request, AsyncHandler<ListGroupMembershipsRequest,ListGroupMembershipsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listGroupMembershipsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request)
AmazonQuickSightAsyncLists 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
listGroupsAsync in interface AmazonQuickSightAsyncpublic Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listGroupsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUserGroupsResult> listUserGroupsAsync(ListUserGroupsRequest request)
AmazonQuickSightAsyncLists 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
listUserGroupsAsync in interface AmazonQuickSightAsyncpublic Future<ListUserGroupsResult> listUserGroupsAsync(ListUserGroupsRequest request, AsyncHandler<ListUserGroupsRequest,ListUserGroupsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listUserGroupsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)
AmazonQuickSightAsyncReturns 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
listUsersAsync in interface AmazonQuickSightAsyncpublic Future<ListUsersResult> listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
AmazonQuickSightAsyncReturns 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
listUsersAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RegisterUserResult> registerUserAsync(RegisterUserRequest request)
AmazonQuickSightAsyncCreates 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
registerUserAsync in interface AmazonQuickSightAsyncpublic Future<RegisterUserResult> registerUserAsync(RegisterUserRequest request, AsyncHandler<RegisterUserRequest,RegisterUserResult> asyncHandler)
AmazonQuickSightAsyncCreates 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
registerUserAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request)
AmazonQuickSightAsyncChanges 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"
updateGroupAsync in interface AmazonQuickSightAsyncpublic Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
AmazonQuickSightAsyncChanges 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"
updateGroupAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)
AmazonQuickSightAsyncUpdates 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
updateUserAsync in interface AmazonQuickSightAsyncpublic Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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
updateUserAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonQuickSightshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.