@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface QuickSightClient extends SdkClient
builder()
method.
Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services 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 for the current Amazon Web Services Region.
|
default CreateAccountCustomizationResponse |
createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest)
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
|
default CreateAccountSubscriptionResponse |
createAccountSubscription(Consumer<CreateAccountSubscriptionRequest.Builder> createAccountSubscriptionRequest)
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
|
default CreateAccountSubscriptionResponse |
createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest)
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
|
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 either a template or directly with a
DashboardDefinition . |
default CreateDashboardResponse |
createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard from either a template or directly with a
DashboardDefinition . |
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 CreateFolderResponse |
createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest)
Creates an empty shared folder.
|
default CreateFolderResponse |
createFolder(CreateFolderRequest createFolderRequest)
Creates an empty shared folder.
|
default CreateFolderMembershipResponse |
createFolderMembership(Consumer<CreateFolderMembershipRequest.Builder> createFolderMembershipRequest)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
|
default CreateFolderMembershipResponse |
createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
|
default CreateGroupResponse |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Use the
CreateGroup operation to create a group in Amazon QuickSight. |
default CreateGroupResponse |
createGroup(CreateGroupRequest createGroupRequest)
Use the
CreateGroup operation to create a group in Amazon QuickSight. |
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 for a dataset.
|
default CreateIngestionResponse |
createIngestion(CreateIngestionRequest createIngestionRequest)
Creates and starts a new SPICE ingestion for 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 either from a
TemplateDefinition or from an existing Amazon QuickSight analysis
or template. |
default CreateTemplateResponse |
createTemplate(CreateTemplateRequest createTemplateRequest)
Creates a template either from a
TemplateDefinition or from an existing Amazon 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 Amazon Web Services Region for the specified Amazon Web
Services account and Amazon QuickSight namespace.
|
default DeleteAccountCustomizationResponse |
deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web
Services account and Amazon QuickSight namespace.
|
default DeleteAccountSubscriptionResponse |
deleteAccountSubscription(Consumer<DeleteAccountSubscriptionRequest.Builder> deleteAccountSubscriptionRequest)
Use the
DeleteAccountSubscription operation to delete an Amazon QuickSight account. |
default DeleteAccountSubscriptionResponse |
deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest)
Use the
DeleteAccountSubscription operation to delete an Amazon QuickSight account. |
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 DeleteFolderResponse |
deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest)
Deletes an empty folder.
|
default DeleteFolderResponse |
deleteFolder(DeleteFolderRequest deleteFolderRequest)
Deletes an empty folder.
|
default DeleteFolderMembershipResponse |
deleteFolderMembership(Consumer<DeleteFolderMembershipRequest.Builder> deleteFolderMembershipRequest)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
|
default DeleteFolderMembershipResponse |
deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
|
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 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 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 Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region.
|
default DescribeAccountCustomizationResponse |
describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region.
|
default DescribeAccountSettingsResponse |
describeAccountSettings(Consumer<DescribeAccountSettingsRequest.Builder> describeAccountSettingsRequest)
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon
Web Services account.
|
default DescribeAccountSettingsResponse |
describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest)
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon
Web Services account.
|
default DescribeAccountSubscriptionResponse |
describeAccountSubscription(Consumer<DescribeAccountSubscriptionRequest.Builder> describeAccountSubscriptionRequest)
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's
subscription.
|
default DescribeAccountSubscriptionResponse |
describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest)
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's
subscription.
|
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 DescribeAnalysisDefinitionResponse |
describeAnalysisDefinition(Consumer<DescribeAnalysisDefinitionRequest.Builder> describeAnalysisDefinitionRequest)
Provides a detailed description of the definition of an analysis.
|
default DescribeAnalysisDefinitionResponse |
describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest)
Provides a detailed description of the definition of 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 DescribeDashboardDefinitionResponse |
describeDashboardDefinition(Consumer<DescribeDashboardDefinitionRequest.Builder> describeDashboardDefinitionRequest)
Provides a detailed description of the definition of a dashboard.
|
default DescribeDashboardDefinitionResponse |
describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest)
Provides a detailed description of the definition of 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 DescribeFolderResponse |
describeFolder(Consumer<DescribeFolderRequest.Builder> describeFolderRequest)
Describes a folder.
|
default DescribeFolderResponse |
describeFolder(DescribeFolderRequest describeFolderRequest)
Describes a folder.
|
default DescribeFolderPermissionsResponse |
describeFolderPermissions(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest)
Describes permissions for a folder.
|
default DescribeFolderPermissionsResponse |
describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)
Describes permissions for a folder.
|
default DescribeFolderResolvedPermissionsResponse |
describeFolderResolvedPermissions(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest)
Describes the folder resolved permissions.
|
default DescribeFolderResolvedPermissionsResponse |
describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)
Describes the folder resolved permissions.
|
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 DescribeGroupMembershipResponse |
describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)
Use the
DescribeGroupMembership operation to determine if a user is a member of the specified group. |
default DescribeGroupMembershipResponse |
describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
Use the
DescribeGroupMembership operation to determine if a user is a member of the specified group. |
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 DescribeIpRestrictionResponse |
describeIpRestriction(Consumer<DescribeIpRestrictionRequest.Builder> describeIpRestrictionRequest)
Provides a summary and status of IP rules.
|
default DescribeIpRestrictionResponse |
describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest)
Provides a summary and status of IP rules.
|
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 DescribeTemplateDefinitionResponse |
describeTemplateDefinition(Consumer<DescribeTemplateDefinitionRequest.Builder> describeTemplateDefinitionRequest)
Provides a detailed description of the definition of a template.
|
default DescribeTemplateDefinitionResponse |
describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest)
Provides a detailed description of the definition of 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 GenerateEmbedUrlForAnonymousUserResponse |
generateEmbedUrlForAnonymousUser(Consumer<GenerateEmbedUrlForAnonymousUserRequest.Builder> generateEmbedUrlForAnonymousUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website,
without having to register any reader users.
|
default GenerateEmbedUrlForAnonymousUserResponse |
generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website,
without having to register any reader users.
|
default GenerateEmbedUrlForRegisteredUserResponse |
generateEmbedUrlForRegisteredUser(Consumer<GenerateEmbedUrlForRegisteredUserRequest.Builder> generateEmbedUrlForRegisteredUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
|
default GenerateEmbedUrlForRegisteredUserResponse |
generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
|
default GetDashboardEmbedUrlResponse |
getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest)
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon
QuickSight read-only dashboard in your website or application.
|
default GetDashboardEmbedUrlResponse |
getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon
QuickSight read-only dashboard in your website or application.
|
default GetSessionEmbedUrlResponse |
getSessionEmbedUrl(Consumer<GetSessionEmbedUrlRequest.Builder> getSessionEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed the Amazon 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 Amazon QuickSight console in
your web server code.
|
default ListAnalysesResponse |
listAnalyses(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
|
default ListAnalysesResponse |
listAnalyses(ListAnalysesRequest listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
|
default ListAnalysesIterable |
listAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
|
default ListAnalysesIterable |
listAnalysesPaginator(ListAnalysesRequest listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
|
default ListDashboardsResponse |
listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Lists dashboards in an Amazon Web Services account.
|
default ListDashboardsResponse |
listDashboards(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an Amazon Web Services account.
|
default ListDashboardsIterable |
listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Lists dashboards in an Amazon Web Services account.
|
default ListDashboardsIterable |
listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an Amazon Web Services account.
|
default ListDashboardVersionsResponse |
listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
|
default ListDashboardVersionsResponse |
listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
|
default ListDashboardVersionsIterable |
listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
|
default ListDashboardVersionsIterable |
listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
|
default ListDataSetsResponse |
listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
|
default ListDataSetsResponse |
listDataSets(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
|
default ListDataSetsIterable |
listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
|
default ListDataSetsIterable |
listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
|
default ListDataSourcesResponse |
listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
|
default ListDataSourcesResponse |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
|
default ListDataSourcesIterable |
listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
|
default ListDataSourcesIterable |
listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
|
default ListFolderMembersResponse |
listFolderMembers(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest)
List all assets (
DASHBOARD , ANALYSIS , and DATASET ) in a folder. |
default ListFolderMembersResponse |
listFolderMembers(ListFolderMembersRequest listFolderMembersRequest)
List all assets (
DASHBOARD , ANALYSIS , and DATASET ) in a folder. |
default ListFoldersResponse |
listFolders(Consumer<ListFoldersRequest.Builder> listFoldersRequest)
Lists all folders in an account.
|
default ListFoldersResponse |
listFolders(ListFoldersRequest listFoldersRequest)
Lists all folders in an 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 Amazon Web Services account.
|
default ListNamespacesResponse |
listNamespaces(ListNamespacesRequest listNamespacesRequest)
Lists the namespaces for the specified Amazon Web Services account.
|
default ListNamespacesIterable |
listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)
Lists the namespaces for the specified Amazon Web Services account.
|
default ListNamespacesIterable |
listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest)
Lists the namespaces for the specified Amazon Web Services 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 Amazon Web Services account.
|
default ListThemesResponse |
listThemes(ListThemesRequest listThemesRequest)
Lists all the themes in the current Amazon Web Services account.
|
default ListThemesIterable |
listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest)
Lists all the themes in the current Amazon Web Services account.
|
default ListThemesIterable |
listThemesPaginator(ListThemesRequest listThemesRequest)
Lists all the themes in the current Amazon Web Services account.
|
default ListThemeVersionsResponse |
listThemeVersions(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)
Lists all the versions of the themes in the current Amazon Web Services account.
|
default ListThemeVersionsResponse |
listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest)
Lists all the versions of the themes in the current Amazon Web Services account.
|
default ListThemeVersionsIterable |
listThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)
Lists all the versions of the themes in the current Amazon Web Services account.
|
default ListThemeVersionsIterable |
listThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest)
Lists all the versions of the themes in the current Amazon Web Services 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 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 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.
|
default SearchDataSetsResponse |
searchDataSets(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest)
Use the
SearchDataSets operation to search for datasets that belong to an account. |
default SearchDataSetsResponse |
searchDataSets(SearchDataSetsRequest searchDataSetsRequest)
Use the
SearchDataSets operation to search for datasets that belong to an account. |
default SearchDataSetsIterable |
searchDataSetsPaginator(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest)
Use the
SearchDataSets operation to search for datasets that belong to an account. |
default SearchDataSetsIterable |
searchDataSetsPaginator(SearchDataSetsRequest searchDataSetsRequest)
Use the
SearchDataSets operation to search for datasets that belong to an account. |
default SearchDataSourcesResponse |
searchDataSources(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest)
Use the
SearchDataSources operation to search for data sources that belong to an account. |
default SearchDataSourcesResponse |
searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest)
Use the
SearchDataSources operation to search for data sources that belong to an account. |
default SearchDataSourcesIterable |
searchDataSourcesPaginator(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest)
Use the
SearchDataSources operation to search for data sources that belong to an account. |
default SearchDataSourcesIterable |
searchDataSourcesPaginator(SearchDataSourcesRequest searchDataSourcesRequest)
Use the
SearchDataSources operation to search for data sources that belong to an account. |
default SearchFoldersResponse |
searchFolders(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest)
Searches the subfolders in a folder.
|
default SearchFoldersResponse |
searchFolders(SearchFoldersRequest searchFoldersRequest)
Searches the subfolders in a folder.
|
default SearchGroupsResponse |
searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest)
Use the
SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters. |
default SearchGroupsResponse |
searchGroups(SearchGroupsRequest searchGroupsRequest)
Use the
SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters. |
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon 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 for the current Amazon Web Services Region.
|
default UpdateAccountCustomizationResponse |
updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest)
Updates Amazon QuickSight customizations for the current Amazon Web Services Region.
|
default UpdateAccountSettingsResponse |
updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)
Updates the Amazon QuickSight settings in your Amazon Web Services account.
|
default UpdateAccountSettingsResponse |
updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the Amazon QuickSight settings in your Amazon Web Services 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 Amazon Web Services account.
|
default UpdateDashboardResponse |
updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates a dashboard in an Amazon Web Services 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 UpdateFolderResponse |
updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest)
Updates the name of a folder.
|
default UpdateFolderResponse |
updateFolder(UpdateFolderRequest updateFolderRequest)
Updates the name of a folder.
|
default UpdateFolderPermissionsResponse |
updateFolderPermissions(Consumer<UpdateFolderPermissionsRequest.Builder> updateFolderPermissionsRequest)
Updates permissions of a folder.
|
default UpdateFolderPermissionsResponse |
updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest)
Updates permissions of a folder.
|
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 UpdateIpRestrictionResponse |
updateIpRestriction(Consumer<UpdateIpRestrictionRequest.Builder> updateIpRestrictionRequest)
Updates the content and status of IP rules.
|
default UpdateIpRestrictionResponse |
updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest)
Updates the content and status of IP rules.
|
default UpdatePublicSharingSettingsResponse |
updatePublicSharingSettings(Consumer<UpdatePublicSharingSettingsRequest.Builder> updatePublicSharingSettingsRequest)
Use the
UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of
an Amazon QuickSight dashboard. |
default UpdatePublicSharingSettingsResponse |
updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest)
Use the
UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of
an Amazon QuickSight dashboard. |
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
.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
credentials.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
credentials.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, ConflictException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a
custom default theme by using the CreateAccountCustomization
or
UpdateAccountCustomization
API operation. To further customize Amazon QuickSight by removing Amazon
QuickSight sample assets and videos for all new users, see Customizing Amazon
QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services 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 Amazon Web Services 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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.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, ConflictException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a
custom default theme by using the CreateAccountCustomization
or
UpdateAccountCustomization
API operation. To further customize Amazon QuickSight by removing Amazon
QuickSight sample assets and videos for all new users, see Customizing Amazon
QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services 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 Amazon Web Services 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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.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 CreateAccountSubscriptionResponse createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, PreconditionNotMetException, ConflictException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe
and CreateAccountSubscription
actions,
make sure that both actions are set to Allow
. If either action is set to Deny
, the
Deny
action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
createAccountSubscriptionRequest
- 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
credentials.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.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 CreateAccountSubscriptionResponse createAccountSubscription(Consumer<CreateAccountSubscriptionRequest.Builder> createAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, PreconditionNotMetException, ConflictException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe
and CreateAccountSubscription
actions,
make sure that both actions are set to Allow
. If either action is set to Deny
, the
Deny
action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
This is a convenience which creates an instance of the CreateAccountSubscriptionRequest.Builder
avoiding
the need to create one manually via CreateAccountSubscriptionRequest.builder()
createAccountSubscriptionRequest
- A Consumer
that will call methods on CreateAccountSubscriptionRequest.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
credentials.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.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 CreateAnalysisResponse createAnalysis(CreateAnalysisRequest createAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition
.
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 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 CreateAnalysisResponse createAnalysis(Consumer<CreateAnalysisRequest.Builder> createAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition
.
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 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 CreateDashboardResponse createDashboard(CreateDashboardRequest createDashboardRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dashboard from either a template or directly with a DashboardDefinition
. To first create a
template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon 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 Amazon Web Services 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 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 CreateDashboardResponse createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dashboard from either a template or directly with a DashboardDefinition
. To first create a
template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon 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 Amazon Web Services 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 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 CreateDataSetResponse createDataSet(CreateDataSetRequest createDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
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
credentials.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 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 operation doesn't support datasets that include uploaded files as a source.
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
credentials.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 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
credentials.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
credentials.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 CreateFolderResponse createFolder(CreateFolderRequest createFolderRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, AccessDeniedException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an empty shared folder.
createFolderRequest
- 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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.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
credentials.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 CreateFolderResponse createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, AccessDeniedException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an empty shared folder.
This is a convenience which creates an instance of the CreateFolderRequest.Builder
avoiding the need to
create one manually via CreateFolderRequest.builder()
createFolderRequest
- A Consumer
that will call methods on CreateFolderRequest.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.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
credentials.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 CreateFolderMembershipResponse createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembershipRequest
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.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 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 CreateFolderMembershipResponse createFolderMembership(Consumer<CreateFolderMembershipRequest.Builder> createFolderMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
This is a convenience which creates an instance of the CreateFolderMembershipRequest.Builder
avoiding the
need to create one manually via CreateFolderMembershipRequest.builder()
createFolderMembershipRequest
- A Consumer
that will call methods on CreateFolderMembershipRequest.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.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 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 CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the CreateGroup
operation to create a group in Amazon QuickSight. You can create up to 10,000
groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<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
credentials.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
Use the CreateGroup
operation to create a group in Amazon QuickSight. You can create up to 10,000
groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<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
credentials.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
credentials.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
credentials.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 Amazon Web Services 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
credentials.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 Amazon Web Services 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
credentials.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 for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
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 Amazon Web Services 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
credentials.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 for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
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 Amazon Web Services 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
credentials.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 Amazon 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 Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services 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
credentials.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 Amazon 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 Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services 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
credentials.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 either from a TemplateDefinition
or from an existing Amazon QuickSight analysis
or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon 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
credentials.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 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 either from a TemplateDefinition
or from an existing Amazon QuickSight analysis
or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon 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
credentials.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 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 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 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
credentials.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 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
credentials.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 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 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 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, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon 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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon 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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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 DeleteAccountSubscriptionResponse deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the DeleteAccountSubscription
operation to delete an Amazon QuickSight account. This operation
will result in an error message if you have configured your account termination protection settings to
True
. To change this setting and delete your account, call the UpdateAccountSettings
API and set the value of the TerminationProtectionEnabled
parameter to False
, then make
another call to the DeleteAccountSubscription
API.
deleteAccountSubscriptionRequest
- 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
credentials.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 DeleteAccountSubscriptionResponse deleteAccountSubscription(Consumer<DeleteAccountSubscriptionRequest.Builder> deleteAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the DeleteAccountSubscription
operation to delete an Amazon QuickSight account. This operation
will result in an error message if you have configured your account termination protection settings to
True
. To change this setting and delete your account, call the UpdateAccountSettings
API and set the value of the TerminationProtectionEnabled
parameter to False
, then make
another call to the DeleteAccountSubscription
API.
This is a convenience which creates an instance of the DeleteAccountSubscriptionRequest.Builder
avoiding
the need to create one manually via DeleteAccountSubscriptionRequest.builder()
deleteAccountSubscriptionRequest
- A Consumer
that will call methods on DeleteAccountSubscriptionRequest.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
credentials.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 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. Amazon
QuickSight attaches a DeletionTime
stamp to the response that specifies the end of the recovery
window. At the end of the recovery window, Amazon 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 Amazon 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 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. Amazon
QuickSight attaches a DeletionTime
stamp to the response that specifies the end of the recovery
window. At the end of the recovery window, Amazon 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 Amazon 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 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 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 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
credentials.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
credentials.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
credentials.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
credentials.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 DeleteFolderResponse deleteFolder(DeleteFolderRequest deleteFolderRequest) throws InvalidParameterValueException, PreconditionNotMetException, AccessDeniedException, ResourceNotFoundException, ConflictException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an empty folder.
deleteFolderRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.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
credentials.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.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 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 DeleteFolderResponse deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest) throws InvalidParameterValueException, PreconditionNotMetException, AccessDeniedException, ResourceNotFoundException, ConflictException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an empty folder.
This is a convenience which creates an instance of the DeleteFolderRequest.Builder
avoiding the need to
create one manually via DeleteFolderRequest.builder()
deleteFolderRequest
- A Consumer
that will call methods on DeleteFolderRequest.Builder
to create a request.InvalidParameterValueException
- One or more parameters has a value that isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.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
credentials.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.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 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 DeleteFolderMembershipResponse deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembershipRequest
- 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
credentials.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 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 DeleteFolderMembershipResponse deleteFolderMembership(Consumer<DeleteFolderMembershipRequest.Builder> deleteFolderMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
This is a convenience which creates an instance of the DeleteFolderMembershipRequest.Builder
avoiding the
need to create one manually via DeleteFolderMembershipRequest.builder()
deleteFolderMembershipRequest
- A Consumer
that will call methods on DeleteFolderMembershipRequest.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
credentials.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 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 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
credentials.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
credentials.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
credentials.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
credentials.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
credentials.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
credentials.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
credentials.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
credentials.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 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 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 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 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
credentials.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 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
credentials.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 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 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 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 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
credentials.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 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
credentials.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
credentials.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
credentials.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 Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region. The Amazon 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.
Amazon Web Services account
- The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's
where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services
Region.
Amazon Web Services Region
- In each Amazon Web Services Region where you sign in to Amazon
QuickSight at least once, Amazon 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 Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default Amazon Web Services Region. Use Enter to key the same
settings for your keys. For more information, see Configuring the 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 Amazon Web Services account and Amazon Web Services Region.
Applied customizations
- Within an Amazon Web Services Region, a set of Amazon QuickSight
customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a
namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a
single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the
CreateAccountCustomization
command in each Amazon Web Services 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
credentials.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 Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region. The Amazon 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.
Amazon Web Services account
- The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's
where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services
Region.
Amazon Web Services Region
- In each Amazon Web Services Region where you sign in to Amazon
QuickSight at least once, Amazon 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 Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default Amazon Web Services Region. Use Enter to key the same
settings for your keys. For more information, see Configuring the 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 Amazon Web Services account and Amazon Web Services Region.
Applied customizations
- Within an Amazon Web Services Region, a set of Amazon QuickSight
customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a
namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a
single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the
CreateAccountCustomization
command in each Amazon Web Services 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
credentials.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 Amazon QuickSight subscription was first created in this Amazon Web Services 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
credentials.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 Amazon QuickSight subscription was first created in this Amazon Web Services 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
credentials.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 DescribeAccountSubscriptionResponse describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's
subscription. A successful API call returns an AccountInfo
object that includes an account's name,
subscription status, authentication type, edition, and notification email address.
describeAccountSubscriptionRequest
- 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
credentials.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 DescribeAccountSubscriptionResponse describeAccountSubscription(Consumer<DescribeAccountSubscriptionRequest.Builder> describeAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's
subscription. A successful API call returns an AccountInfo
object that includes an account's name,
subscription status, authentication type, edition, and notification email address.
This is a convenience which creates an instance of the DescribeAccountSubscriptionRequest.Builder
avoiding the need to create one manually via DescribeAccountSubscriptionRequest.builder()
describeAccountSubscriptionRequest
- A Consumer
that will call methods on DescribeAccountSubscriptionRequest.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
credentials.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
credentials.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 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
credentials.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 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 DescribeAnalysisDefinitionResponse describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the
status of a recently created or updated Analysis, use the
DescribeAnalysis
instead.
describeAnalysisDefinitionRequest
- 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
credentials.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 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 DescribeAnalysisDefinitionResponse describeAnalysisDefinition(Consumer<DescribeAnalysisDefinitionRequest.Builder> describeAnalysisDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the
status of a recently created or updated Analysis, use the
DescribeAnalysis
instead.
This is a convenience which creates an instance of the DescribeAnalysisDefinitionRequest.Builder
avoiding
the need to create one manually via DescribeAnalysisDefinitionRequest.builder()
describeAnalysisDefinitionRequest
- A Consumer
that will call methods on DescribeAnalysisDefinitionRequest.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
credentials.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 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 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 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
credentials.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 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
credentials.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 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 DescribeDashboardDefinitionResponse describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the
status of a recently created or updated dashboard, use the
DescribeDashboard
instead.
describeDashboardDefinitionRequest
- 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
credentials.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 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 DescribeDashboardDefinitionResponse describeDashboardDefinition(Consumer<DescribeDashboardDefinitionRequest.Builder> describeDashboardDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the
status of a recently created or updated dashboard, use the
DescribeDashboard
instead.
This is a convenience which creates an instance of the DescribeDashboardDefinitionRequest.Builder
avoiding the need to create one manually via DescribeDashboardDefinitionRequest.builder()
describeDashboardDefinitionRequest
- A Consumer
that will call methods on DescribeDashboardDefinitionRequest.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
credentials.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 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 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 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. This operation doesn't support datasets that include uploaded files as a source.
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
credentials.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 operation doesn't support datasets that include uploaded files as a source.
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
credentials.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
credentials.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
credentials.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
credentials.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
credentials.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
credentials.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
credentials.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 DescribeFolderResponse describeFolder(DescribeFolderRequest describeFolderRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a folder.
describeFolderRequest
- 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
credentials.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 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 DescribeFolderResponse describeFolder(Consumer<DescribeFolderRequest.Builder> describeFolderRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a folder.
This is a convenience which creates an instance of the DescribeFolderRequest.Builder
avoiding the need to
create one manually via DescribeFolderRequest.builder()
describeFolderRequest
- A Consumer
that will call methods on DescribeFolderRequest.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
credentials.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 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 DescribeFolderPermissionsResponse describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes permissions for a folder.
describeFolderPermissionsRequest
- 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
credentials.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 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 DescribeFolderPermissionsResponse describeFolderPermissions(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes permissions for a folder.
This is a convenience which creates an instance of the DescribeFolderPermissionsRequest.Builder
avoiding
the need to create one manually via DescribeFolderPermissionsRequest.builder()
describeFolderPermissionsRequest
- A Consumer
that will call methods on DescribeFolderPermissionsRequest.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
credentials.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 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 DescribeFolderResolvedPermissionsResponse describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissionsRequest
- 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
credentials.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 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 DescribeFolderResolvedPermissionsResponse describeFolderResolvedPermissions(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
This is a convenience which creates an instance of the DescribeFolderResolvedPermissionsRequest.Builder
avoiding the need to create one manually via DescribeFolderResolvedPermissionsRequest.builder()
describeFolderResolvedPermissionsRequest
- A Consumer
that will call methods on DescribeFolderResolvedPermissionsRequest.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
credentials.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 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 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
credentials.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
credentials.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 DescribeGroupMembershipResponse describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the DescribeGroupMembership
operation to determine if a user is a member of the specified group.
If the user exists and is a member of the specified group, an associated GroupMember
object is
returned.
describeGroupMembershipRequest
- 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
credentials.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 DescribeGroupMembershipResponse describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the DescribeGroupMembership
operation to determine if a user is a member of the specified group.
If the user exists and is a member of the specified group, an associated GroupMember
object is
returned.
This is a convenience which creates an instance of the DescribeGroupMembershipRequest.Builder
avoiding
the need to create one manually via DescribeGroupMembershipRequest.builder()
describeGroupMembershipRequest
- A Consumer
that will call methods on DescribeGroupMembershipRequest.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
credentials.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
credentials.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
credentials.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
credentials.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
credentials.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 DescribeIpRestrictionResponse describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary and status of IP rules.
describeIpRestrictionRequest
- 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
credentials.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 DescribeIpRestrictionResponse describeIpRestriction(Consumer<DescribeIpRestrictionRequest.Builder> describeIpRestrictionRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary and status of IP rules.
This is a convenience which creates an instance of the DescribeIpRestrictionRequest.Builder
avoiding the
need to create one manually via DescribeIpRestrictionRequest.builder()
describeIpRestrictionRequest
- A Consumer
that will call methods on DescribeIpRestrictionRequest.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
credentials.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 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
credentials.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
credentials.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
credentials.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 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
credentials.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 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 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 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 DescribeTemplateDefinitionResponse describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the
status of a recently created or updated template, use the
DescribeTemplate
instead.
describeTemplateDefinitionRequest
- 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
credentials.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 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 DescribeTemplateDefinitionResponse describeTemplateDefinition(Consumer<DescribeTemplateDefinitionRequest.Builder> describeTemplateDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the
status of a recently created or updated template, use the
DescribeTemplate
instead.
This is a convenience which creates an instance of the DescribeTemplateDefinitionRequest.Builder
avoiding
the need to create one manually via DescribeTemplateDefinitionRequest.builder()
describeTemplateDefinitionRequest
- A Consumer
that will call methods on DescribeTemplateDefinitionRequest.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
credentials.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 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 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 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
credentials.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 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
credentials.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 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 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 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
credentials.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 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
credentials.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 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
credentials.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
credentials.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 GenerateEmbedUrlForAnonymousUserResponse generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default
session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForAnonymousUserRequest
- 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
credentials.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.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 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 Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon 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 GenerateEmbedUrlForAnonymousUserResponse generateEmbedUrlForAnonymousUser(Consumer<GenerateEmbedUrlForAnonymousUserRequest.Builder> generateEmbedUrlForAnonymousUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default
session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
This is a convenience which creates an instance of the GenerateEmbedUrlForAnonymousUserRequest.Builder
avoiding the need to create one manually via GenerateEmbedUrlForAnonymousUserRequest.builder()
generateEmbedUrlForAnonymousUserRequest
- A Consumer
that will call methods on GenerateEmbedUrlForAnonymousUserRequest.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
credentials.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.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 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 Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon 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 GenerateEmbedUrlForRegisteredUserResponse generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest) throws AccessDeniedException, InvalidParameterValueException, QuickSightUserNotFoundException, ResourceNotFoundException, SessionLifetimeInMinutesInvalidException, ThrottlingException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForRegisteredUserRequest
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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.ResourceNotFoundException
- One or more resources can't be found.SessionLifetimeInMinutesInvalidException
- The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.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 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 Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon 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 GenerateEmbedUrlForRegisteredUserResponse generateEmbedUrlForRegisteredUser(Consumer<GenerateEmbedUrlForRegisteredUserRequest.Builder> generateEmbedUrlForRegisteredUserRequest) throws AccessDeniedException, InvalidParameterValueException, QuickSightUserNotFoundException, ResourceNotFoundException, SessionLifetimeInMinutesInvalidException, ThrottlingException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
This is a convenience which creates an instance of the GenerateEmbedUrlForRegisteredUserRequest.Builder
avoiding the need to create one manually via GenerateEmbedUrlForRegisteredUserRequest.builder()
generateEmbedUrlForRegisteredUserRequest
- A Consumer
that will call methods on GenerateEmbedUrlForRegisteredUserRequest.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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.ResourceNotFoundException
- One or more resources can't be found.SessionLifetimeInMinutesInvalidException
- The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.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 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 Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon 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(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, DomainNotWhitelistedException, QuickSightUserNotFoundException, IdentityTypeNotSupportedException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. 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 generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutes
parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
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
credentials.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 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 Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon 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 temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. 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 generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutes
parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
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
credentials.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 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 Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon 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 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 Amazon
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
credentials.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 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 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 Amazon
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
credentials.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 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 Amazon Web Services 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 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 Amazon Web Services 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 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 Amazon Web Services 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 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 Amazon Web Services 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 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 Amazon 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 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 Amazon QuickSight subscription.
This is a convenience which creates an instance of the ListDashboardVersionsRequest.Builder
avoiding the
need to create one manually via ListDashboardVersionsRequest.builder()
listDashboardVersionsRequest
- A Consumer
that will call methods on ListDashboardVersionsRequest.Builder
to create a
request.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListDashboardVersionsIterable listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client .listDashboardVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation.
listDashboardVersionsRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListDashboardVersionsIterable listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client .listDashboardVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation.
This is a convenience which creates an instance of the ListDashboardVersionsRequest.Builder
avoiding the
need to create one manually via ListDashboardVersionsRequest.builder()
listDashboardVersionsRequest
- A Consumer
that will call methods on ListDashboardVersionsRequest.Builder
to create a
request.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an Amazon Web Services account.
listDashboardsRequest
- ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an Amazon Web Services account.
This is a convenience which creates an instance of the ListDashboardsRequest.Builder
avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest
- A Consumer
that will call methods on ListDashboardsRequest.Builder
to create a request.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an Amazon Web Services account.
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client .listDashboardsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation.
listDashboardsRequest
- ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an Amazon Web Services account.
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client .listDashboardsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation.
This is a convenience which creates an instance of the ListDashboardsRequest.Builder
avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest
- A Consumer
that will call methods on ListDashboardsRequest.Builder
to create a request.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListDataSetsResponse listDataSets(ListDataSetsRequest listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
.
listDataSetsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDataSetsResponse listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
.
This is a convenience which creates an instance of the ListDataSetsRequest.Builder
avoiding the need to
create one manually via ListDataSetsRequest.builder()
listDataSetsRequest
- A Consumer
that will call methods on ListDataSetsRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDataSetsIterable listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
.
This is a variant of listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation.
listDataSetsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDataSetsIterable listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
.
This is a variant of listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation.
This is a convenience which creates an instance of the ListDataSetsRequest.Builder
avoiding the need to
create one manually via ListDataSetsRequest.builder()
listDataSetsRequest
- A Consumer
that will call methods on ListDataSetsRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
listDataSourcesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder
avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest
- A Consumer
that will call methods on ListDataSourcesRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation.
listDataSourcesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder
avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest
- A Consumer
that will call methods on ListDataSourcesRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFolderMembersResponse listFolderMembers(ListFolderMembersRequest listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
List all assets (DASHBOARD
, ANALYSIS
, and DATASET
) in a folder.
listFolderMembersRequest
- 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
credentials.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 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 ListFolderMembersResponse listFolderMembers(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
List all assets (DASHBOARD
, ANALYSIS
, and DATASET
) in a folder.
This is a convenience which creates an instance of the ListFolderMembersRequest.Builder
avoiding the need
to create one manually via ListFolderMembersRequest.builder()
listFolderMembersRequest
- A Consumer
that will call methods on ListFolderMembersRequest.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
credentials.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 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 ListFoldersResponse listFolders(ListFoldersRequest listFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all folders in an account.
listFoldersRequest
- 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
credentials.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 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 ListFoldersResponse listFolders(Consumer<ListFoldersRequest.Builder> listFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all folders in an account.
This is a convenience which creates an instance of the ListFoldersRequest.Builder
avoiding the need to
create one manually via ListFoldersRequest.builder()
listFoldersRequest
- A Consumer
that will call methods on ListFoldersRequest.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
credentials.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 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 ListGroupMembershipsResponse listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists member users in a group.
listGroupMembershipsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupMembershipsResponse listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists member users in a group.
This is a convenience which creates an instance of the ListGroupMembershipsRequest.Builder
avoiding the
need to create one manually via ListGroupMembershipsRequest.builder()
listGroupMembershipsRequest
- A Consumer
that will call methods on ListGroupMembershipsRequest.Builder
to create a
request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists all user groups in Amazon QuickSight.
listGroupsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists all user groups in Amazon QuickSight.
This is a convenience which creates an instance of the ListGroupsRequest.Builder
avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest
- A Consumer
that will call methods on ListGroupsRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIamPolicyAssignmentsResponse listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists IAM policy assignments in the current Amazon QuickSight account.
listIamPolicyAssignmentsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 ListIamPolicyAssignmentsResponse listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists IAM policy assignments in the current Amazon QuickSight account.
This is a convenience which creates an instance of the ListIamPolicyAssignmentsRequest.Builder
avoiding
the need to create one manually via ListIamPolicyAssignmentsRequest.builder()
listIamPolicyAssignmentsRequest
- A Consumer
that will call methods on ListIAMPolicyAssignmentsRequest.Builder
to create a
request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 ListIamPolicyAssignmentsForUserResponse listIAMPolicyAssignmentsForUser(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
listIamPolicyAssignmentsForUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 ListIamPolicyAssignmentsForUserResponse listIAMPolicyAssignmentsForUser(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
This is a convenience which creates an instance of the ListIamPolicyAssignmentsForUserRequest.Builder
avoiding the need to create one manually via ListIamPolicyAssignmentsForUserRequest.builder()
listIamPolicyAssignmentsForUserRequest
- A Consumer
that will call methods on ListIAMPolicyAssignmentsForUserRequest.Builder
to
create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 ListIngestionsResponse listIngestions(ListIngestionsRequest listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset.
listIngestionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIngestionsResponse listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset.
This is a convenience which creates an instance of the ListIngestionsRequest.Builder
avoiding the need to
create one manually via ListIngestionsRequest.builder()
listIngestionsRequest
- A Consumer
that will call methods on ListIngestionsRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIngestionsIterable listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset.
This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client .listIngestionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation.
listIngestionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIngestionsIterable listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset.
This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client .listIngestionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation.
This is a convenience which creates an instance of the ListIngestionsRequest.Builder
avoiding the need to
create one manually via ListIngestionsRequest.builder()
listIngestionsRequest
- A Consumer
that will call methods on ListIngestionsRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNamespacesResponse listNamespaces(ListNamespacesRequest listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
listNamespacesRequest
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNamespacesResponse listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
This is a convenience which creates an instance of the ListNamespacesRequest.Builder
avoiding the need to
create one manually via ListNamespacesRequest.builder()
listNamespacesRequest
- A Consumer
that will call methods on ListNamespacesRequest.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNamespacesIterable listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
This is a variant of
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
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.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client .listNamespacesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(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
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
operation.
listNamespacesRequest
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNamespacesIterable listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
This is a variant of
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
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.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client .listNamespacesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(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
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
operation.
This is a convenience which creates an instance of the ListNamespacesRequest.Builder
avoiding the need to
create one manually via ListNamespacesRequest.builder()
listNamespacesRequest
- A Consumer
that will call methods on ListNamespacesRequest.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the tags assigned to a resource.
listTagsForResourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the tags assigned to a resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTemplateAliasesResponse listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
listTemplateAliasesRequest
- InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListTemplateAliasesResponse listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
This is a convenience which creates an instance of the ListTemplateAliasesRequest.Builder
avoiding the
need to create one manually via ListTemplateAliasesRequest.builder()
listTemplateAliasesRequest
- A Consumer
that will call methods on ListTemplateAliasesRequest.Builder
to create a
request.InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListTemplateAliasesIterable listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client .listTemplateAliasesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation.
listTemplateAliasesRequest
- InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListTemplateAliasesIterable listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client .listTemplateAliasesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation.
This is a convenience which creates an instance of the ListTemplateAliasesRequest.Builder
avoiding the
need to create one manually via ListTemplateAliasesRequest.builder()
listTemplateAliasesRequest
- A Consumer
that will call methods on ListTemplateAliasesRequest.Builder
to create a
request.InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListTemplateVersionsResponse listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
listTemplateVersionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListTemplateVersionsResponse listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
This is a convenience which creates an instance of the ListTemplateVersionsRequest.Builder
avoiding the
need to create one manually via ListTemplateVersionsRequest.builder()
listTemplateVersionsRequest
- A Consumer
that will call methods on ListTemplateVersionsRequest.Builder
to create a
request.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListTemplateVersionsIterable listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client .listTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation.
listTemplateVersionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListTemplateVersionsIterable listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client .listTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation.
This is a convenience which creates an instance of the ListTemplateVersionsRequest.Builder
avoiding the
need to create one manually via ListTemplateVersionsRequest.builder()
listTemplateVersionsRequest
- A Consumer
that will call methods on ListTemplateVersionsRequest.Builder
to create a
request.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListTemplatesResponse listTemplates(ListTemplatesRequest listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
listTemplatesRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListTemplatesResponse listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
This is a convenience which creates an instance of the ListTemplatesRequest.Builder
avoiding the need to
create one manually via ListTemplatesRequest.builder()
listTemplatesRequest
- A Consumer
that will call methods on ListTemplatesRequest.Builder
to create a request.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListTemplatesIterable listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client .listTemplatesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation.
listTemplatesRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListTemplatesIterable listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client .listTemplatesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation.
This is a convenience which creates an instance of the ListTemplatesRequest.Builder
avoiding the need to
create one manually via ListTemplatesRequest.builder()
listTemplatesRequest
- A Consumer
that will call methods on ListTemplatesRequest.Builder
to create a request.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 ListThemeAliasesResponse listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest) throws ConflictException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a theme.
listThemeAliasesRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListThemeAliasesResponse listThemeAliases(Consumer<ListThemeAliasesRequest.Builder> listThemeAliasesRequest) throws ConflictException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a theme.
This is a convenience which creates an instance of the ListThemeAliasesRequest.Builder
avoiding the need
to create one manually via ListThemeAliasesRequest.builder()
listThemeAliasesRequest
- A Consumer
that will call methods on ListThemeAliasesRequest.Builder
to create a request.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListThemeVersionsResponse listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the themes in the current Amazon Web Services account.
listThemeVersionsRequest
- 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
credentials.InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListThemeVersionsResponse listThemeVersions(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the themes in the current Amazon Web Services account.
This is a convenience which creates an instance of the ListThemeVersionsRequest.Builder
avoiding the need
to create one manually via ListThemeVersionsRequest.builder()
listThemeVersionsRequest
- A Consumer
that will call methods on ListThemeVersionsRequest.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
credentials.InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListThemeVersionsIterable listThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the themes in the current Amazon Web Services account.
This is a variant of
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
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.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client .listThemeVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(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
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
operation.
listThemeVersionsRequest
- 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
credentials.InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListThemeVersionsIterable listThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the themes in the current Amazon Web Services account.
This is a variant of
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
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.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client .listThemeVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(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
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
operation.
This is a convenience which creates an instance of the ListThemeVersionsRequest.Builder
avoiding the need
to create one manually via ListThemeVersionsRequest.builder()
listThemeVersionsRequest
- A Consumer
that will call methods on ListThemeVersionsRequest.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
credentials.InvalidNextTokenException
- The NextToken
value isn't valid.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 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 ListThemesResponse listThemes(ListThemesRequest listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the themes in the current Amazon Web Services account.
listThemesRequest
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.InvalidNextTokenException
- The NextToken
value 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 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 ListThemesResponse listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the themes in the current Amazon Web Services account.
This is a convenience which creates an instance of the ListThemesRequest.Builder
avoiding the need to
create one manually via ListThemesRequest.builder()
listThemesRequest
- A Consumer
that will call methods on ListThemesRequest.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.InvalidNextTokenException
- The NextToken
value 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 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 ListThemesIterable listThemesPaginator(ListThemesRequest listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the themes in the current Amazon Web Services account.
This is a variant of listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
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.ListThemesIterable responses = client.listThemesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListThemesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(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
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
operation.
listThemesRequest
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.InvalidNextTokenException
- The NextToken
value 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 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 ListThemesIterable listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the themes in the current Amazon Web Services account.
This is a variant of listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
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.ListThemesIterable responses = client.listThemesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListThemesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(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
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
operation.
This is a convenience which creates an instance of the ListThemesRequest.Builder
avoiding the need to
create one manually via ListThemesRequest.builder()
listThemesRequest
- A Consumer
that will call methods on ListThemesRequest.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.InvalidNextTokenException
- The NextToken
value 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 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 ListUserGroupsResponse listUserGroups(ListUserGroupsRequest listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
listUserGroupsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 ListUserGroupsResponse listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
This is a convenience which creates an instance of the ListUserGroupsRequest.Builder
avoiding the need to
create one manually via ListUserGroupsRequest.builder()
listUserGroupsRequest
- A Consumer
that will call methods on ListUserGroupsRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns a list of all of the Amazon QuickSight users belonging to this account.
listUsersRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns a list of all of the Amazon QuickSight users belonging to this account.
This is a convenience which creates an instance of the ListUsersRequest.Builder
avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest
- A Consumer
that will call methods on ListUsersRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterUserResponse registerUser(RegisterUserRequest registerUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
registerUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterUserResponse registerUser(Consumer<RegisterUserRequest.Builder> registerUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
This is a convenience which creates an instance of the RegisterUserRequest.Builder
avoiding the need to
create one manually via RegisterUserRequest.builder()
registerUserRequest
- A Consumer
that will call methods on RegisterUserRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreAnalysisResponse restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Restores an analysis.
restoreAnalysisRequest
- 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 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 RestoreAnalysisResponse restoreAnalysis(Consumer<RestoreAnalysisRequest.Builder> restoreAnalysisRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Restores an analysis.
This is a convenience which creates an instance of the RestoreAnalysisRequest.Builder
avoiding the need
to create one manually via RestoreAnalysisRequest.builder()
restoreAnalysisRequest
- A Consumer
that will call methods on RestoreAnalysisRequest.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 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 SearchAnalysesResponse searchAnalyses(SearchAnalysesRequest searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchAnalysesRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchAnalysesResponse searchAnalyses(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the SearchAnalysesRequest.Builder
avoiding the need to
create one manually via SearchAnalysesRequest.builder()
searchAnalysesRequest
- A Consumer
that will call methods on SearchAnalysesRequest.Builder
to create a request.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchAnalysesIterable searchAnalysesPaginator(SearchAnalysesRequest searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a variant of
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
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.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client .searchAnalysesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(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
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
operation.
searchAnalysesRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchAnalysesIterable searchAnalysesPaginator(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a variant of
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
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.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client .searchAnalysesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(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
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
operation.
This is a convenience which creates an instance of the SearchAnalysesRequest.Builder
avoiding the need to
create one manually via SearchAnalysesRequest.builder()
searchAnalysesRequest
- A Consumer
that will call methods on SearchAnalysesRequest.Builder
to create a request.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchDashboardsResponse searchDashboards(SearchDashboardsRequest searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchDashboardsRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchDashboardsResponse searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the SearchDashboardsRequest.Builder
avoiding the need
to create one manually via SearchDashboardsRequest.builder()
searchDashboardsRequest
- A Consumer
that will call methods on SearchDashboardsRequest.Builder
to create a request.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchDashboardsIterable searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client .searchDashboardsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.
searchDashboardsRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchDashboardsIterable searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client .searchDashboardsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.
This is a convenience which creates an instance of the SearchDashboardsRequest.Builder
avoiding the need
to create one manually via SearchDashboardsRequest.builder()
searchDashboardsRequest
- A Consumer
that will call methods on SearchDashboardsRequest.Builder
to create a request.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchDataSetsResponse searchDataSets(SearchDataSetsRequest searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchDataSets
operation to search for datasets that belong to an account.
searchDataSetsRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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
credentials.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 SearchDataSetsResponse searchDataSets(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchDataSets
operation to search for datasets that belong to an account.
This is a convenience which creates an instance of the SearchDataSetsRequest.Builder
avoiding the need to
create one manually via SearchDataSetsRequest.builder()
searchDataSetsRequest
- A Consumer
that will call methods on SearchDataSetsRequest.Builder
to create a request.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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
credentials.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 SearchDataSetsIterable searchDataSetsPaginator(SearchDataSetsRequest searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchDataSets
operation to search for datasets that belong to an account.
This is a variant of
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
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.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client .searchDataSetsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(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
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
operation.
searchDataSetsRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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
credentials.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 SearchDataSetsIterable searchDataSetsPaginator(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchDataSets
operation to search for datasets that belong to an account.
This is a variant of
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
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.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client .searchDataSetsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(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
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
operation.
This is a convenience which creates an instance of the SearchDataSetsRequest.Builder
avoiding the need to
create one manually via SearchDataSetsRequest.builder()
searchDataSetsRequest
- A Consumer
that will call methods on SearchDataSetsRequest.Builder
to create a request.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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
credentials.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 SearchDataSourcesResponse searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchDataSources
operation to search for data sources that belong to an account.
searchDataSourcesRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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
credentials.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 SearchDataSourcesResponse searchDataSources(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchDataSources
operation to search for data sources that belong to an account.
This is a convenience which creates an instance of the SearchDataSourcesRequest.Builder
avoiding the need
to create one manually via SearchDataSourcesRequest.builder()
searchDataSourcesRequest
- A Consumer
that will call methods on SearchDataSourcesRequest.Builder
to create a request.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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
credentials.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 SearchDataSourcesIterable searchDataSourcesPaginator(SearchDataSourcesRequest searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchDataSources
operation to search for data sources that belong to an account.
This is a variant of
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
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.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client .searchDataSourcesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(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
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
operation.
searchDataSourcesRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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
credentials.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 SearchDataSourcesIterable searchDataSourcesPaginator(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchDataSources
operation to search for data sources that belong to an account.
This is a variant of
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
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.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client .searchDataSourcesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(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
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
operation.
This is a convenience which creates an instance of the SearchDataSourcesRequest.Builder
avoiding the need
to create one manually via SearchDataSourcesRequest.builder()
searchDataSourcesRequest
- A Consumer
that will call methods on SearchDataSourcesRequest.Builder
to create a request.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.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
credentials.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 SearchFoldersResponse searchFolders(SearchFoldersRequest searchFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InvalidRequestException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches the subfolders in a folder.
searchFoldersRequest
- 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
credentials.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidRequestException
- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services
support.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 SearchFoldersResponse searchFolders(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InvalidRequestException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches the subfolders in a folder.
This is a convenience which creates an instance of the SearchFoldersRequest.Builder
avoiding the need to
create one manually via SearchFoldersRequest.builder()
searchFoldersRequest
- A Consumer
that will call methods on SearchFoldersRequest.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
credentials.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidRequestException
- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services
support.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 SearchGroupsResponse searchGroups(SearchGroupsRequest searchGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters.
searchGroupsRequest
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchGroupsResponse searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the SearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters.
This is a convenience which creates an instance of the SearchGroupsRequest.Builder
avoiding the need to
create one manually via SearchGroupsRequest.builder()
searchGroupsRequest
- A Consumer
that will call methods on SearchGroupsRequest.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource
operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
tagResourceRequest
- LimitExceededException
- A limit is exceeded.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource
operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.LimitExceededException
- A limit is exceeded.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes a tag or tags from a resource.
untagResourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes a tag or tags from a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateAccountCustomizationResponse updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon
QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an
Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization
API operation.
updateAccountCustomizationRequest
- 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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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 UpdateAccountCustomizationResponse updateAccountCustomization(Consumer<UpdateAccountCustomizationRequest.Builder> updateAccountCustomizationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon
QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an
Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization
API operation.
This is a convenience which creates an instance of the UpdateAccountCustomizationRequest.Builder
avoiding
the need to create one manually via UpdateAccountCustomizationRequest.builder()
updateAccountCustomizationRequest
- A Consumer
that will call methods on UpdateAccountCustomizationRequest.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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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 UpdateAccountSettingsResponse updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates the Amazon QuickSight settings in your Amazon Web Services account.
updateAccountSettingsRequest
- 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
credentials.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 UpdateAccountSettingsResponse updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates the Amazon QuickSight settings in your Amazon Web Services account.
This is a convenience which creates an instance of the UpdateAccountSettingsRequest.Builder
avoiding the
need to create one manually via UpdateAccountSettingsRequest.builder()
updateAccountSettingsRequest
- A Consumer
that will call methods on UpdateAccountSettingsRequest.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
credentials.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 UpdateAnalysisResponse updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an analysis in Amazon QuickSight
updateAnalysisRequest
- 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 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 UpdateAnalysisResponse updateAnalysis(Consumer<UpdateAnalysisRequest.Builder> updateAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an analysis in Amazon QuickSight
This is a convenience which creates an instance of the UpdateAnalysisRequest.Builder
avoiding the need to
create one manually via UpdateAnalysisRequest.builder()
updateAnalysisRequest
- A Consumer
that will call methods on UpdateAnalysisRequest.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 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 UpdateAnalysisPermissionsResponse updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the read and write permissions for an analysis.
updateAnalysisPermissionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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.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 UpdateAnalysisPermissionsResponse updateAnalysisPermissions(Consumer<UpdateAnalysisPermissionsRequest.Builder> updateAnalysisPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the read and write permissions for an analysis.
This is a convenience which creates an instance of the UpdateAnalysisPermissionsRequest.Builder
avoiding
the need to create one manually via UpdateAnalysisPermissionsRequest.builder()
updateAnalysisPermissionsRequest
- A Consumer
that will call methods on UpdateAnalysisPermissionsRequest.Builder
to create a
request.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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.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 UpdateDashboardResponse updateDashboard(UpdateDashboardRequest updateDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can
update the published version of a dashboard by using the
UpdateDashboardPublishedVersion
API operation.
updateDashboardRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateDashboardResponse updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can
update the published version of a dashboard by using the
UpdateDashboardPublishedVersion
API operation.
This is a convenience which creates an instance of the UpdateDashboardRequest.Builder
avoiding the need
to create one manually via UpdateDashboardRequest.builder()
updateDashboardRequest
- A Consumer
that will call methods on UpdateDashboardRequest.Builder
to create a request.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateDashboardPermissionsResponse updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates read and write permissions on a dashboard.
updateDashboardPermissionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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.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 UpdateDashboardPermissionsResponse updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates read and write permissions on a dashboard.
This is a convenience which creates an instance of the UpdateDashboardPermissionsRequest.Builder
avoiding
the need to create one manually via UpdateDashboardPermissionsRequest.builder()
updateDashboardPermissionsRequest
- A Consumer
that will call methods on UpdateDashboardPermissionsRequest.Builder
to create a
request.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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.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 UpdateDashboardPublishedVersionResponse updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest) throws InvalidParameterValueException, ThrottlingException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the published version of a dashboard.
updateDashboardPublishedVersionRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateDashboardPublishedVersionResponse updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest) throws InvalidParameterValueException, ThrottlingException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the published version of a dashboard.
This is a convenience which creates an instance of the UpdateDashboardPublishedVersionRequest.Builder
avoiding the need to create one manually via UpdateDashboardPublishedVersionRequest.builder()
updateDashboardPublishedVersionRequest
- A Consumer
that will call methods on UpdateDashboardPublishedVersionRequest.Builder
to
create a request.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateDataSetResponse updateDataSet(UpdateDataSetRequest updateDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
updateDataSetRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateDataSetResponse updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
This is a convenience which creates an instance of the UpdateDataSetRequest.Builder
avoiding the need to
create one manually via UpdateDataSetRequest.builder()
updateDataSetRequest
- A Consumer
that will call methods on UpdateDataSetRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateDataSetPermissionsResponse updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
updateDataSetPermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDataSetPermissionsResponse updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
This is a convenience which creates an instance of the UpdateDataSetPermissionsRequest.Builder
avoiding
the need to create one manually via UpdateDataSetPermissionsRequest.builder()
updateDataSetPermissionsRequest
- A Consumer
that will call methods on UpdateDataSetPermissionsRequest.Builder
to create a
request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a data source.
updateDataSourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a data source.
This is a convenience which creates an instance of the UpdateDataSourceRequest.Builder
avoiding the need
to create one manually via UpdateDataSourceRequest.builder()
updateDataSourceRequest
- A Consumer
that will call methods on UpdateDataSourceRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDataSourcePermissionsResponse updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions to a data source.
updateDataSourcePermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDataSourcePermissionsResponse updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions to a data source.
This is a convenience which creates an instance of the UpdateDataSourcePermissionsRequest.Builder
avoiding the need to create one manually via UpdateDataSourcePermissionsRequest.builder()
updateDataSourcePermissionsRequest
- A Consumer
that will call methods on UpdateDataSourcePermissionsRequest.Builder
to create
a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateFolderResponse updateFolder(UpdateFolderRequest updateFolderRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ConflictException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the name of a folder.
updateFolderRequest
- 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
credentials.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.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 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 UpdateFolderResponse updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ConflictException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the name of a folder.
This is a convenience which creates an instance of the UpdateFolderRequest.Builder
avoiding the need to
create one manually via UpdateFolderRequest.builder()
updateFolderRequest
- A Consumer
that will call methods on UpdateFolderRequest.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
credentials.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.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 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 UpdateFolderPermissionsResponse updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, LimitExceededException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates permissions of a folder.
updateFolderPermissionsRequest
- 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
credentials.LimitExceededException
- A limit is exceeded.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 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 UpdateFolderPermissionsResponse updateFolderPermissions(Consumer<UpdateFolderPermissionsRequest.Builder> updateFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, LimitExceededException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates permissions of a folder.
This is a convenience which creates an instance of the UpdateFolderPermissionsRequest.Builder
avoiding
the need to create one manually via UpdateFolderPermissionsRequest.builder()
updateFolderPermissionsRequest
- A Consumer
that will call methods on UpdateFolderPermissionsRequest.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
credentials.LimitExceededException
- A limit is exceeded.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 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 UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Changes a group description.
updateGroupRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Changes a group description.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder
avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest
- A Consumer
that will call methods on UpdateGroupRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 UpdateIamPolicyAssignmentResponse updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that
are specified in the request. This overwrites all of the users included in Identities
.
updateIamPolicyAssignmentRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 UpdateIamPolicyAssignmentResponse updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that
are specified in the request. This overwrites all of the users included in Identities
.
This is a convenience which creates an instance of the UpdateIamPolicyAssignmentRequest.Builder
avoiding
the need to create one manually via UpdateIamPolicyAssignmentRequest.builder()
updateIamPolicyAssignmentRequest
- A Consumer
that will call methods on UpdateIAMPolicyAssignmentRequest.Builder
to create a
request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 UpdateIpRestrictionResponse updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules.
You can use the DescribeIpRestriction
operation to get the current rule map.
updateIpRestrictionRequest
- LimitExceededException
- A limit is exceeded.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 UpdateIpRestrictionResponse updateIpRestriction(Consumer<UpdateIpRestrictionRequest.Builder> updateIpRestrictionRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules.
You can use the DescribeIpRestriction
operation to get the current rule map.
This is a convenience which creates an instance of the UpdateIpRestrictionRequest.Builder
avoiding the
need to create one manually via UpdateIpRestrictionRequest.builder()
updateIpRestrictionRequest
- A Consumer
that will call methods on UpdateIpRestrictionRequest.Builder
to create a
request.LimitExceededException
- A limit is exceeded.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 UpdatePublicSharingSettingsResponse updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of
an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
updatePublicSharingSettingsRequest
- 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
credentials.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.UnsupportedPricingPlanException
- This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon 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 UpdatePublicSharingSettingsResponse updatePublicSharingSettings(Consumer<UpdatePublicSharingSettingsRequest.Builder> updatePublicSharingSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of
an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
This is a convenience which creates an instance of the UpdatePublicSharingSettingsRequest.Builder
avoiding the need to create one manually via UpdatePublicSharingSettingsRequest.builder()
updatePublicSharingSettingsRequest
- A Consumer
that will call methods on UpdatePublicSharingSettingsRequest.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
credentials.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.UnsupportedPricingPlanException
- This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon 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 UpdateTemplateResponse updateTemplate(UpdateTemplateRequest updateTemplateRequest) throws InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a template from an existing Amazon QuickSight analysis or another template.
updateTemplateRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateTemplateResponse updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) throws InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a template from an existing Amazon QuickSight analysis or another template.
This is a convenience which creates an instance of the UpdateTemplateRequest.Builder
avoiding the need to
create one manually via UpdateTemplateRequest.builder()
updateTemplateRequest
- A Consumer
that will call methods on UpdateTemplateRequest.Builder
to create a request.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateTemplateAliasResponse updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the template alias of a template.
updateTemplateAliasRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateTemplateAliasResponse updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the template alias of a template.
This is a convenience which creates an instance of the UpdateTemplateAliasRequest.Builder
avoiding the
need to create one manually via UpdateTemplateAliasRequest.builder()
updateTemplateAliasRequest
- A Consumer
that will call methods on UpdateTemplateAliasRequest.Builder
to create a
request.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateTemplatePermissionsResponse updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a template.
updateTemplatePermissionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateTemplatePermissionsResponse updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a template.
This is a convenience which creates an instance of the UpdateTemplatePermissionsRequest.Builder
avoiding
the need to create one manually via UpdateTemplatePermissionsRequest.builder()
updateTemplatePermissionsRequest
- A Consumer
that will call methods on UpdateTemplatePermissionsRequest.Builder
to create a
request.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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 UpdateThemeResponse updateTheme(UpdateThemeRequest updateThemeRequest) throws AccessDeniedException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a theme.
updateThemeRequest
- 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
credentials.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 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 UpdateThemeResponse updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest) throws AccessDeniedException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a theme.
This is a convenience which creates an instance of the UpdateThemeRequest.Builder
avoiding the need to
create one manually via UpdateThemeRequest.builder()
updateThemeRequest
- A Consumer
that will call methods on UpdateThemeRequest.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
credentials.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 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 UpdateThemeAliasResponse updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an alias of a theme.
updateThemeAliasRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.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 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 UpdateThemeAliasResponse updateThemeAlias(Consumer<UpdateThemeAliasRequest.Builder> updateThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an alias of a theme.
This is a convenience which creates an instance of the UpdateThemeAliasRequest.Builder
avoiding the need
to create one manually via UpdateThemeAliasRequest.builder()
updateThemeAliasRequest
- A Consumer
that will call methods on UpdateThemeAliasRequest.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.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 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 UpdateThemePermissionsResponse updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on,
for example "quicksight:DescribeTheme"
.
Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
User
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
Owner
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
"quicksight:DeleteTheme"
"quicksight:UpdateTheme"
"quicksight:CreateThemeAlias"
"quicksight:DeleteThemeAlias"
"quicksight:UpdateThemeAlias"
"quicksight:UpdateThemePermissions"
"quicksight:DescribeThemePermissions"
To specify no permissions, omit the permissions list.
updateThemePermissionsRequest
- 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
credentials.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 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 UpdateThemePermissionsResponse updateThemePermissions(Consumer<UpdateThemePermissionsRequest.Builder> updateThemePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on,
for example "quicksight:DescribeTheme"
.
Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
User
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
Owner
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
"quicksight:DeleteTheme"
"quicksight:UpdateTheme"
"quicksight:CreateThemeAlias"
"quicksight:DeleteThemeAlias"
"quicksight:UpdateThemeAlias"
"quicksight:UpdateThemePermissions"
"quicksight:DescribeThemePermissions"
To specify no permissions, omit the permissions list.
This is a convenience which creates an instance of the UpdateThemePermissionsRequest.Builder
avoiding the
need to create one manually via UpdateThemePermissionsRequest.builder()
updateThemePermissionsRequest
- A Consumer
that will call methods on UpdateThemePermissionsRequest.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
credentials.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 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 UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates an Amazon QuickSight user.
updateUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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 UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates an Amazon QuickSight user.
This is a convenience which creates an instance of the UpdateUserRequest.Builder
avoiding the need to
create one manually via UpdateUserRequest.builder()
updateUserRequest
- A Consumer
that will call methods on UpdateUserRequest.Builder
to create a request.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.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
static QuickSightClient create()
QuickSightClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static QuickSightClientBuilder builder()
QuickSightClient
.static ServiceMetadata serviceMetadata()
Copyright © 2023. All rights reserved.