@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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
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 CreateAccountCustomizationResponse |
createAccountCustomization(Consumer<CreateAccountCustomizationRequest.Builder> createAccountCustomizationRequest)
Creates Amazon QuickSight customizations the current AWS Region.
|
default CreateAccountCustomizationResponse |
createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest)
Creates Amazon QuickSight customizations the current AWS Region.
|
default CreateAnalysisResponse |
createAnalysis(Consumer<CreateAnalysisRequest.Builder> createAnalysisRequest)
Creates an analysis in Amazon QuickSight.
|
default CreateAnalysisResponse |
createAnalysis(CreateAnalysisRequest createAnalysisRequest)
Creates an analysis in Amazon QuickSight.
|
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 CreateNamespaceResponse |
createNamespace(Consumer<CreateNamespaceRequest.Builder> createNamespaceRequest)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
|
default CreateNamespaceResponse |
createNamespace(CreateNamespaceRequest createNamespaceRequest)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
|
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 CreateThemeResponse |
createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest)
Creates a theme.
|
default CreateThemeResponse |
createTheme(CreateThemeRequest createThemeRequest)
Creates a theme.
|
default CreateThemeAliasResponse |
createThemeAlias(Consumer<CreateThemeAliasRequest.Builder> createThemeAliasRequest)
Creates a theme alias for a theme.
|
default CreateThemeAliasResponse |
createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest)
Creates a theme alias for a theme.
|
default DeleteAccountCustomizationResponse |
deleteAccountCustomization(Consumer<DeleteAccountCustomizationRequest.Builder> deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight
namespace.
|
default DeleteAccountCustomizationResponse |
deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight
namespace.
|
default DeleteAnalysisResponse |
deleteAnalysis(Consumer<DeleteAnalysisRequest.Builder> deleteAnalysisRequest)
Deletes an analysis from Amazon QuickSight.
|
default DeleteAnalysisResponse |
deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest)
Deletes an analysis from Amazon QuickSight.
|
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 DeleteNamespaceResponse |
deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest)
Deletes a namespace and the users and groups that are associated with the namespace.
|
default DeleteNamespaceResponse |
deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes a namespace and the users and groups that are associated with the namespace.
|
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 DeleteThemeResponse |
deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest)
Deletes a theme.
|
default DeleteThemeResponse |
deleteTheme(DeleteThemeRequest deleteThemeRequest)
Deletes a theme.
|
default DeleteThemeAliasResponse |
deleteThemeAlias(Consumer<DeleteThemeAliasRequest.Builder> deleteThemeAliasRequest)
Deletes the version of the theme that the specified theme alias points to.
|
default DeleteThemeAliasResponse |
deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest)
Deletes the version of the theme that the specified theme 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 DescribeAccountCustomizationResponse |
describeAccountCustomization(Consumer<DescribeAccountCustomizationRequest.Builder> describeAccountCustomizationRequest)
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS
Region.
|
default DescribeAccountCustomizationResponse |
describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS
Region.
|
default DescribeAccountSettingsResponse |
describeAccountSettings(Consumer<DescribeAccountSettingsRequest.Builder> describeAccountSettingsRequest)
Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
|
default DescribeAccountSettingsResponse |
describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest)
Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
|
default DescribeAnalysisResponse |
describeAnalysis(Consumer<DescribeAnalysisRequest.Builder> describeAnalysisRequest)
Provides a summary of the metadata for an analysis.
|
default DescribeAnalysisResponse |
describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest)
Provides a summary of the metadata for an analysis.
|
default DescribeAnalysisPermissionsResponse |
describeAnalysisPermissions(Consumer<DescribeAnalysisPermissionsRequest.Builder> describeAnalysisPermissionsRequest)
Provides the read and write permissions for an analysis.
|
default DescribeAnalysisPermissionsResponse |
describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest)
Provides the read and write permissions for an analysis.
|
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 DescribeNamespaceResponse |
describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest)
Describes the current namespace.
|
default DescribeNamespaceResponse |
describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
Describes the current namespace.
|
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 DescribeThemeResponse |
describeTheme(Consumer<DescribeThemeRequest.Builder> describeThemeRequest)
Describes a theme.
|
default DescribeThemeResponse |
describeTheme(DescribeThemeRequest describeThemeRequest)
Describes a theme.
|
default DescribeThemeAliasResponse |
describeThemeAlias(Consumer<DescribeThemeAliasRequest.Builder> describeThemeAliasRequest)
Describes the alias for a theme.
|
default DescribeThemeAliasResponse |
describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest)
Describes the alias for a theme.
|
default DescribeThemePermissionsResponse |
describeThemePermissions(Consumer<DescribeThemePermissionsRequest.Builder> describeThemePermissionsRequest)
Describes the read and write permissions for a theme.
|
default DescribeThemePermissionsResponse |
describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest)
Describes the read and write permissions for a theme.
|
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 session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard
in your web server code.
|
default GetDashboardEmbedUrlResponse |
getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard
in your web server code.
|
default GetSessionEmbedUrlResponse |
getSessionEmbedUrl(Consumer<GetSessionEmbedUrlRequest.Builder> getSessionEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your
web server code.
|
default GetSessionEmbedUrlResponse |
getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your
web server code.
|
default ListAnalysesResponse |
listAnalyses(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified AWS account.
|
default ListAnalysesResponse |
listAnalyses(ListAnalysesRequest listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified AWS account.
|
default ListAnalysesIterable |
listAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified AWS account.
|
default ListAnalysesIterable |
listAnalysesPaginator(ListAnalysesRequest listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified AWS account.
|
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 ListNamespacesResponse |
listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)
Lists the namespaces for the specified AWS account.
|
default ListNamespacesResponse |
listNamespaces(ListNamespacesRequest listNamespacesRequest)
Lists the namespaces for the specified AWS account.
|
default ListNamespacesIterable |
listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)
Lists the namespaces for the specified AWS account.
|
default ListNamespacesIterable |
listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest)
Lists the namespaces for the specified AWS account.
|
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 ListThemeAliasesResponse |
listThemeAliases(Consumer<ListThemeAliasesRequest.Builder> listThemeAliasesRequest)
Lists all the aliases of a theme.
|
default ListThemeAliasesResponse |
listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest)
Lists all the aliases of a theme.
|
default ListThemesResponse |
listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest)
Lists all the themes in the current AWS account.
|
default ListThemesResponse |
listThemes(ListThemesRequest listThemesRequest)
Lists all the themes in the current AWS account.
|
default ListThemesIterable |
listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest)
Lists all the themes in the current AWS account.
|
default ListThemesIterable |
listThemesPaginator(ListThemesRequest listThemesRequest)
Lists all the themes in the current AWS account.
|
default ListThemeVersionsResponse |
listThemeVersions(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)
Lists all the versions of the themes in the current AWS account.
|
default ListThemeVersionsResponse |
listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest)
Lists all the versions of the themes in the current AWS account.
|
default ListThemeVersionsIterable |
listThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)
Lists all the versions of the themes in the current AWS account.
|
default ListThemeVersionsIterable |
listThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest)
Lists all the versions of the themes in the current AWS 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 RestoreAnalysisResponse |
restoreAnalysis(Consumer<RestoreAnalysisRequest.Builder> restoreAnalysisRequest)
Restores an analysis.
|
default RestoreAnalysisResponse |
restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest)
Restores an analysis.
|
default SearchAnalysesResponse |
searchAnalyses(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest)
Searches for analyses that belong to the user specified in the filter.
|
default SearchAnalysesResponse |
searchAnalyses(SearchAnalysesRequest searchAnalysesRequest)
Searches for analyses that belong to the user specified in the filter.
|
default SearchAnalysesIterable |
searchAnalysesPaginator(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest)
Searches for analyses that belong to the user specified in the filter.
|
default SearchAnalysesIterable |
searchAnalysesPaginator(SearchAnalysesRequest searchAnalysesRequest)
Searches for analyses that belong to the user specified in the filter.
|
default SearchDashboardsResponse |
searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
Searches for dashboards that belong to a user.
|
default SearchDashboardsResponse |
searchDashboards(SearchDashboardsRequest searchDashboardsRequest)
Searches for dashboards that belong to a user.
|
default SearchDashboardsIterable |
searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
Searches for dashboards that belong to a user.
|
default SearchDashboardsIterable |
searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest)
Searches 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 UpdateAccountCustomizationResponse |
updateAccountCustomization(Consumer<UpdateAccountCustomizationRequest.Builder> updateAccountCustomizationRequest)
Updates Amazon QuickSight customizations the current AWS Region.
|
default UpdateAccountCustomizationResponse |
updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest)
Updates Amazon QuickSight customizations the current AWS Region.
|
default UpdateAccountSettingsResponse |
updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)
Updates the Amazon QuickSight settings in your AWS account.
|
default UpdateAccountSettingsResponse |
updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the Amazon QuickSight settings in your AWS account.
|
default UpdateAnalysisResponse |
updateAnalysis(Consumer<UpdateAnalysisRequest.Builder> updateAnalysisRequest)
Updates an analysis in Amazon QuickSight
|
default UpdateAnalysisResponse |
updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest)
Updates an analysis in Amazon QuickSight
|
default UpdateAnalysisPermissionsResponse |
updateAnalysisPermissions(Consumer<UpdateAnalysisPermissionsRequest.Builder> updateAnalysisPermissionsRequest)
Updates the read and write permissions for an analysis.
|
default UpdateAnalysisPermissionsResponse |
updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest)
Updates the read and write permissions for an analysis.
|
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 UpdateThemeResponse |
updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest)
Updates a theme.
|
default UpdateThemeResponse |
updateTheme(UpdateThemeRequest updateThemeRequest)
Updates a theme.
|
default UpdateThemeAliasResponse |
updateThemeAlias(Consumer<UpdateThemeAliasRequest.Builder> updateThemeAliasRequest)
Updates an alias of a theme.
|
default UpdateThemeAliasResponse |
updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest)
Updates an alias of a theme.
|
default UpdateThemePermissionsResponse |
updateThemePermissions(Consumer<UpdateThemePermissionsRequest.Builder> updateThemePermissionsRequest)
Updates the resource permissions for a theme.
|
default UpdateThemePermissionsResponse |
updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest)
Updates the resource permissions for a theme.
|
default UpdateUserResponse |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates an Amazon QuickSight user.
|
default UpdateUserResponse |
updateUser(UpdateUserRequest updateUserRequest)
Updates an Amazon QuickSight user.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.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.AwsServiceException
default 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.AwsServiceException
default CreateAccountCustomizationResponse createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by
using the CreateAccountCustomization
or UpdateAccountCustomization
API operation. To
further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight
in the Amazon QuickSight User Guide.
You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace
instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To
find out which customizations apply, use the DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to add a theme as the namespace default,
make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme
isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the
current permissions by using the DescribeThemePermissions
API operation. To share the
theme, grant permissions by using the UpdateThemePermissions
API operation.
createAccountCustomizationRequest
- 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.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAccountCustomizationResponse createAccountCustomization(Consumer<CreateAccountCustomizationRequest.Builder> createAccountCustomizationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by
using the CreateAccountCustomization
or UpdateAccountCustomization
API operation. To
further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight
in the Amazon QuickSight User Guide.
You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace
instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To
find out which customizations apply, use the DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to add a theme as the namespace default,
make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme
isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the
current permissions by using the DescribeThemePermissions
API operation. To share the
theme, grant permissions by using the UpdateThemePermissions
API operation.
This is a convenience which creates an instance of the CreateAccountCustomizationRequest.Builder
avoiding
the need to create one manually via CreateAccountCustomizationRequest.builder()
createAccountCustomizationRequest
- A Consumer
that will call methods on CreateAccountCustomizationRequest.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.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAnalysisResponse createAnalysis(CreateAnalysisRequest createAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an analysis in Amazon QuickSight.
createAnalysisRequest
- 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.AwsServiceException
default CreateAnalysisResponse createAnalysis(Consumer<CreateAnalysisRequest.Builder> createAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an analysis in Amazon QuickSight.
This is a convenience which creates an instance of the CreateAnalysisRequest.Builder
avoiding the need to
create one manually via CreateAnalysisRequest.builder()
createAnalysisRequest
- A Consumer
that will call methods on CreateAnalysisRequest.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.AwsServiceException
default 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. 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.AwsServiceException
default 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. 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
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.AwsServiceException
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
This is a convenience which creates an instance of the CreateGroupRequest.Builder
avoiding the need to
create one manually via CreateGroupRequest.builder()
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.AwsServiceException
default CreateGroupMembershipResponse createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Adds an Amazon QuickSight user to an Amazon QuickSight group.
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.AwsServiceException
default CreateGroupMembershipResponse createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Adds an Amazon QuickSight user to an Amazon QuickSight group.
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.AwsServiceException
default 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 assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per AWS account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
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 operation 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.AwsServiceException
default 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 assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per AWS account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
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 operation 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default CreateNamespaceResponse createNamespace(CreateNamespaceRequest createNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, ConflictException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
createNamespaceRequest
- 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.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateNamespaceResponse createNamespace(Consumer<CreateNamespaceRequest.Builder> createNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, ConflictException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
This is a convenience which creates an instance of the CreateNamespaceRequest.Builder
avoiding the need
to create one manually via CreateNamespaceRequest.builder()
createNamespaceRequest
- A Consumer
that will call methods on CreateNamespaceRequest.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.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateTemplateResponse createTemplate(CreateTemplateRequest createTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, ConflictException, 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.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.AwsServiceException
default CreateTemplateResponse createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, ConflictException, 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.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.AwsServiceException
default 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.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.AwsServiceException
default 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.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.AwsServiceException
default CreateThemeResponse createTheme(CreateThemeRequest createThemeRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
createThemeRequest
- 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.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.LimitExceededException
- A limit is exceeded.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.AwsServiceException
default CreateThemeResponse createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
This is a convenience which creates an instance of the CreateThemeRequest.Builder
avoiding the need to
create one manually via CreateThemeRequest.builder()
createThemeRequest
- A Consumer
that will call methods on CreateThemeRequest.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.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.LimitExceededException
- A limit is exceeded.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.AwsServiceException
default CreateThemeAliasResponse createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest) throws ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a theme alias for a theme.
createThemeAliasRequest
- 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.AwsServiceException
default CreateThemeAliasResponse createThemeAlias(Consumer<CreateThemeAliasRequest.Builder> createThemeAliasRequest) throws ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a theme alias for a theme.
This is a convenience which creates an instance of the CreateThemeAliasRequest.Builder
avoiding the need
to create one manually via CreateThemeAliasRequest.builder()
createThemeAliasRequest
- A Consumer
that will call methods on CreateThemeAliasRequest.Builder
to create a request.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.AwsServiceException
default DeleteAccountCustomizationResponse deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
deleteAccountCustomizationRequest
- 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.AwsServiceException
default DeleteAccountCustomizationResponse deleteAccountCustomization(Consumer<DeleteAccountCustomizationRequest.Builder> deleteAccountCustomizationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
This is a convenience which creates an instance of the DeleteAccountCustomizationRequest.Builder
avoiding
the need to create one manually via DeleteAccountCustomizationRequest.builder()
deleteAccountCustomizationRequest
- A Consumer
that will call methods on DeleteAccountCustomizationRequest.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.AwsServiceException
default DeleteAnalysisResponse deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can
restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight
attaches a DeletionTime
stamp to the response that specifies the end of the recovery window. At the
end of the recovery window, QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis
API operation to remove the
DeletionTime
stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
deleteAnalysisRequest
- 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.AwsServiceException
default DeleteAnalysisResponse deleteAnalysis(Consumer<DeleteAnalysisRequest.Builder> deleteAnalysisRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can
restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight
attaches a DeletionTime
stamp to the response that specifies the end of the recovery window. At the
end of the recovery window, QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis
API operation to remove the
DeletionTime
stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
This is a convenience which creates an instance of the DeleteAnalysisRequest.Builder
avoiding the need to
create one manually via DeleteAnalysisRequest.builder()
deleteAnalysisRequest
- A Consumer
that will call methods on DeleteAnalysisRequest.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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the data source permanently. This operation 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.AwsServiceException
default DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the data source permanently. This operation 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.AwsServiceException
default 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.AwsServiceException
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a user group from Amazon QuickSight.
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.AwsServiceException
default DeleteGroupMembershipResponse deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a user from a group so that the user is no longer a member of the group.
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.AwsServiceException
default DeleteGroupMembershipResponse deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a user from a group so that the user is no longer a member of the group.
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.AwsServiceException
default 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 operation 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.AwsServiceException
default 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 operation 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.AwsServiceException
default DeleteNamespaceResponse deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
deleteNamespaceRequest
- 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.AwsServiceException
default DeleteNamespaceResponse deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
This is a convenience which creates an instance of the DeleteNamespaceRequest.Builder
avoiding the need
to create one manually via DeleteNamespaceRequest.builder()
deleteNamespaceRequest
- A Consumer
that will call methods on DeleteNamespaceRequest.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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default DeleteTemplateAliasResponse deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, 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.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.AwsServiceException
default DeleteTemplateAliasResponse deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, 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.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.AwsServiceException
default DeleteThemeResponse deleteTheme(DeleteThemeRequest deleteThemeRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a theme.
deleteThemeRequest
- 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.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.AwsServiceException
default DeleteThemeResponse deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a theme.
This is a convenience which creates an instance of the DeleteThemeRequest.Builder
avoiding the need to
create one manually via DeleteThemeRequest.builder()
deleteThemeRequest
- A Consumer
that will call methods on DeleteThemeRequest.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.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.AwsServiceException
default DeleteThemeAliasResponse deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
deleteThemeAliasRequest
- 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.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.AwsServiceException
default DeleteThemeAliasResponse deleteThemeAlias(Consumer<DeleteThemeAliasRequest.Builder> deleteThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
This is a convenience which creates an instance of the DeleteThemeAliasRequest.Builder
avoiding the need
to create one manually via DeleteThemeAliasRequest.builder()
deleteThemeAliasRequest
- A Consumer
that will call methods on DeleteThemeAliasRequest.Builder
to create a request.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.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.AwsServiceException
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, 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.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, 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.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserByPrincipalIdResponse deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, 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.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserByPrincipalIdResponse deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, 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.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAccountCustomizationResponse describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS
Region. The QuickSight console evaluates which customizations to apply by running this API operation with the
Resolved
flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
AWS Account
- The AWS account exists at the top of the hierarchy. It has the potential to use all of
the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home
Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region.
AWS Region
- In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a
separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US
East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are
constrained to a namespace.
To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default AWS Region. Use Enter to key the same settings for your
keys. For more information, see Configuring the AWS CLI.
Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same AWS account and AWS Region.
Applied customizations
- Within an AWS Region, a set of QuickSight customizations can apply to an
AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS
account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the
CreateAccountCustomization
command in each AWS Region where you want to apply the same
customizations.
describeAccountCustomizationRequest
- 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.AwsServiceException
default DescribeAccountCustomizationResponse describeAccountCustomization(Consumer<DescribeAccountCustomizationRequest.Builder> describeAccountCustomizationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS
Region. The QuickSight console evaluates which customizations to apply by running this API operation with the
Resolved
flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
AWS Account
- The AWS account exists at the top of the hierarchy. It has the potential to use all of
the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home
Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region.
AWS Region
- In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a
separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US
East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are
constrained to a namespace.
To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default AWS Region. Use Enter to key the same settings for your
keys. For more information, see Configuring the AWS CLI.
Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same AWS account and AWS Region.
Applied customizations
- Within an AWS Region, a set of QuickSight customizations can apply to an
AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS
account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the
CreateAccountCustomization
command in each AWS Region where you want to apply the same
customizations.
This is a convenience which creates an instance of the DescribeAccountCustomizationRequest.Builder
avoiding the need to create one manually via DescribeAccountCustomizationRequest.builder()
describeAccountCustomizationRequest
- A Consumer
that will call methods on DescribeAccountCustomizationRequest.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.AwsServiceException
default DescribeAccountSettingsResponse describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
describeAccountSettingsRequest
- 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.AwsServiceException
default DescribeAccountSettingsResponse describeAccountSettings(Consumer<DescribeAccountSettingsRequest.Builder> describeAccountSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
This is a convenience which creates an instance of the DescribeAccountSettingsRequest.Builder
avoiding
the need to create one manually via DescribeAccountSettingsRequest.builder()
describeAccountSettingsRequest
- A Consumer
that will call methods on DescribeAccountSettingsRequest.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.AwsServiceException
default DescribeAnalysisResponse describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest) throws InvalidParameterValueException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary of the metadata for an analysis.
describeAnalysisRequest
- 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.AwsServiceException
default DescribeAnalysisResponse describeAnalysis(Consumer<DescribeAnalysisRequest.Builder> describeAnalysisRequest) throws InvalidParameterValueException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary of the metadata for an analysis.
This is a convenience which creates an instance of the DescribeAnalysisRequest.Builder
avoiding the need
to create one manually via DescribeAnalysisRequest.builder()
describeAnalysisRequest
- A Consumer
that will call methods on DescribeAnalysisRequest.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.AwsServiceException
default DescribeAnalysisPermissionsResponse describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides the read and write permissions for an analysis.
describeAnalysisPermissionsRequest
- 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.AwsServiceException
default DescribeAnalysisPermissionsResponse describeAnalysisPermissions(Consumer<DescribeAnalysisPermissionsRequest.Builder> describeAnalysisPermissionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides the read and write permissions for an analysis.
This is a convenience which creates an instance of the DescribeAnalysisPermissionsRequest.Builder
avoiding the need to create one manually via DescribeAnalysisPermissionsRequest.builder()
describeAnalysisPermissionsRequest
- A Consumer
that will call methods on DescribeAnalysisPermissionsRequest.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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
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.AwsServiceException
default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default DescribeNamespaceResponse describeNamespace(DescribeNamespaceRequest describeNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the current namespace.
describeNamespaceRequest
- 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.AwsServiceException
default DescribeNamespaceResponse describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the current namespace.
This is a convenience which creates an instance of the DescribeNamespaceRequest.Builder
avoiding the need
to create one manually via DescribeNamespaceRequest.builder()
describeNamespaceRequest
- A Consumer
that will call methods on DescribeNamespaceRequest.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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default DescribeThemeResponse describeTheme(DescribeThemeRequest describeThemeRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a theme.
describeThemeRequest
- 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.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.AwsServiceException
default DescribeThemeResponse describeTheme(Consumer<DescribeThemeRequest.Builder> describeThemeRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a theme.
This is a convenience which creates an instance of the DescribeThemeRequest.Builder
avoiding the need to
create one manually via DescribeThemeRequest.builder()
describeThemeRequest
- A Consumer
that will call methods on DescribeThemeRequest.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.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.AwsServiceException
default DescribeThemeAliasResponse describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the alias for a theme.
describeThemeAliasRequest
- 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.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.AwsServiceException
default DescribeThemeAliasResponse describeThemeAlias(Consumer<DescribeThemeAliasRequest.Builder> describeThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the alias for a theme.
This is a convenience which creates an instance of the DescribeThemeAliasRequest.Builder
avoiding the
need to create one manually via DescribeThemeAliasRequest.builder()
describeThemeAliasRequest
- A Consumer
that will call methods on DescribeThemeAliasRequest.Builder
to create a
request.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.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.AwsServiceException
default DescribeThemePermissionsResponse describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the read and write permissions for a theme.
describeThemePermissionsRequest
- 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.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.AwsServiceException
default DescribeThemePermissionsResponse describeThemePermissions(Consumer<DescribeThemePermissionsRequest.Builder> describeThemePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the read and write permissions for a theme.
This is a convenience which creates an instance of the DescribeThemePermissionsRequest.Builder
avoiding
the need to create one manually via DescribeThemePermissionsRequest.builder()
describeThemePermissionsRequest
- A Consumer
that will call methods on DescribeThemePermissionsRequest.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.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.AwsServiceException
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, 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.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, 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.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDashboardEmbedUrlResponse getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, DomainNotWhitelistedException, QuickSightUserNotFoundException, IdentityTypeNotSupportedException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL
only from the server, not from the user's browser. The
following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
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.UnsupportedPricingPlanException
- This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your AWS account. Before you can use embedding for anonymous users, a QuickSight
administrator needs to add capacity pricing to QuickSight. You can do this on the Manage
QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the
--identity-type ANONYMOUS
option.
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.AwsServiceException
default GetDashboardEmbedUrlResponse getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, DomainNotWhitelistedException, QuickSightUserNotFoundException, IdentityTypeNotSupportedException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL
only from the server, not from the user's browser. The
following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
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.UnsupportedPricingPlanException
- This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your AWS account. Before you can use embedding for anonymous users, a QuickSight
administrator needs to add capacity pricing to QuickSight. You can do this on the Manage
QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the
--identity-type ANONYMOUS
option.
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.AwsServiceException
default GetSessionEmbedUrlResponse getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, QuickSightUserNotFoundException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your
web server code. Use GetSessionEmbedUrl
where you want to provide an authoring portal that allows
users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight
console need belong to the author or admin security cohort. If you want to restrict permissions to some of these
features, add a custom permissions profile to the user with the UpdateUser
API operation.
Use RegisterUser
API operation to add a new user with a custom permission profile attached.
For more information, see the following sections in the Amazon QuickSight User Guide:
getSessionEmbedUrlRequest
- 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.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.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.AwsServiceException
default GetSessionEmbedUrlResponse getSessionEmbedUrl(Consumer<GetSessionEmbedUrlRequest.Builder> getSessionEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, QuickSightUserNotFoundException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your
web server code. Use GetSessionEmbedUrl
where you want to provide an authoring portal that allows
users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight
console need belong to the author or admin security cohort. If you want to restrict permissions to some of these
features, add a custom permissions profile to the user with the UpdateUser
API operation.
Use RegisterUser
API operation to add a new user with a custom permission profile attached.
For more information, see the following sections in the Amazon QuickSight User Guide:
This is a convenience which creates an instance of the GetSessionEmbedUrlRequest.Builder
avoiding the
need to create one manually via GetSessionEmbedUrlRequest.builder()
getSessionEmbedUrlRequest
- A Consumer
that will call methods on GetSessionEmbedUrlRequest.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.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.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.AwsServiceException
default ListAnalysesResponse listAnalyses(ListAnalysesRequest listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists Amazon QuickSight analyses that exist in the specified AWS account.
listAnalysesRequest
- 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.AwsServiceException
default ListAnalysesResponse listAnalyses(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists Amazon QuickSight analyses that exist in the specified AWS account.
This is a convenience which creates an instance of the ListAnalysesRequest.Builder
avoiding the need to
create one manually via ListAnalysesRequest.builder()
listAnalysesRequest
- A Consumer
that will call methods on ListAnalysesRequest.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.AwsServiceException
default ListAnalysesIterable listAnalysesPaginator(ListAnalysesRequest listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists Amazon QuickSight analyses that exist in the specified AWS account.
This is a variant of listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
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.ListAnalysesIterable responses = client.listAnalysesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(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
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
operation.
listAnalysesRequest
- 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.AwsServiceException
default ListAnalysesIterable listAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists Amazon QuickSight analyses that exist in the specified AWS account.
This is a variant of listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
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.ListAnalysesIterable responses = client.listAnalysesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(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
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
operation.
This is a convenience which creates an instance of the ListAnalysesRequest.Builder
avoiding the need to
create one manually via ListAnalysesRequest.builder()
listAnalysesRequest
- A Consumer
that will call methods on ListAnalysesRequest.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.AwsServiceException
default 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.AwsServiceException
default 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.B