software.amazon.awssdk.services.quicksight

Interface QuickSightAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface QuickSightAsyncClient
extends SdkClient

Service client for accessing Amazon QuickSight asynchronously. This can be created using the static builder() method. Amazon QuickSight API Reference

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static QuickSightAsyncClientBuilder	builder() Create a builder that can be used to configure and create a QuickSightAsyncClient.
static QuickSightAsyncClient	create() Create a QuickSightAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateGroupResponse>	createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) Creates an Amazon QuickSight group.
default CompletableFuture<CreateGroupResponse>	createGroup(CreateGroupRequest createGroupRequest) Creates an Amazon QuickSight group.
default CompletableFuture<CreateGroupMembershipResponse>	createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest) Adds an Amazon QuickSight user to an Amazon QuickSight group.
default CompletableFuture<CreateGroupMembershipResponse>	createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest) Adds an Amazon QuickSight user to an Amazon QuickSight group.
default CompletableFuture<DeleteGroupResponse>	deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Removes a user group from Amazon QuickSight.
default CompletableFuture<DeleteGroupResponse>	deleteGroup(DeleteGroupRequest deleteGroupRequest) Removes a user group from Amazon QuickSight.
default CompletableFuture<DeleteGroupMembershipResponse>	deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest) Removes a user from a group so that the user is no longer a member of the group.
default CompletableFuture<DeleteGroupMembershipResponse>	deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest) Removes a user from a group so that the user is no longer a member of the group.
default CompletableFuture<DeleteUserResponse>	deleteUser(Consumer<DeleteUserRequest.Builder> 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.
default CompletableFuture<DeleteUserResponse>	deleteUser(DeleteUserRequest deleteUserRequest) Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call.
default CompletableFuture<DescribeGroupResponse>	describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
default CompletableFuture<DescribeGroupResponse>	describeGroup(DescribeGroupRequest describeGroupRequest) Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
default CompletableFuture<DescribeUserResponse>	describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Returns information about a user, given the user name.
default CompletableFuture<DescribeUserResponse>	describeUser(DescribeUserRequest describeUserRequest) Returns information about a user, given the user name.
default CompletableFuture<GetDashboardEmbedUrlResponse>	getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest) Generates a server-side embeddable URL and authorization code.
default CompletableFuture<GetDashboardEmbedUrlResponse>	getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest) Generates a server-side embeddable URL and authorization code.
default CompletableFuture<ListGroupMembershipsResponse>	listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) Lists member users in a group.
default CompletableFuture<ListGroupMembershipsResponse>	listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest) Lists member users in a group.
default CompletableFuture<ListGroupsResponse>	listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Lists all user groups in Amazon QuickSight.
default CompletableFuture<ListGroupsResponse>	listGroups(ListGroupsRequest listGroupsRequest) Lists all user groups in Amazon QuickSight.
default CompletableFuture<ListUserGroupsResponse>	listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
default CompletableFuture<ListUserGroupsResponse>	listUserGroups(ListUserGroupsRequest listUserGroupsRequest) Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
default CompletableFuture<ListUsersResponse>	listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns a list of all of the Amazon QuickSight users belonging to this account.
default CompletableFuture<ListUsersResponse>	listUsers(ListUsersRequest listUsersRequest) Returns a list of all of the Amazon QuickSight users belonging to this account.
default CompletableFuture<RegisterUserResponse>	registerUser(Consumer<RegisterUserRequest.Builder> 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.
default CompletableFuture<RegisterUserResponse>	registerUser(RegisterUserRequest registerUserRequest) Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
default CompletableFuture<UpdateGroupResponse>	updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Changes a group description.
default CompletableFuture<UpdateGroupResponse>	updateGroup(UpdateGroupRequest updateGroupRequest) Changes a group description.
default CompletableFuture<UpdateUserResponse>	updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates an Amazon QuickSight user.
default CompletableFuture<UpdateUserResponse>	updateUser(UpdateUserRequest updateUserRequest) Updates an Amazon QuickSight user.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static QuickSightAsyncClient create()

Create a QuickSightAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static QuickSightAsyncClientBuilder builder()

Create a builder that can be used to configure and create a QuickSightAsyncClient.

createGroup

default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)

Creates an Amazon QuickSight group.

The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .

The response is a group object.

CLI Sample:

aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"

Parameters:

createGroupRequest - The request object for this operation.

Returns:

A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceExistsException The resource specified doesn't exist.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• LimitExceededException A limit is exceeded.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createGroup

default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> 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"

This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to create one manually via CreateGroupRequest.builder()

Parameters:

createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request. The request object for this operation.

Returns:

A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceExistsException The resource specified doesn't exist.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• LimitExceededException A limit is exceeded.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createGroupMembership

default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)

Adds an Amazon QuickSight user to an Amazon QuickSight group.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The condition resource is the user name.

The condition key is quicksight:UserName.

The response is the group member object.

CLI Sample:

aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat

Parameters:

createGroupMembershipRequest -

Returns:

A Java Future containing the result of the CreateGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createGroupMembership

default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> 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

This is a convenience which creates an instance of the CreateGroupMembershipRequest.Builder avoiding the need to create one manually via CreateGroupMembershipRequest.builder()

Parameters:

createGroupMembershipRequest - A Consumer that will call methods on CreateGroupMembershipRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteGroup

default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)

Removes a user group from Amazon QuickSight.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

CLI Sample:

aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management

Parameters:

deleteGroupRequest -

Returns:

A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteGroup

default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> 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

This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to create one manually via DeleteGroupRequest.builder()

Parameters:

deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteGroupMembership

default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)

Removes a user from a group so that the user is no longer a member of the group.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The condition resource is the user name.

The condition key is quicksight:UserName.

CLI Sample:

aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie

Parameters:

deleteGroupMembershipRequest -

Returns:

A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteGroupMembership

default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> 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

This is a convenience which creates an instance of the DeleteGroupMembershipRequest.Builder avoiding the need to create one manually via DeleteGroupMembershipRequest.builder()

Parameters:

deleteGroupMembershipRequest - A Consumer that will call methods on DeleteGroupMembershipRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteUser

default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)

Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

CLI Sample:

aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

Parameters:

deleteUserRequest -

Returns:

A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteUser

default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> 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

This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to create one manually via DeleteUserRequest.builder()

Parameters:

deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeGroup

default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest)

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .

The response is the group object.

CLI Sample:

aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales

Parameters:

describeGroupRequest -

Returns:

A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeGroup

default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> 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

This is a convenience which creates an instance of the DescribeGroupRequest.Builder avoiding the need to create one manually via DescribeGroupRequest.builder()

Parameters:

describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeUser

default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)

Returns information about a user, given the user name.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

Parameters:

describeUserRequest -

Returns:

A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeUser

default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> 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

This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to create one manually via DescribeUserRequest.builder()

Parameters:

describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getDashboardEmbedUrl

default CompletableFuture<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)

Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.

CLI Sample:

Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml.

aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession

If the user does not exist in QuickSight, register the user:

aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceExistsException The resource specified doesn't exist.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• DomainNotWhitelistedException The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
• QuickSightUserNotFoundException The user is not found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.
• IdentityTypeNotSupportedException The identity type specified is not supported. Supported identity types include IAM and QUICKSIGHT.
• SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session is not valid. The session lifetime must be from 15 to 600 minutes.
• UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getDashboardEmbedUrl

default CompletableFuture<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> 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 user123@example.com --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

This is a convenience which creates an instance of the GetDashboardEmbedUrlRequest.Builder avoiding the need to create one manually via GetDashboardEmbedUrlRequest.builder()

Parameters:

getDashboardEmbedUrlRequest - A Consumer that will call methods on GetDashboardEmbedUrlRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetDashboardEmbedUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceExistsException The resource specified doesn't exist.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• DomainNotWhitelistedException The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
• QuickSightUserNotFoundException The user is not found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.
• IdentityTypeNotSupportedException The identity type specified is not supported. Supported identity types include IAM and QUICKSIGHT.
• SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session is not valid. The session lifetime must be from 15 to 600 minutes.
• UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listGroupMemberships

default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)

Lists member users in a group.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The response is a list of group member objects.

CLI Sample:

aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default

Parameters:

listGroupMembershipsRequest -

Returns:

A Java Future containing the result of the ListGroupMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InvalidNextTokenException The NextToken value isn't valid.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listGroupMemberships

default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> 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

This is a convenience which creates an instance of the ListGroupMembershipsRequest.Builder avoiding the need to create one manually via ListGroupMembershipsRequest.builder()

Parameters:

listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListGroupMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InvalidNextTokenException The NextToken value isn't valid.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listGroups

default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)

Lists all user groups in Amazon QuickSight.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.

The response is a list of group objects.

CLI Sample:

aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default

Parameters:

listGroupsRequest -

Returns:

A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InvalidNextTokenException The NextToken value isn't valid.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listGroups

default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> 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

This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to create one manually via ListGroupsRequest.builder()

Parameters:

listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InvalidNextTokenException The NextToken value isn't valid.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listUserGroups

default CompletableFuture<ListUserGroupsResponse> listUserGroups(ListUserGroupsRequest listUserGroupsRequest)

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a one or more group objects.

CLI Sample:

aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1

Parameters:

listUserGroupsRequest -

Returns:

A Java Future containing the result of the ListUserGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listUserGroups

default CompletableFuture<ListUserGroupsResponse> listUserGroups(Consumer<ListUserGroupsRequest.Builder> 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

This is a convenience which creates an instance of the ListUserGroupsRequest.Builder avoiding the need to create one manually via ListUserGroupsRequest.builder()

Parameters:

listUserGroupsRequest - A Consumer that will call methods on ListUserGroupsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListUserGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listUsers

default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)

Returns a list of all of the Amazon QuickSight users belonging to this account.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* .

The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

aws quicksight list-users --aws-account-id=111122223333 --namespace=default

Parameters:

listUsersRequest -

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InvalidNextTokenException The NextToken value isn't valid.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listUsers

default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> 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

This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InvalidNextTokenException The NextToken value isn't valid.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

registerUser

default CompletableFuture<RegisterUserResponse> registerUser(RegisterUserRequest registerUserRequest)

Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.

The condition keys are quicksight:IamArn and quicksight:SessionName.

CLI Sample:

aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\-email=pat@example.com -\-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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• LimitExceededException A limit is exceeded.
• ResourceExistsException The resource specified doesn't exist.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

registerUser

default CompletableFuture<RegisterUserResponse> registerUser(Consumer<RegisterUserRequest.Builder> 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=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat

This is a convenience which creates an instance of the RegisterUserRequest.Builder avoiding the need to create one manually via RegisterUserRequest.builder()

Parameters:

registerUserRequest - A Consumer that will call methods on RegisterUserRequest.Builder to create a request.

Returns:

A Java Future containing the result of the RegisterUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• LimitExceededException A limit is exceeded.
• ResourceExistsException The resource specified doesn't exist.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateGroup

default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)

Changes a group description.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The response is a group object.

CLI Sample:

aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"

Parameters:

updateGroupRequest -

Returns:

A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateGroup

default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> 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"

This is a convenience which creates an instance of the UpdateGroupRequest.Builder avoiding the need to create one manually via UpdateGroupRequest.builder()

Parameters:

updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• PreconditionNotMetException One or more preconditions aren't met.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateUser

default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)

Updates an Amazon QuickSight user.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).

CLI Sample:

aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateUser

default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> 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=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1

This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to create one manually via UpdateUserRequest.builder()

Parameters:

updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.

Returns:

A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AccessDeniedException You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
• InvalidParameterValueException One or more parameters don't have a valid value.
• ResourceNotFoundException One or more resources can't be found.
• ThrottlingException Access is throttled.
• InternalFailureException An internal failure occurred.
• ResourceUnavailableException This resource is currently unavailable.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation