@Generated(value="software.amazon.awssdk:codegen") public interface QuickSightClient extends SdkClient
builder() method.
Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static QuickSightClientBuilder |
builder()
Create a builder that can be used to configure and create a
QuickSightClient. |
default CancelIngestionResponse |
cancelIngestion(CancelIngestionRequest cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
|
default CancelIngestionResponse |
cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
|
static QuickSightClient |
create()
Create a
QuickSightClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateDashboardResponse |
createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
Creates a dashboard from a template.
|
default CreateDashboardResponse |
createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard from a template.
|
default CreateDataSetResponse |
createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest)
Creates a dataset.
|
default CreateDataSetResponse |
createDataSet(CreateDataSetRequest createDataSetRequest)
Creates a dataset.
|
default CreateDataSourceResponse |
createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
Creates a data source.
|
default CreateDataSourceResponse |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source.
|
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 CreateIamPolicyAssignmentResponse |
createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
|
default CreateIamPolicyAssignmentResponse |
createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
|
default CreateIngestionResponse |
createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest)
Creates and starts a new SPICE ingestion on a dataset
|
default CreateIngestionResponse |
createIngestion(CreateIngestionRequest createIngestionRequest)
Creates and starts a new SPICE ingestion on a dataset
|
default CreateTemplateResponse |
createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)
Creates a template from an existing QuickSight analysis or template.
|
default CreateTemplateResponse |
createTemplate(CreateTemplateRequest createTemplateRequest)
Creates a template from an existing QuickSight analysis or template.
|
default CreateTemplateAliasResponse |
createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest)
Creates a template alias for a template.
|
default CreateTemplateAliasResponse |
createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest)
Creates a template alias for a template.
|
default DeleteDashboardResponse |
deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
Deletes a dashboard.
|
default DeleteDashboardResponse |
deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard.
|
default DeleteDataSetResponse |
deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest)
Deletes a dataset.
|
default DeleteDataSetResponse |
deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)
Deletes a dataset.
|
default DeleteDataSourceResponse |
deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
Deletes the data source permanently.
|
default DeleteDataSourceResponse |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes the data source permanently.
|
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 DeleteIamPolicyAssignmentResponse |
deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
|
default DeleteIamPolicyAssignmentResponse |
deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
|
default DeleteTemplateResponse |
deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)
Deletes a template.
|
default DeleteTemplateResponse |
deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes a template.
|
default DeleteTemplateAliasResponse |
deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest)
Deletes the item that the specified template alias points to.
|
default DeleteTemplateAliasResponse |
deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest)
Deletes the item that the specified template alias points to.
|
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 DeleteUserByPrincipalIdResponse |
deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
|
default DeleteUserByPrincipalIdResponse |
deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
|
default DescribeDashboardResponse |
describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)
Provides a summary for a dashboard.
|
default DescribeDashboardResponse |
describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Provides a summary for a dashboard.
|
default DescribeDashboardPermissionsResponse |
describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
|
default DescribeDashboardPermissionsResponse |
describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
|
default DescribeDataSetResponse |
describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest)
Describes a dataset.
|
default DescribeDataSetResponse |
describeDataSet(DescribeDataSetRequest describeDataSetRequest)
Describes a dataset.
|
default DescribeDataSetPermissionsResponse |
describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
|
default DescribeDataSetPermissionsResponse |
describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
|
default DescribeDataSourceResponse |
describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
Describes a data source.
|
default DescribeDataSourceResponse |
describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Describes a data source.
|
default DescribeDataSourcePermissionsResponse |
describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
|
default DescribeDataSourcePermissionsResponse |
describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
|
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 DescribeIamPolicyAssignmentResponse |
describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
|
default DescribeIamPolicyAssignmentResponse |
describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
|
default DescribeIngestionResponse |
describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest)
Describes a SPICE ingestion.
|
default DescribeIngestionResponse |
describeIngestion(DescribeIngestionRequest describeIngestionRequest)
Describes a SPICE ingestion.
|
default DescribeTemplateResponse |
describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest)
Describes a template's metadata.
|
default DescribeTemplateResponse |
describeTemplate(DescribeTemplateRequest describeTemplateRequest)
Describes a template's metadata.
|
default DescribeTemplateAliasResponse |
describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest)
Describes the template alias for a template.
|
default DescribeTemplateAliasResponse |
describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest)
Describes the template alias for a template.
|
default DescribeTemplatePermissionsResponse |
describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
|
default DescribeTemplatePermissionsResponse |
describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
|
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 a server-side embeddable URL and authorization code.
|
default GetDashboardEmbedUrlResponse |
getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
Generates a server-side embeddable URL and authorization code.
|
default ListDashboardsResponse |
listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Lists dashboards in an AWS account.
|
default ListDashboardsResponse |
listDashboards(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an AWS account.
|
default ListDashboardsIterable |
listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Lists dashboards in an AWS account.
|
default ListDashboardsIterable |
listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an AWS account.
|
default ListDashboardVersionsResponse |
listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
|
default ListDashboardVersionsResponse |
listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
|
default ListDashboardVersionsIterable |
listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
|
default ListDashboardVersionsIterable |
listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
|
default ListDataSetsResponse |
listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
default ListDataSetsResponse |
listDataSets(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
default ListDataSetsIterable |
listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
default ListDataSetsIterable |
listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
default ListDataSourcesResponse |
listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
|
default ListDataSourcesResponse |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
|
default ListDataSourcesIterable |
listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
|
default ListDataSourcesIterable |
listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
|
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 ListIamPolicyAssignmentsResponse |
listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest)
Lists IAM policy assignments in the current Amazon QuickSight account.
|
default ListIamPolicyAssignmentsResponse |
listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest)
Lists IAM policy assignments in the current Amazon QuickSight account.
|
default ListIamPolicyAssignmentsForUserResponse |
listIAMPolicyAssignmentsForUser(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest)
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to
the specified user and group or groups that the user belongs to.
|
default ListIamPolicyAssignmentsForUserResponse |
listIAMPolicyAssignmentsForUser(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest)
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to
the specified user and group or groups that the user belongs to.
|
default ListIngestionsResponse |
listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
|
default ListIngestionsResponse |
listIngestions(ListIngestionsRequest listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
|
default ListIngestionsIterable |
listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
|
default ListIngestionsIterable |
listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags assigned to a resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
|
default ListTemplateAliasesResponse |
listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
Lists all the aliases of a template.
|
default ListTemplateAliasesResponse |
listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest)
Lists all the aliases of a template.
|
default ListTemplateAliasesIterable |
listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
Lists all the aliases of a template.
|
default ListTemplateAliasesIterable |
listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest)
Lists all the aliases of a template.
|
default ListTemplatesResponse |
listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
|
default ListTemplatesResponse |
listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
|
default ListTemplatesIterable |
listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
|
default ListTemplatesIterable |
listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
|
default ListTemplateVersionsResponse |
listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
default ListTemplateVersionsResponse |
listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
default ListTemplateVersionsIterable |
listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
default ListTemplateVersionsIterable |
listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
default ListUserGroupsResponse |
listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
default ListUserGroupsResponse |
listUserGroups(ListUserGroupsRequest listUserGroupsRequest)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member 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.
|
default SearchDashboardsResponse |
searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
Searchs for dashboards that belong to a user.
|
default SearchDashboardsResponse |
searchDashboards(SearchDashboardsRequest searchDashboardsRequest)
Searchs for dashboards that belong to a user.
|
default SearchDashboardsIterable |
searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
Searchs for dashboards that belong to a user.
|
default SearchDashboardsIterable |
searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest)
Searchs for dashboards that belong to a user.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag or tags from a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
|
default UpdateDashboardResponse |
updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
Updates a dashboard in an AWS account.
|
default UpdateDashboardResponse |
updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates a dashboard in an AWS account.
|
default UpdateDashboardPermissionsResponse |
updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
|
default UpdateDashboardPermissionsResponse |
updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
|
default UpdateDashboardPublishedVersionResponse |
updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
|
default UpdateDashboardPublishedVersionResponse |
updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
|
default UpdateDataSetResponse |
updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest)
Updates a dataset.
|
default UpdateDataSetResponse |
updateDataSet(UpdateDataSetRequest updateDataSetRequest)
Updates a dataset.
|
default UpdateDataSetPermissionsResponse |
updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
|
default UpdateDataSetPermissionsResponse |
updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
|
default UpdateDataSourceResponse |
updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
Updates a data source.
|
default UpdateDataSourceResponse |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates a data source.
|
default UpdateDataSourcePermissionsResponse |
updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
|
default UpdateDataSourcePermissionsResponse |
updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
|
default UpdateGroupResponse |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Changes a group description.
|
default UpdateGroupResponse |
updateGroup(UpdateGroupRequest updateGroupRequest)
Changes a group description.
|
default UpdateIamPolicyAssignmentResponse |
updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest)
Updates an existing IAM policy assignment.
|
default UpdateIamPolicyAssignmentResponse |
updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest)
Updates an existing IAM policy assignment.
|
default UpdateTemplateResponse |
updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)
Updates a template from an existing Amazon QuickSight analysis or another template.
|
default UpdateTemplateResponse |
updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Updates a template from an existing Amazon QuickSight analysis or another template.
|
default UpdateTemplateAliasResponse |
updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest)
Updates the template alias of a template.
|
default UpdateTemplateAliasResponse |
updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest)
Updates the template alias of a template.
|
default UpdateTemplatePermissionsResponse |
updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
|
default UpdateTemplatePermissionsResponse |
updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
|
default UpdateUserResponse |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates an Amazon QuickSight user.
|
default UpdateUserResponse |
updateUser(UpdateUserRequest updateUserRequest)
Updates an Amazon QuickSight user.
|
serviceNameclosestatic final String SERVICE_NAME
static QuickSightClient create()
QuickSightClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static QuickSightClientBuilder builder()
QuickSightClient.default CancelIngestionResponse cancelIngestion(CancelIngestionRequest cancelIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Cancels an ongoing ingestion of data into SPICE.
cancelIngestionRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault CancelIngestionResponse cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Cancels an ongoing ingestion of data into SPICE.
This is a convenience which creates an instance of the CancelIngestionRequest.Builder avoiding the need
to create one manually via CancelIngestionRequest.builder()
cancelIngestionRequest - A Consumer that will call methods on CancelIngestionRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault CreateDashboardResponse createDashboard(CreateDashboardRequest createDashboardRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share
QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The
CreateDashboard, DescribeDashboard, and ListDashboardsByUser API
operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a
template that exists in a different AWS account.
createDashboardRequest - ResourceNotFoundException - One or more resources can't be found.InvalidParameterValueException - One or more parameters has a value that isn't valid.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.ConflictException - Updating or deleting a resource can cause an inconsistent state.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.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.AwsServiceExceptiondefault CreateDashboardResponse createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share
QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The
CreateDashboard, DescribeDashboard, and ListDashboardsByUser API
operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a
template that exists in a different AWS account.
This is a convenience which creates an instance of the CreateDashboardRequest.Builder avoiding the need
to create one manually via CreateDashboardRequest.builder()
createDashboardRequest - A Consumer that will call methods on CreateDashboardRequest.Builder to create a request.ResourceNotFoundException - One or more resources can't be found.InvalidParameterValueException - One or more parameters has a value that isn't valid.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.ConflictException - Updating or deleting a resource can cause an inconsistent state.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.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.AwsServiceExceptiondefault CreateDataSetResponse createDataSet(CreateDataSetRequest createDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dataset.
createDataSetRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.LimitExceededException - A limit is exceeded.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.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.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.AwsServiceExceptiondefault CreateDataSetResponse createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dataset.
This is a convenience which creates an instance of the CreateDataSetRequest.Builder avoiding the need to
create one manually via CreateDataSetRequest.builder()
createDataSetRequest - A Consumer that will call methods on CreateDataSetRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.LimitExceededException - A limit is exceeded.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.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.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.AwsServiceExceptiondefault CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a data source.
createDataSourceRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.LimitExceededException - A limit is exceeded.ResourceNotFoundException - One or more resources can't be found.ResourceExistsException - The resource specified already exists.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a data source.
This is a convenience which creates an instance of the CreateDataSourceRequest.Builder avoiding the need
to create one manually via CreateDataSourceRequest.builder()
createDataSourceRequest - A Consumer that will call methods on CreateDataSourceRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.LimitExceededException - A limit is exceeded.ResourceNotFoundException - One or more resources can't be found.ResourceExistsException - The resource specified already exists.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault 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.
createGroupRequest - The request object for this operation.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.LimitExceededException - A limit is exceeded.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request. The
request object for this operation.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.LimitExceededException - A limit is exceeded.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createGroupMembershipRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the CreateGroupMembershipRequest.Builder avoiding the
need to create one manually via CreateGroupMembershipRequest.builder()
createGroupMembershipRequest - A Consumer that will call methods on CreateGroupMembershipRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateIamPolicyAssignmentResponse createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
createIamPolicyAssignmentRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in a state that indicates an action is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault CreateIamPolicyAssignmentResponse createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
This is a convenience which creates an instance of the CreateIamPolicyAssignmentRequest.Builder avoiding
the need to create one manually via CreateIamPolicyAssignmentRequest.builder()
createIamPolicyAssignmentRequest - A Consumer that will call methods on CreateIAMPolicyAssignmentRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in a state that indicates an action is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault CreateIngestionResponse createIngestion(CreateIngestionRequest createIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
createIngestionRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.ResourceExistsException - The resource specified already exists.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault CreateIngestionResponse createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
This is a convenience which creates an instance of the CreateIngestionRequest.Builder avoiding the need
to create one manually via CreateIngestionRequest.builder()
createIngestionRequest - A Consumer that will call methods on CreateIngestionRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.ResourceExistsException - The resource specified already exists.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault CreateTemplateResponse createTemplate(CreateTemplateRequest createTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
createTemplateRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault CreateTemplateResponse createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
This is a convenience which creates an instance of the CreateTemplateRequest.Builder avoiding the need to
create one manually via CreateTemplateRequest.builder()
createTemplateRequest - A Consumer that will call methods on CreateTemplateRequest.Builder to create a request.InvalidParameterValueException - One or more parameters has a value that isn't valid.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault CreateTemplateAliasResponse createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, ResourceExistsException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a template alias for a template.
createTemplateAliasRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceExistsException - The resource specified already exists.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault CreateTemplateAliasResponse createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, ResourceExistsException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a template alias for a template.
This is a convenience which creates an instance of the CreateTemplateAliasRequest.Builder avoiding the
need to create one manually via CreateTemplateAliasRequest.builder()
createTemplateAliasRequest - A Consumer that will call methods on CreateTemplateAliasRequest.Builder to create a
request.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceExistsException - The resource specified already exists.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest deleteDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a dashboard.
deleteDashboardRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault DeleteDashboardResponse deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a dashboard.
This is a convenience which creates an instance of the DeleteDashboardRequest.Builder avoiding the need
to create one manually via DeleteDashboardRequest.builder()
deleteDashboardRequest - A Consumer that will call methods on DeleteDashboardRequest.Builder to create a request.ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault DeleteDataSetResponse deleteDataSet(DeleteDataSetRequest deleteDataSetRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a dataset.
deleteDataSetRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DeleteDataSetResponse deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a dataset.
This is a convenience which creates an instance of the DeleteDataSetRequest.Builder avoiding the need to
create one manually via DeleteDataSetRequest.builder()
deleteDataSetRequest - A Consumer that will call methods on DeleteDataSetRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
deleteDataSourceRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
This is a convenience which creates an instance of the DeleteDataSourceRequest.Builder avoiding the need
to create one manually via DeleteDataSourceRequest.builder()
deleteDataSourceRequest - A Consumer that will call methods on DeleteDataSourceRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a user group from Amazon QuickSight.
deleteGroupRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a user group from Amazon QuickSight.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteGroupMembershipRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the DeleteGroupMembershipRequest.Builder avoiding the
need to create one manually via DeleteGroupMembershipRequest.builder()
deleteGroupMembershipRequest - A Consumer that will call methods on DeleteGroupMembershipRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIamPolicyAssignmentResponse deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an existing IAM policy assignment.
deleteIamPolicyAssignmentRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in a state that indicates an action is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DeleteIamPolicyAssignmentResponse deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an existing IAM policy assignment.
This is a convenience which creates an instance of the DeleteIamPolicyAssignmentRequest.Builder avoiding
the need to create one manually via DeleteIamPolicyAssignmentRequest.builder()
deleteIamPolicyAssignmentRequest - A Consumer that will call methods on DeleteIAMPolicyAssignmentRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in a state that indicates an action is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a template.
deleteTemplateRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault DeleteTemplateResponse deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a template.
This is a convenience which creates an instance of the DeleteTemplateRequest.Builder avoiding the need to
create one manually via DeleteTemplateRequest.builder()
deleteTemplateRequest - A Consumer that will call methods on DeleteTemplateRequest.Builder to create a request.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault DeleteTemplateAliasResponse deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
deleteTemplateAliasRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault DeleteTemplateAliasResponse deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
This is a convenience which creates an instance of the DeleteTemplateAliasRequest.Builder avoiding the
need to create one manually via DeleteTemplateAliasRequest.builder()
deleteTemplateAliasRequest - A Consumer that will call methods on DeleteTemplateAliasRequest.Builder to create a
request.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault 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.
deleteUserRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserByPrincipalIdResponse deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a user identified by its principal ID.
deleteUserByPrincipalIdRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserByPrincipalIdResponse deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a user identified by its principal ID.
This is a convenience which creates an instance of the DeleteUserByPrincipalIdRequest.Builder avoiding
the need to create one manually via DeleteUserByPrincipalIdRequest.builder()
deleteUserByPrincipalIdRequest - A Consumer that will call methods on DeleteUserByPrincipalIdRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDashboardResponse describeDashboard(DescribeDashboardRequest describeDashboardRequest) throws InvalidParameterValueException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary for a dashboard.
describeDashboardRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ThrottlingException - Access is throttled.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.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.AwsServiceExceptiondefault DescribeDashboardResponse describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest) throws InvalidParameterValueException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary for a dashboard.
This is a convenience which creates an instance of the DescribeDashboardRequest.Builder avoiding the need
to create one manually via DescribeDashboardRequest.builder()
describeDashboardRequest - A Consumer that will call methods on DescribeDashboardRequest.Builder to create a request.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ThrottlingException - Access is throttled.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.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.AwsServiceExceptiondefault DescribeDashboardPermissionsResponse describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes read and write permissions for a dashboard.
describeDashboardPermissionsRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.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.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.AwsServiceExceptiondefault DescribeDashboardPermissionsResponse describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes read and write permissions for a dashboard.
This is a convenience which creates an instance of the DescribeDashboardPermissionsRequest.Builder
avoiding the need to create one manually via DescribeDashboardPermissionsRequest.builder()
describeDashboardPermissionsRequest - A Consumer that will call methods on DescribeDashboardPermissionsRequest.Builder to create
a request.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.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.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.AwsServiceExceptiondefault DescribeDataSetResponse describeDataSet(DescribeDataSetRequest describeDataSetRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a dataset.
describeDataSetRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DescribeDataSetResponse describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a dataset.
This is a convenience which creates an instance of the DescribeDataSetRequest.Builder avoiding the need
to create one manually via DescribeDataSetRequest.builder()
describeDataSetRequest - A Consumer that will call methods on DescribeDataSetRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DescribeDataSetPermissionsResponse describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
describeDataSetPermissionsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DescribeDataSetPermissionsResponse describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
This is a convenience which creates an instance of the DescribeDataSetPermissionsRequest.Builder avoiding
the need to create one manually via DescribeDataSetPermissionsRequest.builder()
describeDataSetPermissionsRequest - A Consumer that will call methods on DescribeDataSetPermissionsRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DescribeDataSourceResponse describeDataSource(DescribeDataSourceRequest describeDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a data source.
describeDataSourceRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DescribeDataSourceResponse describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a data source.
This is a convenience which creates an instance of the DescribeDataSourceRequest.Builder avoiding the
need to create one manually via DescribeDataSourceRequest.builder()
describeDataSourceRequest - A Consumer that will call methods on DescribeDataSourceRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DescribeDataSourcePermissionsResponse describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the resource permissions for a data source.
describeDataSourcePermissionsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DescribeDataSourcePermissionsResponse describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the resource permissions for a data source.
This is a convenience which creates an instance of the DescribeDataSourcePermissionsRequest.Builder
avoiding the need to create one manually via DescribeDataSourcePermissionsRequest.builder()
describeDataSourcePermissionsRequest - A Consumer that will call methods on DescribeDataSourcePermissionsRequest.Builder to
create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault 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).
describeGroupRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
This is a convenience which creates an instance of the DescribeGroupRequest.Builder avoiding the need to
create one manually via DescribeGroupRequest.builder()
describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeIamPolicyAssignmentResponse describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIamPolicyAssignmentRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.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.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.AwsServiceExceptiondefault DescribeIamPolicyAssignmentResponse describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing IAM policy assignment, as specified by the assignment name.
This is a convenience which creates an instance of the DescribeIamPolicyAssignmentRequest.Builder
avoiding the need to create one manually via DescribeIamPolicyAssignmentRequest.builder()
describeIamPolicyAssignmentRequest - A Consumer that will call methods on DescribeIAMPolicyAssignmentRequest.Builder to create
a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.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.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.AwsServiceExceptiondefault DescribeIngestionResponse describeIngestion(DescribeIngestionRequest describeIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a SPICE ingestion.
describeIngestionRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DescribeIngestionResponse describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a SPICE ingestion.
This is a convenience which creates an instance of the DescribeIngestionRequest.Builder avoiding the need
to create one manually via DescribeIngestionRequest.builder()
describeIngestionRequest - A Consumer that will call methods on DescribeIngestionRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault DescribeTemplateResponse describeTemplate(DescribeTemplateRequest describeTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a template's metadata.
describeTemplateRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.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.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.AwsServiceExceptiondefault DescribeTemplateResponse describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a template's metadata.
This is a convenience which creates an instance of the DescribeTemplateRequest.Builder avoiding the need
to create one manually via DescribeTemplateRequest.builder()
describeTemplateRequest - A Consumer that will call methods on DescribeTemplateRequest.Builder to create a request.InvalidParameterValueException - One or more parameters has a value that isn't valid.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.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.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.AwsServiceExceptiondefault DescribeTemplateAliasResponse describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the template alias for a template.
describeTemplateAliasRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault DescribeTemplateAliasResponse describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the template alias for a template.
This is a convenience which creates an instance of the DescribeTemplateAliasRequest.Builder avoiding the
need to create one manually via DescribeTemplateAliasRequest.builder()
describeTemplateAliasRequest - A Consumer that will call methods on DescribeTemplateAliasRequest.Builder to create a
request.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault DescribeTemplatePermissionsResponse describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes read and write permissions on a template.
describeTemplatePermissionsRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault DescribeTemplatePermissionsResponse describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes read and write permissions on a template.
This is a convenience which creates an instance of the DescribeTemplatePermissionsRequest.Builder
avoiding the need to create one manually via DescribeTemplatePermissionsRequest.builder()
describeTemplatePermissionsRequest - A Consumer that will call methods on DescribeTemplatePermissionsRequest.Builder to create
a request.ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns information about a user, given the user name.
describeUserRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDashboardEmbedUrlResponse getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, DomainNotWhitelistedException, QuickSightUserNotFoundException, IdentityTypeNotSupportedException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
getDashboardEmbedUrlRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.DomainNotWhitelistedException - The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the
approved list by an Amazon QuickSight admin.QuickSightUserNotFoundException - The user with the provided name isn't 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 isn't supported. Supported identity types include IAM and
QUICKSIGHT.SessionLifetimeInMinutesInvalidException - The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-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.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.AwsServiceExceptiondefault GetDashboardEmbedUrlResponse getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, DomainNotWhitelistedException, QuickSightUserNotFoundException, IdentityTypeNotSupportedException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
This is a convenience which creates an instance of the GetDashboardEmbedUrlRequest.Builder avoiding the
need to create one manually via GetDashboardEmbedUrlRequest.builder()
getDashboardEmbedUrlRequest - A Consumer that will call methods on GetDashboardEmbedUrlRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.DomainNotWhitelistedException - The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the
approved list by an Amazon QuickSight admin.QuickSightUserNotFoundException - The user with the provided name isn't 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 isn't supported. Supported identity types include IAM and
QUICKSIGHT.SessionLifetimeInMinutesInvalidException - The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-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.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.AwsServiceExceptiondefault ListDashboardVersionsResponse listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the dashboards in the QuickSight subscription.
listDashboardVersionsRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListDashboardVersionsResponse listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the dashboards in the QuickSight subscription.
This is a convenience which creates an instance of the ListDashboardVersionsRequest.Builder avoiding the
need to create one manually via ListDashboardVersionsRequest.builder()
listDashboardVersionsRequest - A Consumer that will call methods on ListDashboardVersionsRequest.Builder to create a
request.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListDashboardVersionsIterable listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the dashboards in the QuickSight subscription.
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client
.listDashboardVersionsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation.
listDashboardVersionsRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListDashboardVersionsIterable listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the dashboards in the QuickSight subscription.
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client
.listDashboardVersionsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation.
This is a convenience which creates an instance of the ListDashboardVersionsRequest.Builder avoiding the
need to create one manually via ListDashboardVersionsRequest.builder()
listDashboardVersionsRequest - A Consumer that will call methods on ListDashboardVersionsRequest.Builder to create a
request.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an AWS account.
listDashboardsRequest - ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an AWS account.
This is a convenience which creates an instance of the ListDashboardsRequest.Builder avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an AWS account.
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client
.listDashboardsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest) operation.
listDashboardsRequest - ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an AWS account.
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client
.listDashboardsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest) operation.
This is a convenience which creates an instance of the ListDashboardsRequest.Builder avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListDataSetsResponse listDataSets(ListDataSetsRequest listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
listDataSetsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListDataSetsResponse listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
This is a convenience which creates an instance of the ListDataSetsRequest.Builder avoiding the need to
create one manually via ListDataSetsRequest.builder()
listDataSetsRequest - A Consumer that will call methods on ListDataSetsRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListDataSetsIterable listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
This is a variant of listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest) operation.
listDataSetsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListDataSetsIterable listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
This is a variant of listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest) operation.
This is a convenience which creates an instance of the ListDataSetsRequest.Builder avoiding the need to
create one manually via ListDataSetsRequest.builder()
listDataSetsRequest - A Consumer that will call methods on ListDataSetsRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current AWS Region that belong to this AWS account.
listDataSourcesRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current AWS Region that belong to this AWS account.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current AWS Region that belong to this AWS account.
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client
.listDataSourcesPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest) operation.
listDataSourcesRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current AWS Region that belong to this AWS account.
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client
.listDataSourcesPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest) operation.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListGroupMembershipsResponse listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists member users in a group.
listGroupMembershipsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupMembershipsResponse listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists member users in a group.
This is a convenience which creates an instance of the ListGroupMembershipsRequest.Builder avoiding the
need to create one manually via ListGroupMembershipsRequest.builder()
listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists all user groups in Amazon QuickSight.
listGroupsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIamPolicyAssignmentsResponse listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists IAM policy assignments in the current Amazon QuickSight account.
listIamPolicyAssignmentsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.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.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.AwsServiceExceptiondefault ListIamPolicyAssignmentsResponse listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists IAM policy assignments in the current Amazon QuickSight account.
This is a convenience which creates an instance of the ListIamPolicyAssignmentsRequest.Builder avoiding
the need to create one manually via ListIamPolicyAssignmentsRequest.builder()
listIamPolicyAssignmentsRequest - A Consumer that will call methods on ListIAMPolicyAssignmentsRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.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.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.AwsServiceExceptiondefault ListIamPolicyAssignmentsForUserResponse listIAMPolicyAssignmentsForUser(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
listIamPolicyAssignmentsForUserRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in a state that indicates an action is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListIamPolicyAssignmentsForUserResponse listIAMPolicyAssignmentsForUser(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
This is a convenience which creates an instance of the ListIamPolicyAssignmentsForUserRequest.Builder
avoiding the need to create one manually via ListIamPolicyAssignmentsForUserRequest.builder()
listIamPolicyAssignmentsForUserRequest - A Consumer that will call methods on ListIAMPolicyAssignmentsForUserRequest.Builder to
create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in a state that indicates an action is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListIngestionsResponse listIngestions(ListIngestionsRequest listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset.
listIngestionsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListIngestionsResponse listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset.
This is a convenience which creates an instance of the ListIngestionsRequest.Builder avoiding the need to
create one manually via ListIngestionsRequest.builder()
listIngestionsRequest - A Consumer that will call methods on ListIngestionsRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListIngestionsIterable listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset.
This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client
.listIngestionsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest) operation.
listIngestionsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListIngestionsIterable listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset.
This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client
.listIngestionsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest) operation.
This is a convenience which creates an instance of the ListIngestionsRequest.Builder avoiding the need to
create one manually via ListIngestionsRequest.builder()
listIngestionsRequest - A Consumer that will call methods on ListIngestionsRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the tags assigned to a resource.
listTagsForResourceRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the tags assigned to a resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault ListTemplateAliasesResponse listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
listTemplateAliasesRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault ListTemplateAliasesResponse listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
This is a convenience which creates an instance of the ListTemplateAliasesRequest.Builder avoiding the
need to create one manually via ListTemplateAliasesRequest.builder()
listTemplateAliasesRequest - A Consumer that will call methods on ListTemplateAliasesRequest.Builder to create a
request.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault ListTemplateAliasesIterable listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client
.listTemplateAliasesPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation.
listTemplateAliasesRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault ListTemplateAliasesIterable listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client
.listTemplateAliasesPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation.
This is a convenience which creates an instance of the ListTemplateAliasesRequest.Builder avoiding the
need to create one manually via ListTemplateAliasesRequest.builder()
listTemplateAliasesRequest - A Consumer that will call methods on ListTemplateAliasesRequest.Builder to create a
request.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault ListTemplateVersionsResponse listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
listTemplateVersionsRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListTemplateVersionsResponse listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
This is a convenience which creates an instance of the ListTemplateVersionsRequest.Builder avoiding the
need to create one manually via ListTemplateVersionsRequest.builder()
listTemplateVersionsRequest - A Consumer that will call methods on ListTemplateVersionsRequest.Builder to create a
request.ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListTemplateVersionsIterable listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client
.listTemplateVersionsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation.
listTemplateVersionsRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListTemplateVersionsIterable listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client
.listTemplateVersionsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation.
This is a convenience which creates an instance of the ListTemplateVersionsRequest.Builder avoiding the
need to create one manually via ListTemplateVersionsRequest.builder()
listTemplateVersionsRequest - A Consumer that will call methods on ListTemplateVersionsRequest.Builder to create a
request.ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListTemplatesResponse listTemplates(ListTemplatesRequest listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
listTemplatesRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListTemplatesResponse listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
This is a convenience which creates an instance of the ListTemplatesRequest.Builder avoiding the need to
create one manually via ListTemplatesRequest.builder()
listTemplatesRequest - A Consumer that will call methods on ListTemplatesRequest.Builder to create a request.ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListTemplatesIterable listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client
.listTemplatesPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest) operation.
listTemplatesRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListTemplatesIterable listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client
.listTemplatesPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest) operation.
This is a convenience which creates an instance of the ListTemplatesRequest.Builder avoiding the need to
create one manually via ListTemplatesRequest.builder()
listTemplatesRequest - A Consumer that will call methods on ListTemplatesRequest.Builder to create a request.ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.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.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.AwsServiceExceptiondefault ListUserGroupsResponse listUserGroups(ListUserGroupsRequest listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
listUserGroupsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUserGroupsResponse listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
This is a convenience which creates an instance of the ListUserGroupsRequest.Builder avoiding the need to
create one manually via ListUserGroupsRequest.builder()
listUserGroupsRequest - A Consumer that will call methods on ListUserGroupsRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listUsersRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
registerUserRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.ResourceExistsException - The resource specified already exists.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.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the RegisterUserRequest.Builder avoiding the need to
create one manually via RegisterUserRequest.builder()
registerUserRequest - A Consumer that will call methods on RegisterUserRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.ResourceExistsException - The resource specified already exists.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.AwsServiceExceptiondefault SearchDashboardsResponse searchDashboards(SearchDashboardsRequest searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searchs for dashboards that belong to a user.
searchDashboardsRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InvalidParameterValueException - One or more parameters has a value that isn't valid.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.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault SearchDashboardsResponse searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searchs for dashboards that belong to a user.
This is a convenience which creates an instance of the SearchDashboardsRequest.Builder avoiding the need
to create one manually via SearchDashboardsRequest.builder()
searchDashboardsRequest - A Consumer that will call methods on SearchDashboardsRequest.Builder to create a request.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InvalidParameterValueException - One or more parameters has a value that isn't valid.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.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault SearchDashboardsIterable searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searchs for dashboards that belong to a user.
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client
.searchDashboardsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.
searchDashboardsRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InvalidParameterValueException - One or more parameters has a value that isn't valid.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.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault SearchDashboardsIterable searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searchs for dashboards that belong to a user.
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client
.searchDashboardsPaginator(request);
for (software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.
This is a convenience which creates an instance of the SearchDashboardsRequest.Builder avoiding the need
to create one manually via SearchDashboardsRequest.builder()
searchDashboardsRequest - A Consumer that will call methods on SearchDashboardsRequest.Builder to create a request.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InvalidParameterValueException - One or more parameters has a value that isn't valid.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.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
tagResourceRequest - LimitExceededException - A limit is exceeded.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.LimitExceededException - A limit is exceeded.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes a tag or tags from a resource.
untagResourceRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes a tag or tags from a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateDashboardResponse updateDashboard(UpdateDashboardRequest updateDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dashboard in an AWS account.
updateDashboardRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault UpdateDashboardResponse updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dashboard in an AWS account.
This is a convenience which creates an instance of the UpdateDashboardRequest.Builder avoiding the need
to create one manually via UpdateDashboardRequest.builder()
updateDashboardRequest - A Consumer that will call methods on UpdateDashboardRequest.Builder to create a request.ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault UpdateDashboardPermissionsResponse updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates read and write permissions on a dashboard.
updateDashboardPermissionsRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateDashboardPermissionsResponse updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates read and write permissions on a dashboard.
This is a convenience which creates an instance of the UpdateDashboardPermissionsRequest.Builder avoiding
the need to create one manually via UpdateDashboardPermissionsRequest.builder()
updateDashboardPermissionsRequest - A Consumer that will call methods on UpdateDashboardPermissionsRequest.Builder to create a
request.ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateDashboardPublishedVersionResponse updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest) throws InvalidParameterValueException, ThrottlingException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the published version of a dashboard.
updateDashboardPublishedVersionRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault UpdateDashboardPublishedVersionResponse updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest) throws InvalidParameterValueException, ThrottlingException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the published version of a dashboard.
This is a convenience which creates an instance of the UpdateDashboardPublishedVersionRequest.Builder
avoiding the need to create one manually via UpdateDashboardPublishedVersionRequest.builder()
updateDashboardPublishedVersionRequest - A Consumer that will call methods on UpdateDashboardPublishedVersionRequest.Builder to
create a request.InvalidParameterValueException - One or more parameters has a value that isn't valid.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault UpdateDataSetResponse updateDataSet(UpdateDataSetRequest updateDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dataset.
updateDataSetRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.LimitExceededException - A limit is exceeded.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault UpdateDataSetResponse updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dataset.
This is a convenience which creates an instance of the UpdateDataSetRequest.Builder avoiding the need to
create one manually via UpdateDataSetRequest.builder()
updateDataSetRequest - A Consumer that will call methods on UpdateDataSetRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.LimitExceededException - A limit is exceeded.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault UpdateDataSetPermissionsResponse updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
updateDataSetPermissionsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateDataSetPermissionsResponse updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
This is a convenience which creates an instance of the UpdateDataSetPermissionsRequest.Builder avoiding
the need to create one manually via UpdateDataSetPermissionsRequest.builder()
updateDataSetPermissionsRequest - A Consumer that will call methods on UpdateDataSetPermissionsRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a data source.
updateDataSourceRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a data source.
This is a convenience which creates an instance of the UpdateDataSourceRequest.Builder avoiding the need
to create one manually via UpdateDataSourceRequest.builder()
updateDataSourceRequest - A Consumer that will call methods on UpdateDataSourceRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateDataSourcePermissionsResponse updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions to a data source.
updateDataSourcePermissionsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateDataSourcePermissionsResponse updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions to a data source.
This is a convenience which creates an instance of the UpdateDataSourcePermissionsRequest.Builder
avoiding the need to create one manually via UpdateDataSourcePermissionsRequest.builder()
updateDataSourcePermissionsRequest - A Consumer that will call methods on UpdateDataSourcePermissionsRequest.Builder to create
a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Changes a group description.
updateGroupRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Changes a group description.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateIamPolicyAssignmentResponse updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
updateIamPolicyAssignmentRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in a state that indicates an action is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateIamPolicyAssignmentResponse updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
This is a convenience which creates an instance of the UpdateIamPolicyAssignmentRequest.Builder avoiding
the need to create one manually via UpdateIamPolicyAssignmentRequest.builder()
updateIamPolicyAssignmentRequest - A Consumer that will call methods on UpdateIAMPolicyAssignmentRequest.Builder to create a
request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in a state that indicates an action is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.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.AwsServiceExceptiondefault UpdateTemplateResponse updateTemplate(UpdateTemplateRequest updateTemplateRequest) throws InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a template from an existing Amazon QuickSight analysis or another template.
updateTemplateRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault UpdateTemplateResponse updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) throws InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a template from an existing Amazon QuickSight analysis or another template.
This is a convenience which creates an instance of the UpdateTemplateRequest.Builder avoiding the need to
create one manually via UpdateTemplateRequest.builder()
updateTemplateRequest - A Consumer that will call methods on UpdateTemplateRequest.Builder to create a request.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.LimitExceededException - A limit is exceeded.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.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.AwsServiceExceptiondefault UpdateTemplateAliasResponse updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the template alias of a template.
updateTemplateAliasRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.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.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.AwsServiceExceptiondefault UpdateTemplateAliasResponse updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the template alias of a template.
This is a convenience which creates an instance of the UpdateTemplateAliasRequest.Builder avoiding the
need to create one manually via UpdateTemplateAliasRequest.builder()
updateTemplateAliasRequest - A Consumer that will call methods on UpdateTemplateAliasRequest.Builder to create a
request.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.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.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.AwsServiceExceptiondefault UpdateTemplatePermissionsResponse updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a template.
updateTemplatePermissionsRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault UpdateTemplatePermissionsResponse updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a template.
This is a convenience which creates an instance of the UpdateTemplatePermissionsRequest.Builder avoiding
the need to create one manually via UpdateTemplatePermissionsRequest.builder()
updateTemplatePermissionsRequest - A Consumer that will call methods on UpdateTemplatePermissionsRequest.Builder to create a
request.ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters has a value that isn't valid.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.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.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.AwsServiceExceptiondefault UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates an Amazon QuickSight user.
updateUserRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure 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 has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.