@Generated(value="software.amazon.awssdk:codegen") public interface QuickSightAsyncClient extends SdkClient
builder() method.
Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static QuickSightAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
QuickSightAsyncClient. |
default CompletableFuture<CancelIngestionResponse> |
cancelIngestion(CancelIngestionRequest cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
|
default CompletableFuture<CancelIngestionResponse> |
cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
|
static QuickSightAsyncClient |
create()
Create a
QuickSightAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateDashboardResponse> |
createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
Creates a dashboard from a template.
|
default CompletableFuture<CreateDashboardResponse> |
createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard from a template.
|
default CompletableFuture<CreateDataSetResponse> |
createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest)
Creates a dataset.
|
default CompletableFuture<CreateDataSetResponse> |
createDataSet(CreateDataSetRequest createDataSetRequest)
Creates a dataset.
|
default CompletableFuture<CreateDataSourceResponse> |
createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
Creates a data source.
|
default CompletableFuture<CreateDataSourceResponse> |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates an Amazon QuickSight group.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(CreateGroupRequest createGroupRequest)
Creates an Amazon QuickSight group.
|
default CompletableFuture<CreateGroupMembershipResponse> |
createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
|
default CompletableFuture<CreateGroupMembershipResponse> |
createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
|
default CompletableFuture<CreateIamPolicyAssignmentResponse> |
createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
|
default CompletableFuture<CreateIamPolicyAssignmentResponse> |
createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
|
default CompletableFuture<CreateIngestionResponse> |
createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest)
Creates and starts a new SPICE ingestion on a dataset
|
default CompletableFuture<CreateIngestionResponse> |
createIngestion(CreateIngestionRequest createIngestionRequest)
Creates and starts a new SPICE ingestion on a dataset
|
default CompletableFuture<CreateTemplateResponse> |
createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)
Creates a template from an existing QuickSight analysis or template.
|
default CompletableFuture<CreateTemplateResponse> |
createTemplate(CreateTemplateRequest createTemplateRequest)
Creates a template from an existing QuickSight analysis or template.
|
default CompletableFuture<CreateTemplateAliasResponse> |
createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest)
Creates a template alias for a template.
|
default CompletableFuture<CreateTemplateAliasResponse> |
createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest)
Creates a template alias for a template.
|
default CompletableFuture<DeleteDashboardResponse> |
deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
Deletes a dashboard.
|
default CompletableFuture<DeleteDashboardResponse> |
deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard.
|
default CompletableFuture<DeleteDataSetResponse> |
deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest)
Deletes a dataset.
|
default CompletableFuture<DeleteDataSetResponse> |
deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)
Deletes a dataset.
|
default CompletableFuture<DeleteDataSourceResponse> |
deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
Deletes the data source permanently.
|
default CompletableFuture<DeleteDataSourceResponse> |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes the data source permanently.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Removes a user group from Amazon QuickSight.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Removes a user group from Amazon QuickSight.
|
default CompletableFuture<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 CompletableFuture<DeleteGroupMembershipResponse> |
deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Removes a user from a group so that the user is no longer a member of the group.
|
default CompletableFuture<DeleteIamPolicyAssignmentResponse> |
deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
|
default CompletableFuture<DeleteIamPolicyAssignmentResponse> |
deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
|
default CompletableFuture<DeleteTemplateResponse> |
deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)
Deletes a template.
|
default CompletableFuture<DeleteTemplateResponse> |
deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes a template.
|
default CompletableFuture<DeleteTemplateAliasResponse> |
deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest)
Deletes the item that the specified template alias points to.
|
default CompletableFuture<DeleteTemplateAliasResponse> |
deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest)
Deletes the item that the specified template alias points to.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management
(IAM) user or role that's making the call.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management
(IAM) user or role that's making the call.
|
default CompletableFuture<DeleteUserByPrincipalIdResponse> |
deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
|
default CompletableFuture<DeleteUserByPrincipalIdResponse> |
deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
|
default CompletableFuture<DescribeDashboardResponse> |
describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)
Provides a summary for a dashboard.
|
default CompletableFuture<DescribeDashboardResponse> |
describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Provides a summary for a dashboard.
|
default CompletableFuture<DescribeDashboardPermissionsResponse> |
describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
|
default CompletableFuture<DescribeDashboardPermissionsResponse> |
describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
|
default CompletableFuture<DescribeDataSetResponse> |
describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest)
Describes a dataset.
|
default CompletableFuture<DescribeDataSetResponse> |
describeDataSet(DescribeDataSetRequest describeDataSetRequest)
Describes a dataset.
|
default CompletableFuture<DescribeDataSetPermissionsResponse> |
describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
|
default CompletableFuture<DescribeDataSetPermissionsResponse> |
describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
|
default CompletableFuture<DescribeDataSourceResponse> |
describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
Describes a data source.
|
default CompletableFuture<DescribeDataSourceResponse> |
describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Describes a data source.
|
default CompletableFuture<DescribeDataSourcePermissionsResponse> |
describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
|
default CompletableFuture<DescribeDataSourcePermissionsResponse> |
describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
|
default CompletableFuture<DescribeGroupResponse> |
describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
|
default CompletableFuture<DescribeGroupResponse> |
describeGroup(DescribeGroupRequest describeGroupRequest)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
|
default CompletableFuture<DescribeIamPolicyAssignmentResponse> |
describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
|
default CompletableFuture<DescribeIamPolicyAssignmentResponse> |
describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
|
default CompletableFuture<DescribeIngestionResponse> |
describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest)
Describes a SPICE ingestion.
|
default CompletableFuture<DescribeIngestionResponse> |
describeIngestion(DescribeIngestionRequest describeIngestionRequest)
Describes a SPICE ingestion.
|
default CompletableFuture<DescribeTemplateResponse> |
describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest)
Describes a template's metadata.
|
default CompletableFuture<DescribeTemplateResponse> |
describeTemplate(DescribeTemplateRequest describeTemplateRequest)
Describes a template's metadata.
|
default CompletableFuture<DescribeTemplateAliasResponse> |
describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest)
Describes the template alias for a template.
|
default CompletableFuture<DescribeTemplateAliasResponse> |
describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest)
Describes the template alias for a template.
|
default CompletableFuture<DescribeTemplatePermissionsResponse> |
describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
|
default CompletableFuture<DescribeTemplatePermissionsResponse> |
describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
|
default CompletableFuture<DescribeUserResponse> |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Returns information about a user, given the user name.
|
default CompletableFuture<DescribeUserResponse> |
describeUser(DescribeUserRequest describeUserRequest)
Returns information about a user, given the user name.
|
default CompletableFuture<GetDashboardEmbedUrlResponse> |
getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest)
Generates a URL and authorization code that you can embed in your web server code.
|
default CompletableFuture<GetDashboardEmbedUrlResponse> |
getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
Generates a URL and authorization code that you can embed in your web server code.
|
default CompletableFuture<ListDashboardsResponse> |
listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Lists dashboards in an AWS account.
|
default CompletableFuture<ListDashboardsResponse> |
listDashboards(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an AWS account.
|
default ListDashboardsPublisher |
listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Lists dashboards in an AWS account.
|
default ListDashboardsPublisher |
listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an AWS account.
|
default CompletableFuture<ListDashboardVersionsResponse> |
listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
|
default CompletableFuture<ListDashboardVersionsResponse> |
listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
|
default ListDashboardVersionsPublisher |
listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
|
default ListDashboardVersionsPublisher |
listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
|
default CompletableFuture<ListDataSetsResponse> |
listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
default CompletableFuture<ListDataSetsResponse> |
listDataSets(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
default ListDataSetsPublisher |
listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
default ListDataSetsPublisher |
listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
default CompletableFuture<ListDataSourcesResponse> |
listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
|
default CompletableFuture<ListDataSourcesResponse> |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
|
default ListDataSourcesPublisher |
listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
|
default ListDataSourcesPublisher |
listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
|
default CompletableFuture<ListGroupMembershipsResponse> |
listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
Lists member users in a group.
|
default CompletableFuture<ListGroupMembershipsResponse> |
listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
Lists member users in a group.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Lists all user groups in Amazon QuickSight.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(ListGroupsRequest listGroupsRequest)
Lists all user groups in Amazon QuickSight.
|
default CompletableFuture<ListIamPolicyAssignmentsResponse> |
listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest)
Lists IAM policy assignments in the current Amazon QuickSight account.
|
default CompletableFuture<ListIamPolicyAssignmentsResponse> |
listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest)
Lists IAM policy assignments in the current Amazon QuickSight account.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<ListIngestionsResponse> |
listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
|
default CompletableFuture<ListIngestionsResponse> |
listIngestions(ListIngestionsRequest listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
|
default ListIngestionsPublisher |
listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
|
default ListIngestionsPublisher |
listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags assigned to a resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
|
default CompletableFuture<ListTemplateAliasesResponse> |
listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
Lists all the aliases of a template.
|
default CompletableFuture<ListTemplateAliasesResponse> |
listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest)
Lists all the aliases of a template.
|
default ListTemplateAliasesPublisher |
listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
Lists all the aliases of a template.
|
default ListTemplateAliasesPublisher |
listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest)
Lists all the aliases of a template.
|
default CompletableFuture<ListTemplatesResponse> |
listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
|
default CompletableFuture<ListTemplatesResponse> |
listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
|
default ListTemplatesPublisher |
listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
|
default ListTemplatesPublisher |
listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
|
default CompletableFuture<ListTemplateVersionsResponse> |
listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
default CompletableFuture<ListTemplateVersionsResponse> |
listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
default ListTemplateVersionsPublisher |
listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
default ListTemplateVersionsPublisher |
listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
default CompletableFuture<ListUserGroupsResponse> |
listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
default CompletableFuture<ListUserGroupsResponse> |
listUserGroups(ListUserGroupsRequest listUserGroupsRequest)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
default CompletableFuture<ListUsersResponse> |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns a list of all of the Amazon QuickSight users belonging to this account.
|
default CompletableFuture<ListUsersResponse> |
listUsers(ListUsersRequest listUsersRequest)
Returns a list of all of the Amazon QuickSight users belonging to this account.
|
default CompletableFuture<RegisterUserResponse> |
registerUser(Consumer<RegisterUserRequest.Builder> registerUserRequest)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM)
identity or role specified in the request.
|
default CompletableFuture<RegisterUserResponse> |
registerUser(RegisterUserRequest registerUserRequest)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM)
identity or role specified in the request.
|
default CompletableFuture<SearchDashboardsResponse> |
searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
Searchs for dashboards that belong to a user.
|
default CompletableFuture<SearchDashboardsResponse> |
searchDashboards(SearchDashboardsRequest searchDashboardsRequest)
Searchs for dashboards that belong to a user.
|
default SearchDashboardsPublisher |
searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
Searchs for dashboards that belong to a user.
|
default SearchDashboardsPublisher |
searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest)
Searchs for dashboards that belong to a user.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag or tags from a resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
|
default CompletableFuture<UpdateDashboardResponse> |
updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
Updates a dashboard in an AWS account.
|
default CompletableFuture<UpdateDashboardResponse> |
updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates a dashboard in an AWS account.
|
default CompletableFuture<UpdateDashboardPermissionsResponse> |
updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
|
default CompletableFuture<UpdateDashboardPermissionsResponse> |
updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
|
default CompletableFuture<UpdateDashboardPublishedVersionResponse> |
updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
|
default CompletableFuture<UpdateDashboardPublishedVersionResponse> |
updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
|
default CompletableFuture<UpdateDataSetResponse> |
updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest)
Updates a dataset.
|
default CompletableFuture<UpdateDataSetResponse> |
updateDataSet(UpdateDataSetRequest updateDataSetRequest)
Updates a dataset.
|
default CompletableFuture<UpdateDataSetPermissionsResponse> |
updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
|
default CompletableFuture<UpdateDataSetPermissionsResponse> |
updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
|
default CompletableFuture<UpdateDataSourceResponse> |
updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
Updates a data source.
|
default CompletableFuture<UpdateDataSourceResponse> |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates a data source.
|
default CompletableFuture<UpdateDataSourcePermissionsResponse> |
updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
|
default CompletableFuture<UpdateDataSourcePermissionsResponse> |
updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
|
default CompletableFuture<UpdateGroupResponse> |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Changes a group description.
|
default CompletableFuture<UpdateGroupResponse> |
updateGroup(UpdateGroupRequest updateGroupRequest)
Changes a group description.
|
default CompletableFuture<UpdateIamPolicyAssignmentResponse> |
updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest)
Updates an existing IAM policy assignment.
|
default CompletableFuture<UpdateIamPolicyAssignmentResponse> |
updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest)
Updates an existing IAM policy assignment.
|
default CompletableFuture<UpdateTemplateResponse> |
updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)
Updates a template from an existing Amazon QuickSight analysis or another template.
|
default CompletableFuture<UpdateTemplateResponse> |
updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Updates a template from an existing Amazon QuickSight analysis or another template.
|
default CompletableFuture<UpdateTemplateAliasResponse> |
updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest)
Updates the template alias of a template.
|
default CompletableFuture<UpdateTemplateAliasResponse> |
updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest)
Updates the template alias of a template.
|
default CompletableFuture<UpdateTemplatePermissionsResponse> |
updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
|
default CompletableFuture<UpdateTemplatePermissionsResponse> |
updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates an Amazon QuickSight user.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(UpdateUserRequest updateUserRequest)
Updates an Amazon QuickSight user.
|
serviceNameclosestatic final String SERVICE_NAME
static QuickSightAsyncClient create()
QuickSightAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static QuickSightAsyncClientBuilder builder()
QuickSightAsyncClient.default CompletableFuture<CancelIngestionResponse> cancelIngestion(CancelIngestionRequest cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
cancelIngestionRequest - default CompletableFuture<CancelIngestionResponse> cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest)
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.default CompletableFuture<CreateDashboardResponse> createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share
QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The
CreateDashboard, DescribeDashboard, and ListDashboardsByUser API
operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a
template that exists in a different AWS account.
createDashboardRequest - default CompletableFuture<CreateDashboardResponse> createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share
QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The
CreateDashboard, DescribeDashboard, and ListDashboardsByUser API
operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a
template that exists in a different AWS account.
This is a convenience which creates an instance of the CreateDashboardRequest.Builder avoiding the need
to create one manually via CreateDashboardRequest.builder()
createDashboardRequest - A Consumer that will call methods on CreateDashboardRequest.Builder to create a request.default CompletableFuture<CreateDataSetResponse> createDataSet(CreateDataSetRequest createDataSetRequest)
Creates a dataset.
createDataSetRequest - default CompletableFuture<CreateDataSetResponse> createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest)
Creates a dataset.
This is a convenience which creates an instance of the CreateDataSetRequest.Builder avoiding the need to
create one manually via CreateDataSetRequest.builder()
createDataSetRequest - A Consumer that will call methods on CreateDataSetRequest.Builder to create a request.default CompletableFuture<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source.
createDataSourceRequest - default CompletableFuture<CreateDataSourceResponse> createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
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.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
Creates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
createGroupRequest - The request object for this operation.default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request. The
request object for this operation.default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
createGroupMembershipRequest - default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)
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.default CompletableFuture<CreateIamPolicyAssignmentResponse> createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
createIamPolicyAssignmentRequest - default CompletableFuture<CreateIamPolicyAssignmentResponse> createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
This is a convenience which creates an instance of the CreateIamPolicyAssignmentRequest.Builder avoiding
the need to create one manually via CreateIamPolicyAssignmentRequest.builder()
createIamPolicyAssignmentRequest - A Consumer that will call methods on CreateIAMPolicyAssignmentRequest.Builder to create a
request.default CompletableFuture<CreateIngestionResponse> createIngestion(CreateIngestionRequest createIngestionRequest)
Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
createIngestionRequest - default CompletableFuture<CreateIngestionResponse> createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest)
Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
This is a convenience which creates an instance of the CreateIngestionRequest.Builder avoiding the need
to create one manually via CreateIngestionRequest.builder()
createIngestionRequest - A Consumer that will call methods on CreateIngestionRequest.Builder to create a request.default CompletableFuture<CreateTemplateResponse> createTemplate(CreateTemplateRequest createTemplateRequest)
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
createTemplateRequest - default CompletableFuture<CreateTemplateResponse> createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
This is a convenience which creates an instance of the CreateTemplateRequest.Builder avoiding the need to
create one manually via CreateTemplateRequest.builder()
createTemplateRequest - A Consumer that will call methods on CreateTemplateRequest.Builder to create a request.default CompletableFuture<CreateTemplateAliasResponse> createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest)
Creates a template alias for a template.
createTemplateAliasRequest - default CompletableFuture<CreateTemplateAliasResponse> createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest)
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.default CompletableFuture<DeleteDashboardResponse> deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard.
deleteDashboardRequest - default CompletableFuture<DeleteDashboardResponse> deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
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.default CompletableFuture<DeleteDataSetResponse> deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)
Deletes a dataset.
deleteDataSetRequest - default CompletableFuture<DeleteDataSetResponse> deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest)
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.default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
deleteDataSourceRequest - default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
This is a convenience which creates an instance of the DeleteDataSourceRequest.Builder avoiding the need
to create one manually via DeleteDataSourceRequest.builder()
deleteDataSourceRequest - A Consumer that will call methods on DeleteDataSourceRequest.Builder to create a request.default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
Removes a user group from Amazon QuickSight.
deleteGroupRequest - default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
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.default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Removes a user from a group so that the user is no longer a member of the group.
deleteGroupMembershipRequest - default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)
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.default CompletableFuture<DeleteIamPolicyAssignmentResponse> deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
deleteIamPolicyAssignmentRequest - default CompletableFuture<DeleteIamPolicyAssignmentResponse> deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest)
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.default CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes a template.
deleteTemplateRequest - default CompletableFuture<DeleteTemplateResponse> deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)
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.default CompletableFuture<DeleteTemplateAliasResponse> deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest)
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 - default CompletableFuture<DeleteTemplateAliasResponse> deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest)
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.default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
deleteUserRequest - default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. 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.default CompletableFuture<DeleteUserByPrincipalIdResponse> deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
deleteUserByPrincipalIdRequest - default CompletableFuture<DeleteUserByPrincipalIdResponse> deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest)
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.default CompletableFuture<DescribeDashboardResponse> describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Provides a summary for a dashboard.
describeDashboardRequest - default CompletableFuture<DescribeDashboardResponse> describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)
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.default CompletableFuture<DescribeDashboardPermissionsResponse> describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
describeDashboardPermissionsRequest - default CompletableFuture<DescribeDashboardPermissionsResponse> describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest)
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.default CompletableFuture<DescribeDataSetResponse> describeDataSet(DescribeDataSetRequest describeDataSetRequest)
Describes a dataset.
describeDataSetRequest - default CompletableFuture<DescribeDataSetResponse> describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest)
Describes a dataset.
This is a convenience which creates an instance of the DescribeDataSetRequest.Builder avoiding the need
to create one manually via DescribeDataSetRequest.builder()
describeDataSetRequest - A Consumer that will call methods on DescribeDataSetRequest.Builder to create a request.default CompletableFuture<DescribeDataSetPermissionsResponse> describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
describeDataSetPermissionsRequest - default CompletableFuture<DescribeDataSetPermissionsResponse> describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest)
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.default CompletableFuture<DescribeDataSourceResponse> describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Describes a data source.
describeDataSourceRequest - default CompletableFuture<DescribeDataSourceResponse> describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
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.default CompletableFuture<DescribeDataSourcePermissionsResponse> describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
describeDataSourcePermissionsRequest - default CompletableFuture<DescribeDataSourcePermissionsResponse> describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest)
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.default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
describeGroupRequest - default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
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.default CompletableFuture<DescribeIamPolicyAssignmentResponse> describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIamPolicyAssignmentRequest - NextToken value isn't valid.default CompletableFuture<DescribeIamPolicyAssignmentResponse> describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest)
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.NextToken value isn't valid.default CompletableFuture<DescribeIngestionResponse> describeIngestion(DescribeIngestionRequest describeIngestionRequest)
Describes a SPICE ingestion.
describeIngestionRequest - default CompletableFuture<DescribeIngestionResponse> describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest)
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.default CompletableFuture<DescribeTemplateResponse> describeTemplate(DescribeTemplateRequest describeTemplateRequest)
Describes a template's metadata.
describeTemplateRequest - default CompletableFuture<DescribeTemplateResponse> describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest)
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.default CompletableFuture<DescribeTemplateAliasResponse> describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest)
Describes the template alias for a template.
describeTemplateAliasRequest - default CompletableFuture<DescribeTemplateAliasResponse> describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest)
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.default CompletableFuture<DescribeTemplatePermissionsResponse> describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
describeTemplatePermissionsRequest - default CompletableFuture<DescribeTemplatePermissionsResponse> describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest)
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.default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)
Returns information about a user, given the user name.
describeUserRequest - default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
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.default CompletableFuture<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
Generates a URL and authorization code that you can embed in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The
following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.
getDashboardEmbedUrlRequest - DeleteUser, DescribeUser, and so on.IAM and QUICKSIGHT.default CompletableFuture<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest)
Generates a URL and authorization code that you can embed in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The
following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.
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.DeleteUser, DescribeUser, and so on.IAM and QUICKSIGHT.default CompletableFuture<ListDashboardVersionsResponse> listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
listDashboardVersionsRequest - NextToken value isn't valid.default CompletableFuture<ListDashboardVersionsResponse> listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
This is a convenience which creates an instance of the ListDashboardVersionsRequest.Builder avoiding the
need to create one manually via ListDashboardVersionsRequest.builder()
listDashboardVersionsRequest - A Consumer that will call methods on ListDashboardVersionsRequest.Builder to create a
request.NextToken value isn't valid.default ListDashboardVersionsPublisher listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - NextToken value isn't valid.default ListDashboardVersionsPublisher listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.NextToken value isn't valid.default CompletableFuture<ListDashboardsResponse> listDashboards(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an AWS account.
listDashboardsRequest - NextToken value isn't valid.default CompletableFuture<ListDashboardsResponse> listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Lists dashboards in an AWS account.
This is a convenience which creates an instance of the ListDashboardsRequest.Builder avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.NextToken value isn't valid.default ListDashboardsPublisher listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an AWS account.
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - NextToken value isn't valid.default ListDashboardsPublisher listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Lists dashboards in an AWS account.
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.NextToken value isn't valid.default CompletableFuture<ListDataSetsResponse> listDataSets(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
listDataSetsRequest - NextToken value isn't valid.default CompletableFuture<ListDataSetsResponse> listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
This is a convenience which creates an instance of the ListDataSetsRequest.Builder avoiding the need to
create one manually via ListDataSetsRequest.builder()
listDataSetsRequest - A Consumer that will call methods on ListDataSetsRequest.Builder to create a request.NextToken value isn't valid.default ListDataSetsPublisher listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
This is a variant of listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - NextToken value isn't valid.default ListDataSetsPublisher listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
This is a variant of listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.NextToken value isn't valid.default CompletableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
listDataSourcesRequest - NextToken value isn't valid.default CompletableFuture<ListDataSourcesResponse> listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.NextToken value isn't valid.default ListDataSourcesPublisher listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - NextToken value isn't valid.default ListDataSourcesPublisher listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.NextToken value isn't valid.default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
Lists member users in a group.
listGroupMembershipsRequest - NextToken value isn't valid.default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
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.NextToken value isn't valid.default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)
Lists all user groups in Amazon QuickSight.
listGroupsRequest - NextToken value isn't valid.default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
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.NextToken value isn't valid.default CompletableFuture<ListIamPolicyAssignmentsResponse> listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest)
Lists IAM policy assignments in the current Amazon QuickSight account.
listIamPolicyAssignmentsRequest - NextToken value isn't valid.default CompletableFuture<ListIamPolicyAssignmentsResponse> listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest)
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.NextToken value isn't valid.default CompletableFuture<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.
listIamPolicyAssignmentsForUserRequest - default CompletableFuture<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.
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.default CompletableFuture<ListIngestionsResponse> listIngestions(ListIngestionsRequest listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
listIngestionsRequest - NextToken value isn't valid.default CompletableFuture<ListIngestionsResponse> listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
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.NextToken value isn't valid.default ListIngestionsPublisher listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - NextToken value isn't valid.default ListIngestionsPublisher listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.NextToken value isn't valid.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
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.default CompletableFuture<ListTemplateAliasesResponse> listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest)
Lists all the aliases of a template.
listTemplateAliasesRequest - default CompletableFuture<ListTemplateAliasesResponse> listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
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.default ListTemplateAliasesPublisher listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListTemplateAliasesPublisher listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListTemplateVersionsResponse> listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
listTemplateVersionsRequest - NextToken value isn't valid.default CompletableFuture<ListTemplateVersionsResponse> listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
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.NextToken value isn't valid.default ListTemplateVersionsPublisher listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - NextToken value isn't valid.default ListTemplateVersionsPublisher listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.NextToken value isn't valid.default CompletableFuture<ListTemplatesResponse> listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
listTemplatesRequest - NextToken value isn't valid.default CompletableFuture<ListTemplatesResponse> listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
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.NextToken value isn't valid.default ListTemplatesPublisher listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - NextToken value isn't valid.default ListTemplatesPublisher listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.NextToken value isn't valid.default CompletableFuture<ListUserGroupsResponse> listUserGroups(ListUserGroupsRequest listUserGroupsRequest)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
listUserGroupsRequest - default CompletableFuture<ListUserGroupsResponse> listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)
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.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
Returns a list of all of the Amazon QuickSight users belonging to this account.
listUsersRequest - NextToken value isn't valid.default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
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.NextToken value isn't valid.default CompletableFuture<RegisterUserResponse> registerUser(RegisterUserRequest registerUserRequest)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
registerUserRequest - default CompletableFuture<RegisterUserResponse> registerUser(Consumer<RegisterUserRequest.Builder> registerUserRequest)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
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.default CompletableFuture<SearchDashboardsResponse> searchDashboards(SearchDashboardsRequest searchDashboardsRequest)
Searchs for dashboards that belong to a user.
searchDashboardsRequest - NextToken value isn't valid.default CompletableFuture<SearchDashboardsResponse> searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
Searchs for dashboards that belong to a user.
This is a convenience which creates an instance of the SearchDashboardsRequest.Builder avoiding the need
to create one manually via SearchDashboardsRequest.builder()
searchDashboardsRequest - A Consumer that will call methods on SearchDashboardsRequest.Builder to create a request.NextToken value isn't valid.default SearchDashboardsPublisher searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest)
Searchs for dashboards that belong to a user.
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - NextToken value isn't valid.default SearchDashboardsPublisher searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
Searchs for dashboards that belong to a user.
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.NextToken value isn't valid.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
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.default CompletableFuture<UpdateDashboardResponse> updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates a dashboard in an AWS account.
updateDashboardRequest - default CompletableFuture<UpdateDashboardResponse> updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
Updates a dashboard in an AWS account.
This is a convenience which creates an instance of the UpdateDashboardRequest.Builder avoiding the need
to create one manually via UpdateDashboardRequest.builder()
updateDashboardRequest - A Consumer that will call methods on UpdateDashboardRequest.Builder to create a request.default CompletableFuture<UpdateDashboardPermissionsResponse> updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
updateDashboardPermissionsRequest - default CompletableFuture<UpdateDashboardPermissionsResponse> updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest)
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.default CompletableFuture<UpdateDashboardPublishedVersionResponse> updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
updateDashboardPublishedVersionRequest - default CompletableFuture<UpdateDashboardPublishedVersionResponse> updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest)
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.default CompletableFuture<UpdateDataSetResponse> updateDataSet(UpdateDataSetRequest updateDataSetRequest)
Updates a dataset.
updateDataSetRequest - default CompletableFuture<UpdateDataSetResponse> updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest)
Updates a dataset.
This is a convenience which creates an instance of the UpdateDataSetRequest.Builder avoiding the need to
create one manually via UpdateDataSetRequest.builder()
updateDataSetRequest - A Consumer that will call methods on UpdateDataSetRequest.Builder to create a request.default CompletableFuture<UpdateDataSetPermissionsResponse> updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
updateDataSetPermissionsRequest - default CompletableFuture<UpdateDataSetPermissionsResponse> updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest)
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.default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates a data source.
updateDataSourceRequest - default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
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.default CompletableFuture<UpdateDataSourcePermissionsResponse> updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
updateDataSourcePermissionsRequest - default CompletableFuture<UpdateDataSourcePermissionsResponse> updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest)
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.default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)
Changes a group description.
updateGroupRequest - default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
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.default CompletableFuture<UpdateIamPolicyAssignmentResponse> updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
updateIamPolicyAssignmentRequest - default CompletableFuture<UpdateIamPolicyAssignmentResponse> updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
This is a convenience which creates an instance of the UpdateIamPolicyAssignmentRequest.Builder avoiding
the need to create one manually via UpdateIamPolicyAssignmentRequest.builder()
updateIamPolicyAssignmentRequest - A Consumer that will call methods on UpdateIAMPolicyAssignmentRequest.Builder to create a
request.default CompletableFuture<UpdateTemplateResponse> updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Updates a template from an existing Amazon QuickSight analysis or another template.
updateTemplateRequest - default CompletableFuture<UpdateTemplateResponse> updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)
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.default CompletableFuture<UpdateTemplateAliasResponse> updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest)
Updates the template alias of a template.
updateTemplateAliasRequest - default CompletableFuture<UpdateTemplateAliasResponse> updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest)
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.default CompletableFuture<UpdateTemplatePermissionsResponse> updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
updateTemplatePermissionsRequest - default CompletableFuture<UpdateTemplatePermissionsResponse> updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest)
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.default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)
Updates an Amazon QuickSight user.
updateUserRequest - default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
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.Copyright © 2020. All rights reserved.