com.amazonaws.services.quicksight

Class AbstractAmazonQuickSightAsync

java.lang.Object

com.amazonaws.services.quicksight.AbstractAmazonQuickSight

com.amazonaws.services.quicksight.AbstractAmazonQuickSightAsync

All Implemented Interfaces:

AmazonQuickSight, AmazonQuickSightAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonQuickSightAsync
extends AbstractAmazonQuickSight
implements AmazonQuickSightAsync

Abstract implementation of AmazonQuickSightAsync. Convenient method forms pass through to the corresponding overload that takes a request object and an AsyncHandler, which throws an UnsupportedOperationException.

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 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.
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.
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.

Methods inherited from class com.amazonaws.services.quicksight.AbstractAmazonQuickSight

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request)

Description copied from interface: AmazonQuickSightAsync

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"

Specified by:

createGroupAsync in interface AmazonQuickSightAsync

Parameters:

request - 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

public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request,
                                                  AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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"

Specified by:

createGroupAsync in interface AmazonQuickSightAsync

Parameters:

request - 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

public Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

createGroupMembershipAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

createGroupMembershipAsync

public Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest request,
                                                                      AsyncHandler<CreateGroupMembershipRequest,CreateGroupMembershipResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

createGroupMembershipAsync in interface AmazonQuickSightAsync

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

public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

deleteGroupAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

deleteGroupAsync

public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request,
                                                  AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

deleteGroupAsync in interface AmazonQuickSightAsync

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

public Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

deleteGroupMembershipAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

deleteGroupMembershipAsync

public Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest request,
                                                                      AsyncHandler<DeleteGroupMembershipRequest,DeleteGroupMembershipResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

deleteGroupMembershipAsync in interface AmazonQuickSightAsync

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

public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

deleteUserAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

deleteUserAsync

public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request,
                                                AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

deleteUserAsync in interface AmazonQuickSightAsync

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

public Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

deleteUserByPrincipalIdAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

deleteUserByPrincipalIdAsync

public Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request,
                                                                          AsyncHandler<DeleteUserByPrincipalIdRequest,DeleteUserByPrincipalIdResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

deleteUserByPrincipalIdAsync in interface AmazonQuickSightAsync

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

public Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

describeGroupAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

describeGroupAsync

public Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request,
                                                      AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

describeGroupAsync in interface AmazonQuickSightAsync

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

public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

describeUserAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

describeUserAsync

public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request,
                                                    AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

describeUserAsync in interface AmazonQuickSightAsync

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

public Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

getDashboardEmbedUrlAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

getDashboardEmbedUrlAsync

public Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request,
                                                                    AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

getDashboardEmbedUrlAsync in interface AmazonQuickSightAsync

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

public Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

listGroupMembershipsAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

listGroupMembershipsAsync

public Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest request,
                                                                    AsyncHandler<ListGroupMembershipsRequest,ListGroupMembershipsResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

listGroupMembershipsAsync in interface AmazonQuickSightAsync

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

public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

listGroupsAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

listGroupsAsync

public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request,
                                                AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

listGroupsAsync in interface AmazonQuickSightAsync

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

public Future<ListUserGroupsResult> listUserGroupsAsync(ListUserGroupsRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

listUserGroupsAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

listUserGroupsAsync

public Future<ListUserGroupsResult> listUserGroupsAsync(ListUserGroupsRequest request,
                                                        AsyncHandler<ListUserGroupsRequest,ListUserGroupsResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

listUserGroupsAsync in interface AmazonQuickSightAsync

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

public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

listUsersAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

listUsersAsync

public Future<ListUsersResult> listUsersAsync(ListUsersRequest request,
                                              AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

listUsersAsync in interface AmazonQuickSightAsync

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

public Future<RegisterUserResult> registerUserAsync(RegisterUserRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

registerUserAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

registerUserAsync

public Future<RegisterUserResult> registerUserAsync(RegisterUserRequest request,
                                                    AsyncHandler<RegisterUserRequest,RegisterUserResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

registerUserAsync in interface AmazonQuickSightAsync

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

public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request)

Description copied from interface: AmazonQuickSightAsync

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"

Specified by:

updateGroupAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

updateGroupAsync

public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request,
                                                  AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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"

Specified by:

updateGroupAsync in interface AmazonQuickSightAsync

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

public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

updateUserAsync in interface AmazonQuickSightAsync

Returns:

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

See Also:

AWS API Documentation

updateUserAsync

public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request,
                                                AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)

Description copied from interface: AmazonQuickSightAsync

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

Specified by:

updateUserAsync in interface AmazonQuickSightAsync

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