@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonQuickSightClient extends AmazonWebServiceClient implements AmazonQuickSight
Amazon QuickSight is a fully managed, serverless, cloud business intelligence service that makes it easy to extend data and insights to every user in your organization. This API interface reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AmazonQuickSightClientBuilder |
builder() |
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates an Amazon QuickSight group.
|
CreateGroupMembershipResult |
createGroupMembership(CreateGroupMembershipRequest request)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Removes a user group from Amazon QuickSight.
|
DeleteGroupMembershipResult |
deleteGroupMembership(DeleteGroupMembershipRequest request)
Removes a user from a group so that the user is no longer a member of the group.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management
(IAM) user or role that's making the call.
|
DeleteUserByPrincipalIdResult |
deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
Deletes a user after locating the user by its principal ID.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest request)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Returns information about a user, given the user name.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDashboardEmbedUrlResult |
getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
Generates a server-side embeddable URL and authorization code.
|
ListGroupMembershipsResult |
listGroupMemberships(ListGroupMembershipsRequest request)
Lists member users in a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Lists all user groups in Amazon QuickSight.
|
ListUserGroupsResult |
listUserGroups(ListUserGroupsRequest request)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Returns a list of all of the Amazon QuickSight users belonging to this account.
|
RegisterUserResult |
registerUser(RegisterUserRequest request)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM)
identity or role specified in the request.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest request)
Changes a group description.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Updates an Amazon QuickSight user.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AmazonQuickSightClientBuilder builder()
public CreateGroupResult createGroup(CreateGroupRequest request)
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"
createGroup in interface AmazonQuickSightcreateGroupRequest - The request object for this operation.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.public CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest request)
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
createGroupMembership in interface AmazonQuickSightcreateGroupMembershipRequest - 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.public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
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
deleteGroup in interface AmazonQuickSightdeleteGroupRequest - 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.public DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest request)
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
deleteGroupMembership in interface AmazonQuickSightdeleteGroupMembershipRequest - 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.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. 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
deleteUser in interface AmazonQuickSightdeleteUserRequest - 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.public DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
Deletes a user after locating the user by its principal ID.
deleteUserByPrincipalId in interface AmazonQuickSightdeleteUserByPrincipalIdRequest - 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.public DescribeGroupResult describeGroup(DescribeGroupRequest request)
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
describeGroup in interface AmazonQuickSightdescribeGroupRequest - 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.public DescribeUserResult describeUser(DescribeUserRequest request)
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
describeUser in interface AmazonQuickSightdescribeUserRequest - 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.public GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
CLI Sample:
Assume the role with permissions enabled for actions: quickSight:RegisterUser and
quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or
assume-role-with-saml.
aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession
If the user does not exist in QuickSight, register the user:
aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email [email protected] --region us-east-1
Get the URL for the embedded dashboard
aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM
getDashboardEmbedUrl in interface AmazonQuickSightgetDashboardEmbedUrlRequest - 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.public ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest request)
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
listGroupMemberships in interface AmazonQuickSightlistGroupMembershipsRequest - 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.public ListGroupsResult listGroups(ListGroupsRequest request)
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
listGroups in interface AmazonQuickSightlistGroupsRequest - 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.public ListUserGroupsResult listUserGroups(ListUserGroupsRequest request)
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
listUserGroups in interface AmazonQuickSightlistUserGroupsRequest - 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.public ListUsersResult listUsers(ListUsersRequest request)
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
listUsers in interface AmazonQuickSightlistUsersRequest - 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.public RegisterUserResult registerUser(RegisterUserRequest request)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
The permission resource is
arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.
The condition keys are quicksight:IamArn and quicksight:SessionName.
CLI Sample:
aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\[email protected] -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat
registerUser in interface AmazonQuickSightregisterUserRequest - 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.public UpdateGroupResult updateGroup(UpdateGroupRequest request)
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"
updateGroup in interface AmazonQuickSightupdateGroupRequest - 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.public UpdateUserResult updateUser(UpdateUserRequest request)
Updates an Amazon QuickSight user.
The permission resource is
arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).
CLI Sample:
aws quicksight update-user --user-name=Pat --role=ADMIN [email protected] --aws-account-id=111122223333 --namespace=default --region=us-east-1
updateUser in interface AmazonQuickSightupdateUserRequest - 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonQuickSightrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.