com.amazonaws.services.quicksight

Interface AmazonQuickSightAsync

All Superinterfaces:

AmazonQuickSight

All Known Implementing Classes:

AbstractAmazonQuickSightAsync, AmazonQuickSightAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonQuickSightAsync
extends AmazonQuickSight

Interface for accessing Amazon QuickSight asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonQuickSightAsync 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 inherited from interface com.amazonaws.services.quicksight.AmazonQuickSight

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<CreateGroupResult>	createGroupAsync(CreateGroupRequest createGroupRequest) Creates an Amazon QuickSight group.
Future<CreateGroupResult>	createGroupAsync(CreateGroupRequest createGroupRequest, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler) Creates an Amazon QuickSight group.
Future<CreateGroupMembershipResult>	createGroupMembershipAsync(CreateGroupMembershipRequest createGroupMembershipRequest) Adds an Amazon QuickSight user to an Amazon QuickSight group.
Future<CreateGroupMembershipResult>	createGroupMembershipAsync(CreateGroupMembershipRequest createGroupMembershipRequest, AsyncHandler<CreateGroupMembershipRequest,CreateGroupMembershipResult> asyncHandler) Adds an Amazon QuickSight user to an Amazon QuickSight group.
Future<DeleteGroupResult>	deleteGroupAsync(DeleteGroupRequest deleteGroupRequest) Removes a user group from Amazon QuickSight.
Future<DeleteGroupResult>	deleteGroupAsync(DeleteGroupRequest deleteGroupRequest, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler) Removes a user group from Amazon QuickSight.
Future<DeleteGroupMembershipResult>	deleteGroupMembershipAsync(DeleteGroupMembershipRequest deleteGroupMembershipRequest) Removes a user from a group so that the user is no longer a member of the group.
Future<DeleteGroupMembershipResult>	deleteGroupMembershipAsync(DeleteGroupMembershipRequest deleteGroupMembershipRequest, 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 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.
Future<DeleteUserResult>	deleteUserAsync(DeleteUserRequest deleteUserRequest, 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 deleteUserByPrincipalIdRequest) Deletes a user after locating the user by its principal ID.
Future<DeleteUserByPrincipalIdResult>	deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest, AsyncHandler<DeleteUserByPrincipalIdRequest,DeleteUserByPrincipalIdResult> asyncHandler) Deletes a user after locating the user by its principal ID.
Future<DescribeGroupResult>	describeGroupAsync(DescribeGroupRequest describeGroupRequest) Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
Future<DescribeGroupResult>	describeGroupAsync(DescribeGroupRequest describeGroupRequest, AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler) Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
Future<DescribeUserResult>	describeUserAsync(DescribeUserRequest describeUserRequest) Returns information about a user, given the user name.
Future<DescribeUserResult>	describeUserAsync(DescribeUserRequest describeUserRequest, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler) Returns information about a user, given the user name.
Future<GetDashboardEmbedUrlResult>	getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest) Generates a server-side embeddable URL and authorization code.
Future<GetDashboardEmbedUrlResult>	getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest, AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler) Generates a server-side embeddable URL and authorization code.
Future<ListGroupMembershipsResult>	listGroupMembershipsAsync(ListGroupMembershipsRequest listGroupMembershipsRequest) Lists member users in a group.
Future<ListGroupMembershipsResult>	listGroupMembershipsAsync(ListGroupMembershipsRequest listGroupMembershipsRequest, AsyncHandler<ListGroupMembershipsRequest,ListGroupMembershipsResult> asyncHandler) Lists member users in a group.
Future<ListGroupsResult>	listGroupsAsync(ListGroupsRequest listGroupsRequest) Lists all user groups in Amazon QuickSight.
Future<ListGroupsResult>	listGroupsAsync(ListGroupsRequest listGroupsRequest, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler) Lists all user groups in Amazon QuickSight.
Future<ListUserGroupsResult>	listUserGroupsAsync(ListUserGroupsRequest listUserGroupsRequest) Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
Future<ListUserGroupsResult>	listUserGroupsAsync(ListUserGroupsRequest listUserGroupsRequest, AsyncHandler<ListUserGroupsRequest,ListUserGroupsResult> asyncHandler) Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
Future<ListUsersResult>	listUsersAsync(ListUsersRequest listUsersRequest) Returns a list of all of the Amazon QuickSight users belonging to this account.
Future<ListUsersResult>	listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler) Returns a list of all of the Amazon QuickSight users belonging to this account.
Future<RegisterUserResult>	registerUserAsync(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.
Future<RegisterUserResult>	registerUserAsync(RegisterUserRequest registerUserRequest, 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.
Future<UpdateGroupResult>	updateGroupAsync(UpdateGroupRequest updateGroupRequest) Changes a group description.
Future<UpdateGroupResult>	updateGroupAsync(UpdateGroupRequest updateGroupRequest, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler) Changes a group description.
Future<UpdateUserResult>	updateUserAsync(UpdateUserRequest updateUserRequest) Updates an Amazon QuickSight user.
Future<UpdateUserResult>	updateUserAsync(UpdateUserRequest updateUserRequest, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler) Updates an Amazon QuickSight user.

Methods inherited from interface com.amazonaws.services.quicksight.AmazonQuickSight

createGroup, createGroupMembership, deleteGroup, deleteGroupMembership, deleteUser, deleteUserByPrincipalId, describeGroup, describeUser, getCachedResponseMetadata, getDashboardEmbedUrl, listGroupMemberships, listGroups, listUserGroups, listUsers, registerUser, shutdown, updateGroup, updateUser

Method Detail

createGroupAsync

Future<CreateGroupResult> createGroupAsync(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:

A Java Future containing the result of the CreateGroup operation returned by the service.

See Also:

AWS API Documentation

createGroupAsync

Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest,
                                           AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)

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.

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.

Returns:

A Java Future containing the result of the CreateGroup operation returned by the service.

See Also:

AWS API Documentation

createGroupMembershipAsync

Future<CreateGroupMembershipResult> createGroupMembershipAsync(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:

A Java Future containing the result of the CreateGroupMembership operation returned by the service.

See Also:

AWS API Documentation

createGroupMembershipAsync

Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest createGroupMembershipRequest,
                                                               AsyncHandler<CreateGroupMembershipRequest,CreateGroupMembershipResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the CreateGroupMembership operation returned by the service.

See Also:

AWS API Documentation

deleteGroupAsync

Future<DeleteGroupResult> deleteGroupAsync(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:

A Java Future containing the result of the DeleteGroup operation returned by the service.

See Also:

AWS API Documentation

deleteGroupAsync

Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest,
                                           AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the DeleteGroup operation returned by the service.

See Also:

AWS API Documentation

deleteGroupMembershipAsync

Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(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:

A Java Future containing the result of the DeleteGroupMembership operation returned by the service.

See Also:

AWS API Documentation

deleteGroupMembershipAsync

Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest deleteGroupMembershipRequest,
                                                               AsyncHandler<DeleteGroupMembershipRequest,DeleteGroupMembershipResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the DeleteGroupMembership operation returned by the service.

See Also:

AWS API Documentation

deleteUserAsync

Future<DeleteUserResult> deleteUserAsync(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:

A Java Future containing the result of the DeleteUser operation returned by the service.

See Also:

AWS API Documentation

deleteUserAsync

Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest,
                                         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. 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 -

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.

Returns:

A Java Future containing the result of the DeleteUser operation returned by the service.

See Also:

AWS API Documentation

deleteUserByPrincipalIdAsync

Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)

Deletes a user after locating the user by its principal ID.

Parameters:

deleteUserByPrincipalIdRequest -

Returns:

A Java Future containing the result of the DeleteUserByPrincipalId operation returned by the service.

See Also:

AWS API Documentation

deleteUserByPrincipalIdAsync

Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest,
                                                                   AsyncHandler<DeleteUserByPrincipalIdRequest,DeleteUserByPrincipalIdResult> asyncHandler)

Deletes a user after locating the user by its principal ID.

Parameters:

deleteUserByPrincipalIdRequest -

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.

Returns:

A Java Future containing the result of the DeleteUserByPrincipalId operation returned by the service.

See Also:

AWS API Documentation

describeGroupAsync

Future<DescribeGroupResult> describeGroupAsync(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:

A Java Future containing the result of the DescribeGroup operation returned by the service.

See Also:

AWS API Documentation

describeGroupAsync

Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest describeGroupRequest,
                                               AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the DescribeGroup operation returned by the service.

See Also:

AWS API Documentation

describeUserAsync

Future<DescribeUserResult> describeUserAsync(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:

A Java Future containing the result of the DescribeUser operation returned by the service.

See Also:

AWS API Documentation

describeUserAsync

Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest,
                                             AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the DescribeUser operation returned by the service.

See Also:

AWS API Documentation

getDashboardEmbedUrlAsync

Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(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:

A Java Future containing the result of the GetDashboardEmbedUrl operation returned by the service.

See Also:

AWS API Documentation

getDashboardEmbedUrlAsync

Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest,
                                                             AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the GetDashboardEmbedUrl operation returned by the service.

See Also:

AWS API Documentation

listGroupMembershipsAsync

Future<ListGroupMembershipsResult> listGroupMembershipsAsync(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:

A Java Future containing the result of the ListGroupMemberships operation returned by the service.

See Also:

AWS API Documentation

listGroupMembershipsAsync

Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest listGroupMembershipsRequest,
                                                             AsyncHandler<ListGroupMembershipsRequest,ListGroupMembershipsResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the ListGroupMemberships operation returned by the service.

See Also:

AWS API Documentation

listGroupsAsync

Future<ListGroupsResult> listGroupsAsync(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:

A Java Future containing the result of the ListGroups operation returned by the service.

See Also:

AWS API Documentation

listGroupsAsync

Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest,
                                         AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the ListGroups operation returned by the service.

See Also:

AWS API Documentation

listUserGroupsAsync

Future<ListUserGroupsResult> listUserGroupsAsync(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:

A Java Future containing the result of the ListUserGroups operation returned by the service.

See Also:

AWS API Documentation

listUserGroupsAsync

Future<ListUserGroupsResult> listUserGroupsAsync(ListUserGroupsRequest listUserGroupsRequest,
                                                 AsyncHandler<ListUserGroupsRequest,ListUserGroupsResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the ListUserGroups operation returned by the service.

See Also:

AWS API Documentation

listUsersAsync

Future<ListUsersResult> listUsersAsync(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:

A Java Future containing the result of the ListUsers operation returned by the service.

See Also:

AWS API Documentation

listUsersAsync

Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest,
                                       AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.

See Also:

AWS API Documentation

registerUserAsync

Future<RegisterUserResult> registerUserAsync(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:

A Java Future containing the result of the RegisterUser operation returned by the service.

See Also:

AWS API Documentation

registerUserAsync

Future<RegisterUserResult> registerUserAsync(RegisterUserRequest registerUserRequest,
                                             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.

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 -

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.

Returns:

A Java Future containing the result of the RegisterUser operation returned by the service.

See Also:

AWS API Documentation

updateGroupAsync

Future<UpdateGroupResult> updateGroupAsync(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:

A Java Future containing the result of the UpdateGroup operation returned by the service.

See Also:

AWS API Documentation

updateGroupAsync

Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest,
                                           AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the UpdateGroup operation returned by the service.

See Also:

AWS API Documentation

updateUserAsync

Future<UpdateUserResult> updateUserAsync(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:

A Java Future containing the result of the UpdateUser operation returned by the service.

See Also:

AWS API Documentation

updateUserAsync

Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest,
                                         AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)

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 -

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.

Returns:

A Java Future containing the result of the UpdateUser operation returned by the service.

See Also:

AWS API Documentation