software.amazon.awssdk.services.quicksight

Interface QuickSightClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

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

Amazon QuickSight is a fast, cloud-powered BI service that makes it easy to build visualizations, perform ad hoc analysis, and quickly get business insights from your data. 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 QuickSightClientBuilder	builder() Create a builder that can be used to configure and create a QuickSightClient.
static QuickSightClient	create() Create a QuickSightClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateGroupResponse	createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) Creates an Amazon QuickSight group.
default CreateGroupResponse	createGroup(CreateGroupRequest createGroupRequest) Creates an Amazon QuickSight group.
default CreateGroupMembershipResponse	createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest) Adds an Amazon QuickSight user to an Amazon QuickSight group.
default CreateGroupMembershipResponse	createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest) Adds an Amazon QuickSight user to an Amazon QuickSight group.
default DeleteGroupResponse	deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Removes a user group from Amazon QuickSight.
default DeleteGroupResponse	deleteGroup(DeleteGroupRequest deleteGroupRequest) Removes a user group from Amazon QuickSight.
default 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 DeleteGroupMembershipResponse	deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest) Removes a user from a group so that the user is no longer a member of the group.
default 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 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 DescribeGroupResponse	describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
default DescribeGroupResponse	describeGroup(DescribeGroupRequest describeGroupRequest) Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
default DescribeUserResponse	describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Returns information about a user, given the user name.
default DescribeUserResponse	describeUser(DescribeUserRequest describeUserRequest) Returns information about a user, given the user name.
default GetDashboardEmbedUrlResponse	getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest) Generates an embedded URL and authorization code.
default GetDashboardEmbedUrlResponse	getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest) Generates an embedded URL and authorization code.
default ListGroupMembershipsResponse	listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) Lists member users in a group.
default ListGroupMembershipsResponse	listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest) Lists member users in a group.
default ListGroupsResponse	listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Lists all user groups in Amazon QuickSight.
default ListGroupsResponse	listGroups(ListGroupsRequest listGroupsRequest) Lists all user groups in Amazon QuickSight.
default ListUserGroupsResponse	listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) Lists the Amazon QuickSight groups that a user is part of.
default ListUserGroupsResponse	listUserGroups(ListUserGroupsRequest listUserGroupsRequest) Lists the Amazon QuickSight groups that a user is part of.
default ListUsersResponse	listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns a list of all of the Amazon QuickSight users belonging to this account.
default ListUsersResponse	listUsers(ListUsersRequest listUsersRequest) Returns a list of all of the Amazon QuickSight users belonging to this account.
default 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 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.
static ServiceMetadata	serviceMetadata()
default UpdateGroupResponse	updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Changes a group description.
default UpdateGroupResponse	updateGroup(UpdateGroupRequest updateGroupRequest) Changes a group description.
default UpdateUserResponse	updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates an Amazon QuickSight user.
default 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 QuickSightClient create()

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

builder

static QuickSightClientBuilder builder()

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

createGroup

default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest)
                                 throws AccessDeniedException,
                                        InvalidParameterValueException,
                                        ResourceExistsException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        PreconditionNotMetException,
                                        LimitExceededException,
                                        InternalFailureException,
                                        ResourceUnavailableException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QuickSightException

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.

Parameters:

createGroupRequest - The request object for this operation.

Returns:

Result of the CreateGroup operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceExistsException - The resource specified doesn't exist.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

createGroup

default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
                                 throws AccessDeniedException,
                                        InvalidParameterValueException,
                                        ResourceExistsException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        PreconditionNotMetException,
                                        LimitExceededException,
                                        InternalFailureException,
                                        ResourceUnavailableException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QuickSightException

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.

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:

Result of the CreateGroup operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceExistsException - The resource specified doesn't exist.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

createGroupMembership

default CreateGroupMembershipResponse createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
                                                     throws AccessDeniedException,
                                                            InvalidParameterValueException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            PreconditionNotMetException,
                                                            InternalFailureException,
                                                            ResourceUnavailableException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            QuickSightException

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.

Parameters:

createGroupMembershipRequest -

Returns:

Result of the CreateGroupMembership operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

createGroupMembership

default CreateGroupMembershipResponse createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)
                                                     throws AccessDeniedException,
                                                            InvalidParameterValueException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            PreconditionNotMetException,
                                                            InternalFailureException,
                                                            ResourceUnavailableException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            QuickSightException

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.

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:

Result of the CreateGroupMembership operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

deleteGroup

default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest)
                                 throws AccessDeniedException,
                                        InvalidParameterValueException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        PreconditionNotMetException,
                                        InternalFailureException,
                                        ResourceUnavailableException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QuickSightException

Removes a user group from Amazon QuickSight.

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

Parameters:

deleteGroupRequest -

Returns:

Result of the DeleteGroup operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

deleteGroup

default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
                                 throws AccessDeniedException,
                                        InvalidParameterValueException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        PreconditionNotMetException,
                                        InternalFailureException,
                                        ResourceUnavailableException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QuickSightException

Removes a user group from Amazon QuickSight.

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

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:

Result of the DeleteGroup operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

deleteGroupMembership

default DeleteGroupMembershipResponse deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
                                                     throws AccessDeniedException,
                                                            InvalidParameterValueException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            PreconditionNotMetException,
                                                            InternalFailureException,
                                                            ResourceUnavailableException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            QuickSightException

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.

Parameters:

deleteGroupMembershipRequest -

Returns:

Result of the DeleteGroupMembership operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

deleteGroupMembership

default DeleteGroupMembershipResponse deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)
                                                     throws AccessDeniedException,
                                                            InvalidParameterValueException,
                                                            ResourceNotFoundException,
                                                            ThrottlingException,
                                                            PreconditionNotMetException,
                                                            InternalFailureException,
                                                            ResourceUnavailableException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            QuickSightException

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.

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:

Result of the DeleteGroupMembership operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest)
                               throws AccessDeniedException,
                                      InvalidParameterValueException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalFailureException,
                                      ResourceUnavailableException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QuickSightException

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

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
                               throws AccessDeniedException,
                                      InvalidParameterValueException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalFailureException,
                                      ResourceUnavailableException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QuickSightException

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

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:

Result of the DeleteUser operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

describeGroup

default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest)
                                     throws AccessDeniedException,
                                            InvalidParameterValueException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            PreconditionNotMetException,
                                            InternalFailureException,
                                            ResourceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            QuickSightException

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.

Parameters:

describeGroupRequest -

Returns:

Result of the DescribeGroup operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

describeGroup

default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
                                     throws AccessDeniedException,
                                            InvalidParameterValueException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            PreconditionNotMetException,
                                            InternalFailureException,
                                            ResourceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            QuickSightException

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.

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:

Result of the DescribeGroup operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

describeUser

default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest)
                                   throws AccessDeniedException,
                                          InvalidParameterValueException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalFailureException,
                                          ResourceUnavailableException,
                                          AwsServiceException,
                                          SdkClientException,
                                          QuickSightException

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.

Parameters:

describeUserRequest -

Returns:

Result of the DescribeUser operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

describeUser

default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
                                   throws AccessDeniedException,
                                          InvalidParameterValueException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InternalFailureException,
                                          ResourceUnavailableException,
                                          AwsServiceException,
                                          SdkClientException,
                                          QuickSightException

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.

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:

Result of the DescribeUser operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

getDashboardEmbedUrl

default GetDashboardEmbedUrlResponse getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
                                                   throws AccessDeniedException,
                                                          InvalidParameterValueException,
                                                          ResourceExistsException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          PreconditionNotMetException,
                                                          DomainNotWhitelistedException,
                                                          QuickSightUserNotFoundException,
                                                          IdentityTypeNotSupportedException,
                                                          SessionLifetimeInMinutesInvalidException,
                                                          UnsupportedUserEditionException,
                                                          InternalFailureException,
                                                          ResourceUnavailableException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          QuickSightException

Generates an embedded URL and authorization code. Before this can work properly, you need to configure the dashboards and user permissions first.

Parameters:

getDashboardEmbedUrlRequest -

Returns:

Result of the GetDashboardEmbedUrl operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceExistsException - The resource specified doesn't exist.

ResourceNotFoundException - One or more resources couldn'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 could happen in any operation that requires finding a user based on the 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 invalid. The session lifetime must be between 15 and 600 minutes.

UnsupportedUserEditionException - Indicates that you are calling an operation on an Amazon QuickSight subscription where the edition does not 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.

AwsServiceException

See Also:

AWS API Documentation

getDashboardEmbedUrl

default GetDashboardEmbedUrlResponse getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest)
                                                   throws AccessDeniedException,
                                                          InvalidParameterValueException,
                                                          ResourceExistsException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          PreconditionNotMetException,
                                                          DomainNotWhitelistedException,
                                                          QuickSightUserNotFoundException,
                                                          IdentityTypeNotSupportedException,
                                                          SessionLifetimeInMinutesInvalidException,
                                                          UnsupportedUserEditionException,
                                                          InternalFailureException,
                                                          ResourceUnavailableException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          QuickSightException

Generates an embedded URL and authorization code. Before this can work properly, you need to configure the dashboards and user permissions first.

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:

Result of the GetDashboardEmbedUrl operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceExistsException - The resource specified doesn't exist.

ResourceNotFoundException - One or more resources couldn'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 could happen in any operation that requires finding a user based on the 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 invalid. The session lifetime must be between 15 and 600 minutes.

UnsupportedUserEditionException - Indicates that you are calling an operation on an Amazon QuickSight subscription where the edition does not 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.

AwsServiceException

See Also:

AWS API Documentation

listGroupMemberships

default ListGroupMembershipsResponse listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
                                                   throws AccessDeniedException,
                                                          InvalidParameterValueException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InvalidNextTokenException,
                                                          PreconditionNotMetException,
                                                          InternalFailureException,
                                                          ResourceUnavailableException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          QuickSightException

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.

Parameters:

listGroupMembershipsRequest -

Returns:

Result of the ListGroupMemberships operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

listGroupMemberships

default ListGroupMembershipsResponse listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
                                                   throws AccessDeniedException,
                                                          InvalidParameterValueException,
                                                          ResourceNotFoundException,
                                                          ThrottlingException,
                                                          InvalidNextTokenException,
                                                          PreconditionNotMetException,
                                                          InternalFailureException,
                                                          ResourceUnavailableException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          QuickSightException

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.

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:

Result of the ListGroupMemberships operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

listGroups

default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest)
                               throws AccessDeniedException,
                                      InvalidParameterValueException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InvalidNextTokenException,
                                      PreconditionNotMetException,
                                      InternalFailureException,
                                      ResourceUnavailableException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QuickSightException

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.

Parameters:

listGroupsRequest -

Returns:

Result of the ListGroups operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

listGroups

default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
                               throws AccessDeniedException,
                                      InvalidParameterValueException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InvalidNextTokenException,
                                      PreconditionNotMetException,
                                      InternalFailureException,
                                      ResourceUnavailableException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QuickSightException

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.

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:

Result of the ListGroups operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

listUserGroups

default ListUserGroupsResponse listUserGroups(ListUserGroupsRequest listUserGroupsRequest)
                                       throws AccessDeniedException,
                                              InvalidParameterValueException,
                                              ResourceNotFoundException,
                                              ThrottlingException,
                                              InternalFailureException,
                                              ResourceUnavailableException,
                                              AwsServiceException,
                                              SdkClientException,
                                              QuickSightException

Lists the Amazon QuickSight groups that a user is part of.

Parameters:

listUserGroupsRequest -

Returns:

Result of the ListUserGroups operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

listUserGroups

default ListUserGroupsResponse listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)
                                       throws AccessDeniedException,
                                              InvalidParameterValueException,
                                              ResourceNotFoundException,
                                              ThrottlingException,
                                              InternalFailureException,
                                              ResourceUnavailableException,
                                              AwsServiceException,
                                              SdkClientException,
                                              QuickSightException

Lists the Amazon QuickSight groups that a user is part of.

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:

Result of the ListUserGroups operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

listUsers

default ListUsersResponse listUsers(ListUsersRequest listUsersRequest)
                             throws AccessDeniedException,
                                    InvalidParameterValueException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InvalidNextTokenException,
                                    InternalFailureException,
                                    ResourceUnavailableException,
                                    AwsServiceException,
                                    SdkClientException,
                                    QuickSightException

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.

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

listUsers

default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
                             throws AccessDeniedException,
                                    InvalidParameterValueException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InvalidNextTokenException,
                                    InternalFailureException,
                                    ResourceUnavailableException,
                                    AwsServiceException,
                                    SdkClientException,
                                    QuickSightException

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.

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:

Result of the ListUsers operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

registerUser

default RegisterUserResponse registerUser(RegisterUserRequest registerUserRequest)
                                   throws AccessDeniedException,
                                          InvalidParameterValueException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          LimitExceededException,
                                          ResourceExistsException,
                                          PreconditionNotMetException,
                                          InternalFailureException,
                                          ResourceUnavailableException,
                                          AwsServiceException,
                                          SdkClientException,
                                          QuickSightException

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.

Parameters:

registerUserRequest -

Returns:

Result of the RegisterUser operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

registerUser

default RegisterUserResponse registerUser(Consumer<RegisterUserRequest.Builder> registerUserRequest)
                                   throws AccessDeniedException,
                                          InvalidParameterValueException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          LimitExceededException,
                                          ResourceExistsException,
                                          PreconditionNotMetException,
                                          InternalFailureException,
                                          ResourceUnavailableException,
                                          AwsServiceException,
                                          SdkClientException,
                                          QuickSightException

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.

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:

Result of the RegisterUser operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

updateGroup

default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest)
                                 throws AccessDeniedException,
                                        InvalidParameterValueException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        PreconditionNotMetException,
                                        InternalFailureException,
                                        ResourceUnavailableException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QuickSightException

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.

Parameters:

updateGroupRequest -

Returns:

Result of the UpdateGroup operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

updateGroup

default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
                                 throws AccessDeniedException,
                                        InvalidParameterValueException,
                                        ResourceNotFoundException,
                                        ThrottlingException,
                                        PreconditionNotMetException,
                                        InternalFailureException,
                                        ResourceUnavailableException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QuickSightException

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.

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:

Result of the UpdateGroup operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

updateUser

default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest)
                               throws AccessDeniedException,
                                      InvalidParameterValueException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalFailureException,
                                      ResourceUnavailableException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QuickSightException

Updates an Amazon QuickSight user.

Parameters:

updateUserRequest -

Returns:

Result of the UpdateUser operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

updateUser

default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
                               throws AccessDeniedException,
                                      InvalidParameterValueException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalFailureException,
                                      ResourceUnavailableException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QuickSightException

Updates an Amazon QuickSight user.

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:

Result of the UpdateUser operation returned by the service.

Throws:

AccessDeniedException - You don't have access to this.

InvalidParameterValueException - One or more parameters don't have a valid value.

ResourceNotFoundException - One or more resources couldn'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.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()