Interface CleanRoomsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Welcome to the Clean Rooms API Reference.
Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data together in a secure collaboration workspace. In the collaboration, members who can query and receive results can get insights into the collective datasets without either party getting access to the other party's raw data.
To learn more about Clean Rooms concepts, procedures, and best practices, see the Clean Rooms User Guide.
To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchGetCollaborationAnalysisTemplate
(Consumer<BatchGetCollaborationAnalysisTemplateRequest.Builder> batchGetCollaborationAnalysisTemplateRequest) Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).batchGetCollaborationAnalysisTemplate
(BatchGetCollaborationAnalysisTemplateRequest batchGetCollaborationAnalysisTemplateRequest) Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).default BatchGetSchemaResponse
batchGetSchema
(Consumer<BatchGetSchemaRequest.Builder> batchGetSchemaRequest) Retrieves multiple schemas by their identifiers.default BatchGetSchemaResponse
batchGetSchema
(BatchGetSchemaRequest batchGetSchemaRequest) Retrieves multiple schemas by their identifiers.static CleanRoomsClientBuilder
builder()
Create a builder that can be used to configure and create aCleanRoomsClient
.static CleanRoomsClient
create()
Create aCleanRoomsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAnalysisTemplateResponse
createAnalysisTemplate
(Consumer<CreateAnalysisTemplateRequest.Builder> createAnalysisTemplateRequest) Creates a new analysis template.default CreateAnalysisTemplateResponse
createAnalysisTemplate
(CreateAnalysisTemplateRequest createAnalysisTemplateRequest) Creates a new analysis template.default CreateCollaborationResponse
createCollaboration
(Consumer<CreateCollaborationRequest.Builder> createCollaborationRequest) Creates a new collaboration.default CreateCollaborationResponse
createCollaboration
(CreateCollaborationRequest createCollaborationRequest) Creates a new collaboration.default CreateConfiguredTableResponse
createConfiguredTable
(Consumer<CreateConfiguredTableRequest.Builder> createConfiguredTableRequest) Creates a new configured table resource.default CreateConfiguredTableResponse
createConfiguredTable
(CreateConfiguredTableRequest createConfiguredTableRequest) Creates a new configured table resource.createConfiguredTableAnalysisRule
(Consumer<CreateConfiguredTableAnalysisRuleRequest.Builder> createConfiguredTableAnalysisRuleRequest) Creates a new analysis rule for a configured table.createConfiguredTableAnalysisRule
(CreateConfiguredTableAnalysisRuleRequest createConfiguredTableAnalysisRuleRequest) Creates a new analysis rule for a configured table.createConfiguredTableAssociation
(Consumer<CreateConfiguredTableAssociationRequest.Builder> createConfiguredTableAssociationRequest) Creates a configured table association.createConfiguredTableAssociation
(CreateConfiguredTableAssociationRequest createConfiguredTableAssociationRequest) Creates a configured table association.default CreateMembershipResponse
createMembership
(Consumer<CreateMembershipRequest.Builder> createMembershipRequest) Creates a membership for a specific collaboration identifier and joins the collaboration.default CreateMembershipResponse
createMembership
(CreateMembershipRequest createMembershipRequest) Creates a membership for a specific collaboration identifier and joins the collaboration.default DeleteAnalysisTemplateResponse
deleteAnalysisTemplate
(Consumer<DeleteAnalysisTemplateRequest.Builder> deleteAnalysisTemplateRequest) Deletes an analysis template.default DeleteAnalysisTemplateResponse
deleteAnalysisTemplate
(DeleteAnalysisTemplateRequest deleteAnalysisTemplateRequest) Deletes an analysis template.default DeleteCollaborationResponse
deleteCollaboration
(Consumer<DeleteCollaborationRequest.Builder> deleteCollaborationRequest) Deletes a collaboration.default DeleteCollaborationResponse
deleteCollaboration
(DeleteCollaborationRequest deleteCollaborationRequest) Deletes a collaboration.default DeleteConfiguredTableResponse
deleteConfiguredTable
(Consumer<DeleteConfiguredTableRequest.Builder> deleteConfiguredTableRequest) Deletes a configured table.default DeleteConfiguredTableResponse
deleteConfiguredTable
(DeleteConfiguredTableRequest deleteConfiguredTableRequest) Deletes a configured table.deleteConfiguredTableAnalysisRule
(Consumer<DeleteConfiguredTableAnalysisRuleRequest.Builder> deleteConfiguredTableAnalysisRuleRequest) Deletes a configured table analysis rule.deleteConfiguredTableAnalysisRule
(DeleteConfiguredTableAnalysisRuleRequest deleteConfiguredTableAnalysisRuleRequest) Deletes a configured table analysis rule.deleteConfiguredTableAssociation
(Consumer<DeleteConfiguredTableAssociationRequest.Builder> deleteConfiguredTableAssociationRequest) Deletes a configured table association.deleteConfiguredTableAssociation
(DeleteConfiguredTableAssociationRequest deleteConfiguredTableAssociationRequest) Deletes a configured table association.default DeleteMemberResponse
deleteMember
(Consumer<DeleteMemberRequest.Builder> deleteMemberRequest) Removes the specified member from a collaboration.default DeleteMemberResponse
deleteMember
(DeleteMemberRequest deleteMemberRequest) Removes the specified member from a collaboration.default DeleteMembershipResponse
deleteMembership
(Consumer<DeleteMembershipRequest.Builder> deleteMembershipRequest) Deletes a specified membership.default DeleteMembershipResponse
deleteMembership
(DeleteMembershipRequest deleteMembershipRequest) Deletes a specified membership.default GetAnalysisTemplateResponse
getAnalysisTemplate
(Consumer<GetAnalysisTemplateRequest.Builder> getAnalysisTemplateRequest) Retrieves an analysis template.default GetAnalysisTemplateResponse
getAnalysisTemplate
(GetAnalysisTemplateRequest getAnalysisTemplateRequest) Retrieves an analysis template.default GetCollaborationResponse
getCollaboration
(Consumer<GetCollaborationRequest.Builder> getCollaborationRequest) Returns metadata about a collaboration.default GetCollaborationResponse
getCollaboration
(GetCollaborationRequest getCollaborationRequest) Returns metadata about a collaboration.getCollaborationAnalysisTemplate
(Consumer<GetCollaborationAnalysisTemplateRequest.Builder> getCollaborationAnalysisTemplateRequest) Retrieves an analysis template within a collaboration.getCollaborationAnalysisTemplate
(GetCollaborationAnalysisTemplateRequest getCollaborationAnalysisTemplateRequest) Retrieves an analysis template within a collaboration.default GetConfiguredTableResponse
getConfiguredTable
(Consumer<GetConfiguredTableRequest.Builder> getConfiguredTableRequest) Retrieves a configured table.default GetConfiguredTableResponse
getConfiguredTable
(GetConfiguredTableRequest getConfiguredTableRequest) Retrieves a configured table.getConfiguredTableAnalysisRule
(Consumer<GetConfiguredTableAnalysisRuleRequest.Builder> getConfiguredTableAnalysisRuleRequest) Retrieves a configured table analysis rule.getConfiguredTableAnalysisRule
(GetConfiguredTableAnalysisRuleRequest getConfiguredTableAnalysisRuleRequest) Retrieves a configured table analysis rule.getConfiguredTableAssociation
(Consumer<GetConfiguredTableAssociationRequest.Builder> getConfiguredTableAssociationRequest) Retrieves a configured table association.getConfiguredTableAssociation
(GetConfiguredTableAssociationRequest getConfiguredTableAssociationRequest) Retrieves a configured table association.default GetMembershipResponse
getMembership
(Consumer<GetMembershipRequest.Builder> getMembershipRequest) Retrieves a specified membership for an identifier.default GetMembershipResponse
getMembership
(GetMembershipRequest getMembershipRequest) Retrieves a specified membership for an identifier.default GetProtectedQueryResponse
getProtectedQuery
(Consumer<GetProtectedQueryRequest.Builder> getProtectedQueryRequest) Returns query processing metadata.default GetProtectedQueryResponse
getProtectedQuery
(GetProtectedQueryRequest getProtectedQueryRequest) Returns query processing metadata.default GetSchemaResponse
getSchema
(Consumer<GetSchemaRequest.Builder> getSchemaRequest) Retrieves the schema for a relation within a collaboration.default GetSchemaResponse
getSchema
(GetSchemaRequest getSchemaRequest) Retrieves the schema for a relation within a collaboration.default GetSchemaAnalysisRuleResponse
getSchemaAnalysisRule
(Consumer<GetSchemaAnalysisRuleRequest.Builder> getSchemaAnalysisRuleRequest) Retrieves a schema analysis rule.default GetSchemaAnalysisRuleResponse
getSchemaAnalysisRule
(GetSchemaAnalysisRuleRequest getSchemaAnalysisRuleRequest) Retrieves a schema analysis rule.default ListAnalysisTemplatesResponse
listAnalysisTemplates
(Consumer<ListAnalysisTemplatesRequest.Builder> listAnalysisTemplatesRequest) Lists analysis templates that the caller owns.default ListAnalysisTemplatesResponse
listAnalysisTemplates
(ListAnalysisTemplatesRequest listAnalysisTemplatesRequest) Lists analysis templates that the caller owns.default ListAnalysisTemplatesIterable
listAnalysisTemplatesPaginator
(Consumer<ListAnalysisTemplatesRequest.Builder> listAnalysisTemplatesRequest) Lists analysis templates that the caller owns.default ListAnalysisTemplatesIterable
listAnalysisTemplatesPaginator
(ListAnalysisTemplatesRequest listAnalysisTemplatesRequest) Lists analysis templates that the caller owns.listCollaborationAnalysisTemplates
(Consumer<ListCollaborationAnalysisTemplatesRequest.Builder> listCollaborationAnalysisTemplatesRequest) Lists analysis templates within a collaboration.listCollaborationAnalysisTemplates
(ListCollaborationAnalysisTemplatesRequest listCollaborationAnalysisTemplatesRequest) Lists analysis templates within a collaboration.listCollaborationAnalysisTemplatesPaginator
(Consumer<ListCollaborationAnalysisTemplatesRequest.Builder> listCollaborationAnalysisTemplatesRequest) Lists analysis templates within a collaboration.listCollaborationAnalysisTemplatesPaginator
(ListCollaborationAnalysisTemplatesRequest listCollaborationAnalysisTemplatesRequest) Lists analysis templates within a collaboration.default ListCollaborationsResponse
listCollaborations
(Consumer<ListCollaborationsRequest.Builder> listCollaborationsRequest) Lists collaborations the caller owns, is active in, or has been invited to.default ListCollaborationsResponse
listCollaborations
(ListCollaborationsRequest listCollaborationsRequest) Lists collaborations the caller owns, is active in, or has been invited to.default ListCollaborationsIterable
listCollaborationsPaginator
(Consumer<ListCollaborationsRequest.Builder> listCollaborationsRequest) Lists collaborations the caller owns, is active in, or has been invited to.default ListCollaborationsIterable
listCollaborationsPaginator
(ListCollaborationsRequest listCollaborationsRequest) Lists collaborations the caller owns, is active in, or has been invited to.listConfiguredTableAssociations
(Consumer<ListConfiguredTableAssociationsRequest.Builder> listConfiguredTableAssociationsRequest) Lists configured table associations for a membership.listConfiguredTableAssociations
(ListConfiguredTableAssociationsRequest listConfiguredTableAssociationsRequest) Lists configured table associations for a membership.listConfiguredTableAssociationsPaginator
(Consumer<ListConfiguredTableAssociationsRequest.Builder> listConfiguredTableAssociationsRequest) Lists configured table associations for a membership.listConfiguredTableAssociationsPaginator
(ListConfiguredTableAssociationsRequest listConfiguredTableAssociationsRequest) Lists configured table associations for a membership.default ListConfiguredTablesResponse
listConfiguredTables
(Consumer<ListConfiguredTablesRequest.Builder> listConfiguredTablesRequest) Lists configured tables.default ListConfiguredTablesResponse
listConfiguredTables
(ListConfiguredTablesRequest listConfiguredTablesRequest) Lists configured tables.default ListConfiguredTablesIterable
listConfiguredTablesPaginator
(Consumer<ListConfiguredTablesRequest.Builder> listConfiguredTablesRequest) Lists configured tables.default ListConfiguredTablesIterable
listConfiguredTablesPaginator
(ListConfiguredTablesRequest listConfiguredTablesRequest) Lists configured tables.default ListMembersResponse
listMembers
(Consumer<ListMembersRequest.Builder> listMembersRequest) Lists all members within a collaboration.default ListMembersResponse
listMembers
(ListMembersRequest listMembersRequest) Lists all members within a collaboration.default ListMembershipsResponse
listMemberships
(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest) Lists all memberships resources within the caller's account.default ListMembershipsResponse
listMemberships
(ListMembershipsRequest listMembershipsRequest) Lists all memberships resources within the caller's account.default ListMembershipsIterable
listMembershipsPaginator
(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest) Lists all memberships resources within the caller's account.default ListMembershipsIterable
listMembershipsPaginator
(ListMembershipsRequest listMembershipsRequest) Lists all memberships resources within the caller's account.default ListMembersIterable
listMembersPaginator
(Consumer<ListMembersRequest.Builder> listMembersRequest) Lists all members within a collaboration.default ListMembersIterable
listMembersPaginator
(ListMembersRequest listMembersRequest) Lists all members within a collaboration.default ListProtectedQueriesResponse
listProtectedQueries
(Consumer<ListProtectedQueriesRequest.Builder> listProtectedQueriesRequest) Lists protected queries, sorted by the most recent query.default ListProtectedQueriesResponse
listProtectedQueries
(ListProtectedQueriesRequest listProtectedQueriesRequest) Lists protected queries, sorted by the most recent query.default ListProtectedQueriesIterable
listProtectedQueriesPaginator
(Consumer<ListProtectedQueriesRequest.Builder> listProtectedQueriesRequest) Lists protected queries, sorted by the most recent query.default ListProtectedQueriesIterable
listProtectedQueriesPaginator
(ListProtectedQueriesRequest listProtectedQueriesRequest) Lists protected queries, sorted by the most recent query.default ListSchemasResponse
listSchemas
(Consumer<ListSchemasRequest.Builder> listSchemasRequest) Lists the schemas for relations within a collaboration.default ListSchemasResponse
listSchemas
(ListSchemasRequest listSchemasRequest) Lists the schemas for relations within a collaboration.default ListSchemasIterable
listSchemasPaginator
(Consumer<ListSchemasRequest.Builder> listSchemasRequest) Lists the schemas for relations within a collaboration.default ListSchemasIterable
listSchemasPaginator
(ListSchemasRequest listSchemasRequest) Lists the schemas for relations within a collaboration.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all of the tags that have been added to a resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all of the tags that have been added to a resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartProtectedQueryResponse
startProtectedQuery
(Consumer<StartProtectedQueryRequest.Builder> startProtectedQueryRequest) Creates a protected query that is started by Clean Rooms.default StartProtectedQueryResponse
startProtectedQuery
(StartProtectedQueryRequest startProtectedQueryRequest) Creates a protected query that is started by Clean Rooms.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags a resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Tags a resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag or list of tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag or list of tags from a resource.default UpdateAnalysisTemplateResponse
updateAnalysisTemplate
(Consumer<UpdateAnalysisTemplateRequest.Builder> updateAnalysisTemplateRequest) Updates the analysis template metadata.default UpdateAnalysisTemplateResponse
updateAnalysisTemplate
(UpdateAnalysisTemplateRequest updateAnalysisTemplateRequest) Updates the analysis template metadata.default UpdateCollaborationResponse
updateCollaboration
(Consumer<UpdateCollaborationRequest.Builder> updateCollaborationRequest) Updates collaboration metadata and can only be called by the collaboration owner.default UpdateCollaborationResponse
updateCollaboration
(UpdateCollaborationRequest updateCollaborationRequest) Updates collaboration metadata and can only be called by the collaboration owner.default UpdateConfiguredTableResponse
updateConfiguredTable
(Consumer<UpdateConfiguredTableRequest.Builder> updateConfiguredTableRequest) Updates a configured table.default UpdateConfiguredTableResponse
updateConfiguredTable
(UpdateConfiguredTableRequest updateConfiguredTableRequest) Updates a configured table.updateConfiguredTableAnalysisRule
(Consumer<UpdateConfiguredTableAnalysisRuleRequest.Builder> updateConfiguredTableAnalysisRuleRequest) Updates a configured table analysis rule.updateConfiguredTableAnalysisRule
(UpdateConfiguredTableAnalysisRuleRequest updateConfiguredTableAnalysisRuleRequest) Updates a configured table analysis rule.updateConfiguredTableAssociation
(Consumer<UpdateConfiguredTableAssociationRequest.Builder> updateConfiguredTableAssociationRequest) Updates a configured table association.updateConfiguredTableAssociation
(UpdateConfiguredTableAssociationRequest updateConfiguredTableAssociationRequest) Updates a configured table association.default UpdateMembershipResponse
updateMembership
(Consumer<UpdateMembershipRequest.Builder> updateMembershipRequest) Updates a membership.default UpdateMembershipResponse
updateMembership
(UpdateMembershipRequest updateMembershipRequest) Updates a membership.default UpdateProtectedQueryResponse
updateProtectedQuery
(Consumer<UpdateProtectedQueryRequest.Builder> updateProtectedQueryRequest) Updates the processing of a currently running query.default UpdateProtectedQueryResponse
updateProtectedQuery
(UpdateProtectedQueryRequest updateProtectedQueryRequest) Updates the processing of a currently running query.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchGetCollaborationAnalysisTemplate
default BatchGetCollaborationAnalysisTemplateResponse batchGetCollaborationAnalysisTemplate(BatchGetCollaborationAnalysisTemplateRequest batchGetCollaborationAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
- Parameters:
batchGetCollaborationAnalysisTemplateRequest
-- Returns:
- Result of the BatchGetCollaborationAnalysisTemplate operation returned by the service.
- See Also:
-
batchGetCollaborationAnalysisTemplate
default BatchGetCollaborationAnalysisTemplateResponse batchGetCollaborationAnalysisTemplate(Consumer<BatchGetCollaborationAnalysisTemplateRequest.Builder> batchGetCollaborationAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
This is a convenience which creates an instance of the
BatchGetCollaborationAnalysisTemplateRequest.Builder
avoiding the need to create one manually viaBatchGetCollaborationAnalysisTemplateRequest.builder()
- Parameters:
batchGetCollaborationAnalysisTemplateRequest
- AConsumer
that will call methods onBatchGetCollaborationAnalysisTemplateRequest.Builder
to create a request.- Returns:
- Result of the BatchGetCollaborationAnalysisTemplate operation returned by the service.
- See Also:
-
batchGetSchema
default BatchGetSchemaResponse batchGetSchema(BatchGetSchemaRequest batchGetSchemaRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves multiple schemas by their identifiers.
- Parameters:
batchGetSchemaRequest
-- Returns:
- Result of the BatchGetSchema operation returned by the service.
- See Also:
-
batchGetSchema
default BatchGetSchemaResponse batchGetSchema(Consumer<BatchGetSchemaRequest.Builder> batchGetSchemaRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves multiple schemas by their identifiers.
This is a convenience which creates an instance of the
BatchGetSchemaRequest.Builder
avoiding the need to create one manually viaBatchGetSchemaRequest.builder()
- Parameters:
batchGetSchemaRequest
- AConsumer
that will call methods onBatchGetSchemaRequest.Builder
to create a request.- Returns:
- Result of the BatchGetSchema operation returned by the service.
- See Also:
-
createAnalysisTemplate
default CreateAnalysisTemplateResponse createAnalysisTemplate(CreateAnalysisTemplateRequest createAnalysisTemplateRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a new analysis template.
- Parameters:
createAnalysisTemplateRequest
-- Returns:
- Result of the CreateAnalysisTemplate operation returned by the service.
- See Also:
-
createAnalysisTemplate
default CreateAnalysisTemplateResponse createAnalysisTemplate(Consumer<CreateAnalysisTemplateRequest.Builder> createAnalysisTemplateRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a new analysis template.
This is a convenience which creates an instance of the
CreateAnalysisTemplateRequest.Builder
avoiding the need to create one manually viaCreateAnalysisTemplateRequest.builder()
- Parameters:
createAnalysisTemplateRequest
- AConsumer
that will call methods onCreateAnalysisTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreateAnalysisTemplate operation returned by the service.
- See Also:
-
createCollaboration
default CreateCollaborationResponse createCollaboration(CreateCollaborationRequest createCollaborationRequest) throws ServiceQuotaExceededException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a new collaboration.
- Parameters:
createCollaborationRequest
-- Returns:
- Result of the CreateCollaboration operation returned by the service.
- See Also:
-
createCollaboration
default CreateCollaborationResponse createCollaboration(Consumer<CreateCollaborationRequest.Builder> createCollaborationRequest) throws ServiceQuotaExceededException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a new collaboration.
This is a convenience which creates an instance of the
CreateCollaborationRequest.Builder
avoiding the need to create one manually viaCreateCollaborationRequest.builder()
- Parameters:
createCollaborationRequest
- AConsumer
that will call methods onCreateCollaborationRequest.Builder
to create a request.- Returns:
- Result of the CreateCollaboration operation returned by the service.
- See Also:
-
createConfiguredTable
default CreateConfiguredTableResponse createConfiguredTable(CreateConfiguredTableRequest createConfiguredTableRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a new configured table resource.
- Parameters:
createConfiguredTableRequest
-- Returns:
- Result of the CreateConfiguredTable operation returned by the service.
- See Also:
-
createConfiguredTable
default CreateConfiguredTableResponse createConfiguredTable(Consumer<CreateConfiguredTableRequest.Builder> createConfiguredTableRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a new configured table resource.
This is a convenience which creates an instance of the
CreateConfiguredTableRequest.Builder
avoiding the need to create one manually viaCreateConfiguredTableRequest.builder()
- Parameters:
createConfiguredTableRequest
- AConsumer
that will call methods onCreateConfiguredTableRequest.Builder
to create a request.- Returns:
- Result of the CreateConfiguredTable operation returned by the service.
- See Also:
-
createConfiguredTableAnalysisRule
default CreateConfiguredTableAnalysisRuleResponse createConfiguredTableAnalysisRule(CreateConfiguredTableAnalysisRuleRequest createConfiguredTableAnalysisRuleRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
- Parameters:
createConfiguredTableAnalysisRuleRequest
-- Returns:
- Result of the CreateConfiguredTableAnalysisRule operation returned by the service.
- See Also:
-
createConfiguredTableAnalysisRule
default CreateConfiguredTableAnalysisRuleResponse createConfiguredTableAnalysisRule(Consumer<CreateConfiguredTableAnalysisRuleRequest.Builder> createConfiguredTableAnalysisRuleRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
This is a convenience which creates an instance of the
CreateConfiguredTableAnalysisRuleRequest.Builder
avoiding the need to create one manually viaCreateConfiguredTableAnalysisRuleRequest.builder()
- Parameters:
createConfiguredTableAnalysisRuleRequest
- AConsumer
that will call methods onCreateConfiguredTableAnalysisRuleRequest.Builder
to create a request.- Returns:
- Result of the CreateConfiguredTableAnalysisRule operation returned by the service.
- See Also:
-
createConfiguredTableAssociation
default CreateConfiguredTableAssociationResponse createConfiguredTableAssociation(CreateConfiguredTableAssociationRequest createConfiguredTableAssociationRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a configured table association. A configured table association links a configured table with a collaboration.
- Parameters:
createConfiguredTableAssociationRequest
-- Returns:
- Result of the CreateConfiguredTableAssociation operation returned by the service.
- See Also:
-
createConfiguredTableAssociation
default CreateConfiguredTableAssociationResponse createConfiguredTableAssociation(Consumer<CreateConfiguredTableAssociationRequest.Builder> createConfiguredTableAssociationRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a configured table association. A configured table association links a configured table with a collaboration.
This is a convenience which creates an instance of the
CreateConfiguredTableAssociationRequest.Builder
avoiding the need to create one manually viaCreateConfiguredTableAssociationRequest.builder()
- Parameters:
createConfiguredTableAssociationRequest
- AConsumer
that will call methods onCreateConfiguredTableAssociationRequest.Builder
to create a request.- Returns:
- Result of the CreateConfiguredTableAssociation operation returned by the service.
- See Also:
-
createMembership
default CreateMembershipResponse createMembership(CreateMembershipRequest createMembershipRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a membership for a specific collaboration identifier and joins the collaboration.
- Parameters:
createMembershipRequest
-- Returns:
- Result of the CreateMembership operation returned by the service.
- See Also:
-
createMembership
default CreateMembershipResponse createMembership(Consumer<CreateMembershipRequest.Builder> createMembershipRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a membership for a specific collaboration identifier and joins the collaboration.
This is a convenience which creates an instance of the
CreateMembershipRequest.Builder
avoiding the need to create one manually viaCreateMembershipRequest.builder()
- Parameters:
createMembershipRequest
- AConsumer
that will call methods onCreateMembershipRequest.Builder
to create a request.- Returns:
- Result of the CreateMembership operation returned by the service.
- See Also:
-
deleteAnalysisTemplate
default DeleteAnalysisTemplateResponse deleteAnalysisTemplate(DeleteAnalysisTemplateRequest deleteAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes an analysis template.
- Parameters:
deleteAnalysisTemplateRequest
-- Returns:
- Result of the DeleteAnalysisTemplate operation returned by the service.
- See Also:
-
deleteAnalysisTemplate
default DeleteAnalysisTemplateResponse deleteAnalysisTemplate(Consumer<DeleteAnalysisTemplateRequest.Builder> deleteAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes an analysis template.
This is a convenience which creates an instance of the
DeleteAnalysisTemplateRequest.Builder
avoiding the need to create one manually viaDeleteAnalysisTemplateRequest.builder()
- Parameters:
deleteAnalysisTemplateRequest
- AConsumer
that will call methods onDeleteAnalysisTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeleteAnalysisTemplate operation returned by the service.
- See Also:
-
deleteCollaboration
default DeleteCollaborationResponse deleteCollaboration(DeleteCollaborationRequest deleteCollaborationRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a collaboration. It can only be called by the collaboration owner.
- Parameters:
deleteCollaborationRequest
-- Returns:
- Result of the DeleteCollaboration operation returned by the service.
- See Also:
-
deleteCollaboration
default DeleteCollaborationResponse deleteCollaboration(Consumer<DeleteCollaborationRequest.Builder> deleteCollaborationRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a collaboration. It can only be called by the collaboration owner.
This is a convenience which creates an instance of the
DeleteCollaborationRequest.Builder
avoiding the need to create one manually viaDeleteCollaborationRequest.builder()
- Parameters:
deleteCollaborationRequest
- AConsumer
that will call methods onDeleteCollaborationRequest.Builder
to create a request.- Returns:
- Result of the DeleteCollaboration operation returned by the service.
- See Also:
-
deleteConfiguredTable
default DeleteConfiguredTableResponse deleteConfiguredTable(DeleteConfiguredTableRequest deleteConfiguredTableRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a configured table.
- Parameters:
deleteConfiguredTableRequest
-- Returns:
- Result of the DeleteConfiguredTable operation returned by the service.
- See Also:
-
deleteConfiguredTable
default DeleteConfiguredTableResponse deleteConfiguredTable(Consumer<DeleteConfiguredTableRequest.Builder> deleteConfiguredTableRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a configured table.
This is a convenience which creates an instance of the
DeleteConfiguredTableRequest.Builder
avoiding the need to create one manually viaDeleteConfiguredTableRequest.builder()
- Parameters:
deleteConfiguredTableRequest
- AConsumer
that will call methods onDeleteConfiguredTableRequest.Builder
to create a request.- Returns:
- Result of the DeleteConfiguredTable operation returned by the service.
- See Also:
-
deleteConfiguredTableAnalysisRule
default DeleteConfiguredTableAnalysisRuleResponse deleteConfiguredTableAnalysisRule(DeleteConfiguredTableAnalysisRuleRequest deleteConfiguredTableAnalysisRuleRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a configured table analysis rule.
- Parameters:
deleteConfiguredTableAnalysisRuleRequest
-- Returns:
- Result of the DeleteConfiguredTableAnalysisRule operation returned by the service.
- See Also:
-
deleteConfiguredTableAnalysisRule
default DeleteConfiguredTableAnalysisRuleResponse deleteConfiguredTableAnalysisRule(Consumer<DeleteConfiguredTableAnalysisRuleRequest.Builder> deleteConfiguredTableAnalysisRuleRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a configured table analysis rule.
This is a convenience which creates an instance of the
DeleteConfiguredTableAnalysisRuleRequest.Builder
avoiding the need to create one manually viaDeleteConfiguredTableAnalysisRuleRequest.builder()
- Parameters:
deleteConfiguredTableAnalysisRuleRequest
- AConsumer
that will call methods onDeleteConfiguredTableAnalysisRuleRequest.Builder
to create a request.- Returns:
- Result of the DeleteConfiguredTableAnalysisRule operation returned by the service.
- See Also:
-
deleteConfiguredTableAssociation
default DeleteConfiguredTableAssociationResponse deleteConfiguredTableAssociation(DeleteConfiguredTableAssociationRequest deleteConfiguredTableAssociationRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a configured table association.
- Parameters:
deleteConfiguredTableAssociationRequest
-- Returns:
- Result of the DeleteConfiguredTableAssociation operation returned by the service.
- See Also:
-
deleteConfiguredTableAssociation
default DeleteConfiguredTableAssociationResponse deleteConfiguredTableAssociation(Consumer<DeleteConfiguredTableAssociationRequest.Builder> deleteConfiguredTableAssociationRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a configured table association.
This is a convenience which creates an instance of the
DeleteConfiguredTableAssociationRequest.Builder
avoiding the need to create one manually viaDeleteConfiguredTableAssociationRequest.builder()
- Parameters:
deleteConfiguredTableAssociationRequest
- AConsumer
that will call methods onDeleteConfiguredTableAssociationRequest.Builder
to create a request.- Returns:
- Result of the DeleteConfiguredTableAssociation operation returned by the service.
- See Also:
-
deleteMember
default DeleteMemberResponse deleteMember(DeleteMemberRequest deleteMemberRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.
- Parameters:
deleteMemberRequest
-- Returns:
- Result of the DeleteMember operation returned by the service.
- See Also:
-
deleteMember
default DeleteMemberResponse deleteMember(Consumer<DeleteMemberRequest.Builder> deleteMemberRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.
This is a convenience which creates an instance of the
DeleteMemberRequest.Builder
avoiding the need to create one manually viaDeleteMemberRequest.builder()
- Parameters:
deleteMemberRequest
- AConsumer
that will call methods onDeleteMemberRequest.Builder
to create a request.- Returns:
- Result of the DeleteMember operation returned by the service.
- See Also:
-
deleteMembership
default DeleteMembershipResponse deleteMembership(DeleteMembershipRequest deleteMembershipRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a specified membership. All resources under a membership must be deleted.
- Parameters:
deleteMembershipRequest
-- Returns:
- Result of the DeleteMembership operation returned by the service.
- See Also:
-
deleteMembership
default DeleteMembershipResponse deleteMembership(Consumer<DeleteMembershipRequest.Builder> deleteMembershipRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Deletes a specified membership. All resources under a membership must be deleted.
This is a convenience which creates an instance of the
DeleteMembershipRequest.Builder
avoiding the need to create one manually viaDeleteMembershipRequest.builder()
- Parameters:
deleteMembershipRequest
- AConsumer
that will call methods onDeleteMembershipRequest.Builder
to create a request.- Returns:
- Result of the DeleteMembership operation returned by the service.
- See Also:
-
getAnalysisTemplate
default GetAnalysisTemplateResponse getAnalysisTemplate(GetAnalysisTemplateRequest getAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves an analysis template.
- Parameters:
getAnalysisTemplateRequest
-- Returns:
- Result of the GetAnalysisTemplate operation returned by the service.
- See Also:
-
getAnalysisTemplate
default GetAnalysisTemplateResponse getAnalysisTemplate(Consumer<GetAnalysisTemplateRequest.Builder> getAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves an analysis template.
This is a convenience which creates an instance of the
GetAnalysisTemplateRequest.Builder
avoiding the need to create one manually viaGetAnalysisTemplateRequest.builder()
- Parameters:
getAnalysisTemplateRequest
- AConsumer
that will call methods onGetAnalysisTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetAnalysisTemplate operation returned by the service.
- See Also:
-
getCollaboration
default GetCollaborationResponse getCollaboration(GetCollaborationRequest getCollaborationRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Returns metadata about a collaboration.
- Parameters:
getCollaborationRequest
-- Returns:
- Result of the GetCollaboration operation returned by the service.
- See Also:
-
getCollaboration
default GetCollaborationResponse getCollaboration(Consumer<GetCollaborationRequest.Builder> getCollaborationRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Returns metadata about a collaboration.
This is a convenience which creates an instance of the
GetCollaborationRequest.Builder
avoiding the need to create one manually viaGetCollaborationRequest.builder()
- Parameters:
getCollaborationRequest
- AConsumer
that will call methods onGetCollaborationRequest.Builder
to create a request.- Returns:
- Result of the GetCollaboration operation returned by the service.
- See Also:
-
getCollaborationAnalysisTemplate
default GetCollaborationAnalysisTemplateResponse getCollaborationAnalysisTemplate(GetCollaborationAnalysisTemplateRequest getCollaborationAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves an analysis template within a collaboration.
- Parameters:
getCollaborationAnalysisTemplateRequest
-- Returns:
- Result of the GetCollaborationAnalysisTemplate operation returned by the service.
- See Also:
-
getCollaborationAnalysisTemplate
default GetCollaborationAnalysisTemplateResponse getCollaborationAnalysisTemplate(Consumer<GetCollaborationAnalysisTemplateRequest.Builder> getCollaborationAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves an analysis template within a collaboration.
This is a convenience which creates an instance of the
GetCollaborationAnalysisTemplateRequest.Builder
avoiding the need to create one manually viaGetCollaborationAnalysisTemplateRequest.builder()
- Parameters:
getCollaborationAnalysisTemplateRequest
- AConsumer
that will call methods onGetCollaborationAnalysisTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetCollaborationAnalysisTemplate operation returned by the service.
- See Also:
-
getConfiguredTable
default GetConfiguredTableResponse getConfiguredTable(GetConfiguredTableRequest getConfiguredTableRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a configured table.
- Parameters:
getConfiguredTableRequest
-- Returns:
- Result of the GetConfiguredTable operation returned by the service.
- See Also:
-
getConfiguredTable
default GetConfiguredTableResponse getConfiguredTable(Consumer<GetConfiguredTableRequest.Builder> getConfiguredTableRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a configured table.
This is a convenience which creates an instance of the
GetConfiguredTableRequest.Builder
avoiding the need to create one manually viaGetConfiguredTableRequest.builder()
- Parameters:
getConfiguredTableRequest
- AConsumer
that will call methods onGetConfiguredTableRequest.Builder
to create a request.- Returns:
- Result of the GetConfiguredTable operation returned by the service.
- See Also:
-
getConfiguredTableAnalysisRule
default GetConfiguredTableAnalysisRuleResponse getConfiguredTableAnalysisRule(GetConfiguredTableAnalysisRuleRequest getConfiguredTableAnalysisRuleRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a configured table analysis rule.
- Parameters:
getConfiguredTableAnalysisRuleRequest
-- Returns:
- Result of the GetConfiguredTableAnalysisRule operation returned by the service.
- See Also:
-
getConfiguredTableAnalysisRule
default GetConfiguredTableAnalysisRuleResponse getConfiguredTableAnalysisRule(Consumer<GetConfiguredTableAnalysisRuleRequest.Builder> getConfiguredTableAnalysisRuleRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a configured table analysis rule.
This is a convenience which creates an instance of the
GetConfiguredTableAnalysisRuleRequest.Builder
avoiding the need to create one manually viaGetConfiguredTableAnalysisRuleRequest.builder()
- Parameters:
getConfiguredTableAnalysisRuleRequest
- AConsumer
that will call methods onGetConfiguredTableAnalysisRuleRequest.Builder
to create a request.- Returns:
- Result of the GetConfiguredTableAnalysisRule operation returned by the service.
- See Also:
-
getConfiguredTableAssociation
default GetConfiguredTableAssociationResponse getConfiguredTableAssociation(GetConfiguredTableAssociationRequest getConfiguredTableAssociationRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a configured table association.
- Parameters:
getConfiguredTableAssociationRequest
-- Returns:
- Result of the GetConfiguredTableAssociation operation returned by the service.
- See Also:
-
getConfiguredTableAssociation
default GetConfiguredTableAssociationResponse getConfiguredTableAssociation(Consumer<GetConfiguredTableAssociationRequest.Builder> getConfiguredTableAssociationRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a configured table association.
This is a convenience which creates an instance of the
GetConfiguredTableAssociationRequest.Builder
avoiding the need to create one manually viaGetConfiguredTableAssociationRequest.builder()
- Parameters:
getConfiguredTableAssociationRequest
- AConsumer
that will call methods onGetConfiguredTableAssociationRequest.Builder
to create a request.- Returns:
- Result of the GetConfiguredTableAssociation operation returned by the service.
- See Also:
-
getMembership
default GetMembershipResponse getMembership(GetMembershipRequest getMembershipRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a specified membership for an identifier.
- Parameters:
getMembershipRequest
-- Returns:
- Result of the GetMembership operation returned by the service.
- See Also:
-
getMembership
default GetMembershipResponse getMembership(Consumer<GetMembershipRequest.Builder> getMembershipRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a specified membership for an identifier.
This is a convenience which creates an instance of the
GetMembershipRequest.Builder
avoiding the need to create one manually viaGetMembershipRequest.builder()
- Parameters:
getMembershipRequest
- AConsumer
that will call methods onGetMembershipRequest.Builder
to create a request.- Returns:
- Result of the GetMembership operation returned by the service.
- See Also:
-
getProtectedQuery
default GetProtectedQueryResponse getProtectedQuery(GetProtectedQueryRequest getProtectedQueryRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Returns query processing metadata.
- Parameters:
getProtectedQueryRequest
-- Returns:
- Result of the GetProtectedQuery operation returned by the service.
- See Also:
-
getProtectedQuery
default GetProtectedQueryResponse getProtectedQuery(Consumer<GetProtectedQueryRequest.Builder> getProtectedQueryRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Returns query processing metadata.
This is a convenience which creates an instance of the
GetProtectedQueryRequest.Builder
avoiding the need to create one manually viaGetProtectedQueryRequest.builder()
- Parameters:
getProtectedQueryRequest
- AConsumer
that will call methods onGetProtectedQueryRequest.Builder
to create a request.- Returns:
- Result of the GetProtectedQuery operation returned by the service.
- See Also:
-
getSchema
default GetSchemaResponse getSchema(GetSchemaRequest getSchemaRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves the schema for a relation within a collaboration.
- Parameters:
getSchemaRequest
-- Returns:
- Result of the GetSchema operation returned by the service.
- See Also:
-
getSchema
default GetSchemaResponse getSchema(Consumer<GetSchemaRequest.Builder> getSchemaRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves the schema for a relation within a collaboration.
This is a convenience which creates an instance of the
GetSchemaRequest.Builder
avoiding the need to create one manually viaGetSchemaRequest.builder()
- Parameters:
getSchemaRequest
- AConsumer
that will call methods onGetSchemaRequest.Builder
to create a request.- Returns:
- Result of the GetSchema operation returned by the service.
- See Also:
-
getSchemaAnalysisRule
default GetSchemaAnalysisRuleResponse getSchemaAnalysisRule(GetSchemaAnalysisRuleRequest getSchemaAnalysisRuleRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a schema analysis rule.
- Parameters:
getSchemaAnalysisRuleRequest
-- Returns:
- Result of the GetSchemaAnalysisRule operation returned by the service.
- See Also:
-
getSchemaAnalysisRule
default GetSchemaAnalysisRuleResponse getSchemaAnalysisRule(Consumer<GetSchemaAnalysisRuleRequest.Builder> getSchemaAnalysisRuleRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Retrieves a schema analysis rule.
This is a convenience which creates an instance of the
GetSchemaAnalysisRuleRequest.Builder
avoiding the need to create one manually viaGetSchemaAnalysisRuleRequest.builder()
- Parameters:
getSchemaAnalysisRuleRequest
- AConsumer
that will call methods onGetSchemaAnalysisRuleRequest.Builder
to create a request.- Returns:
- Result of the GetSchemaAnalysisRule operation returned by the service.
- See Also:
-
listAnalysisTemplates
default ListAnalysisTemplatesResponse listAnalysisTemplates(ListAnalysisTemplatesRequest listAnalysisTemplatesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists analysis templates that the caller owns.
- Parameters:
listAnalysisTemplatesRequest
-- Returns:
- Result of the ListAnalysisTemplates operation returned by the service.
- See Also:
-
listAnalysisTemplates
default ListAnalysisTemplatesResponse listAnalysisTemplates(Consumer<ListAnalysisTemplatesRequest.Builder> listAnalysisTemplatesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists analysis templates that the caller owns.
This is a convenience which creates an instance of the
ListAnalysisTemplatesRequest.Builder
avoiding the need to create one manually viaListAnalysisTemplatesRequest.builder()
- Parameters:
listAnalysisTemplatesRequest
- AConsumer
that will call methods onListAnalysisTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListAnalysisTemplates operation returned by the service.
- See Also:
-
listAnalysisTemplatesPaginator
default ListAnalysisTemplatesIterable listAnalysisTemplatesPaginator(ListAnalysisTemplatesRequest listAnalysisTemplatesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists analysis templates that the caller owns.
This is a variant of
listAnalysisTemplates(software.amazon.awssdk.services.cleanrooms.model.ListAnalysisTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListAnalysisTemplatesIterable responses = client.listAnalysisTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListAnalysisTemplatesIterable responses = client .listAnalysisTemplatesPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListAnalysisTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListAnalysisTemplatesIterable responses = client.listAnalysisTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalysisTemplates(software.amazon.awssdk.services.cleanrooms.model.ListAnalysisTemplatesRequest)
operation.- Parameters:
listAnalysisTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAnalysisTemplatesPaginator
default ListAnalysisTemplatesIterable listAnalysisTemplatesPaginator(Consumer<ListAnalysisTemplatesRequest.Builder> listAnalysisTemplatesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists analysis templates that the caller owns.
This is a variant of
listAnalysisTemplates(software.amazon.awssdk.services.cleanrooms.model.ListAnalysisTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListAnalysisTemplatesIterable responses = client.listAnalysisTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListAnalysisTemplatesIterable responses = client .listAnalysisTemplatesPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListAnalysisTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListAnalysisTemplatesIterable responses = client.listAnalysisTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalysisTemplates(software.amazon.awssdk.services.cleanrooms.model.ListAnalysisTemplatesRequest)
operation.This is a convenience which creates an instance of the
ListAnalysisTemplatesRequest.Builder
avoiding the need to create one manually viaListAnalysisTemplatesRequest.builder()
- Parameters:
listAnalysisTemplatesRequest
- AConsumer
that will call methods onListAnalysisTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCollaborationAnalysisTemplates
default ListCollaborationAnalysisTemplatesResponse listCollaborationAnalysisTemplates(ListCollaborationAnalysisTemplatesRequest listCollaborationAnalysisTemplatesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists analysis templates within a collaboration.
- Parameters:
listCollaborationAnalysisTemplatesRequest
-- Returns:
- Result of the ListCollaborationAnalysisTemplates operation returned by the service.
- See Also:
-
listCollaborationAnalysisTemplates
default ListCollaborationAnalysisTemplatesResponse listCollaborationAnalysisTemplates(Consumer<ListCollaborationAnalysisTemplatesRequest.Builder> listCollaborationAnalysisTemplatesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists analysis templates within a collaboration.
This is a convenience which creates an instance of the
ListCollaborationAnalysisTemplatesRequest.Builder
avoiding the need to create one manually viaListCollaborationAnalysisTemplatesRequest.builder()
- Parameters:
listCollaborationAnalysisTemplatesRequest
- AConsumer
that will call methods onListCollaborationAnalysisTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListCollaborationAnalysisTemplates operation returned by the service.
- See Also:
-
listCollaborationAnalysisTemplatesPaginator
default ListCollaborationAnalysisTemplatesIterable listCollaborationAnalysisTemplatesPaginator(ListCollaborationAnalysisTemplatesRequest listCollaborationAnalysisTemplatesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists analysis templates within a collaboration.
This is a variant of
listCollaborationAnalysisTemplates(software.amazon.awssdk.services.cleanrooms.model.ListCollaborationAnalysisTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationAnalysisTemplatesIterable responses = client.listCollaborationAnalysisTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationAnalysisTemplatesIterable responses = client .listCollaborationAnalysisTemplatesPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListCollaborationAnalysisTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationAnalysisTemplatesIterable responses = client.listCollaborationAnalysisTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCollaborationAnalysisTemplates(software.amazon.awssdk.services.cleanrooms.model.ListCollaborationAnalysisTemplatesRequest)
operation.- Parameters:
listCollaborationAnalysisTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCollaborationAnalysisTemplatesPaginator
default ListCollaborationAnalysisTemplatesIterable listCollaborationAnalysisTemplatesPaginator(Consumer<ListCollaborationAnalysisTemplatesRequest.Builder> listCollaborationAnalysisTemplatesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists analysis templates within a collaboration.
This is a variant of
listCollaborationAnalysisTemplates(software.amazon.awssdk.services.cleanrooms.model.ListCollaborationAnalysisTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationAnalysisTemplatesIterable responses = client.listCollaborationAnalysisTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationAnalysisTemplatesIterable responses = client .listCollaborationAnalysisTemplatesPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListCollaborationAnalysisTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationAnalysisTemplatesIterable responses = client.listCollaborationAnalysisTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCollaborationAnalysisTemplates(software.amazon.awssdk.services.cleanrooms.model.ListCollaborationAnalysisTemplatesRequest)
operation.This is a convenience which creates an instance of the
ListCollaborationAnalysisTemplatesRequest.Builder
avoiding the need to create one manually viaListCollaborationAnalysisTemplatesRequest.builder()
- Parameters:
listCollaborationAnalysisTemplatesRequest
- AConsumer
that will call methods onListCollaborationAnalysisTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCollaborations
default ListCollaborationsResponse listCollaborations(ListCollaborationsRequest listCollaborationsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists collaborations the caller owns, is active in, or has been invited to.
- Parameters:
listCollaborationsRequest
-- Returns:
- Result of the ListCollaborations operation returned by the service.
- See Also:
-
listCollaborations
default ListCollaborationsResponse listCollaborations(Consumer<ListCollaborationsRequest.Builder> listCollaborationsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists collaborations the caller owns, is active in, or has been invited to.
This is a convenience which creates an instance of the
ListCollaborationsRequest.Builder
avoiding the need to create one manually viaListCollaborationsRequest.builder()
- Parameters:
listCollaborationsRequest
- AConsumer
that will call methods onListCollaborationsRequest.Builder
to create a request.- Returns:
- Result of the ListCollaborations operation returned by the service.
- See Also:
-
listCollaborationsPaginator
default ListCollaborationsIterable listCollaborationsPaginator(ListCollaborationsRequest listCollaborationsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists collaborations the caller owns, is active in, or has been invited to.
This is a variant of
listCollaborations(software.amazon.awssdk.services.cleanrooms.model.ListCollaborationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationsIterable responses = client.listCollaborationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationsIterable responses = client .listCollaborationsPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListCollaborationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationsIterable responses = client.listCollaborationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCollaborations(software.amazon.awssdk.services.cleanrooms.model.ListCollaborationsRequest)
operation.- Parameters:
listCollaborationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCollaborationsPaginator
default ListCollaborationsIterable listCollaborationsPaginator(Consumer<ListCollaborationsRequest.Builder> listCollaborationsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists collaborations the caller owns, is active in, or has been invited to.
This is a variant of
listCollaborations(software.amazon.awssdk.services.cleanrooms.model.ListCollaborationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationsIterable responses = client.listCollaborationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationsIterable responses = client .listCollaborationsPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListCollaborationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListCollaborationsIterable responses = client.listCollaborationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCollaborations(software.amazon.awssdk.services.cleanrooms.model.ListCollaborationsRequest)
operation.This is a convenience which creates an instance of the
ListCollaborationsRequest.Builder
avoiding the need to create one manually viaListCollaborationsRequest.builder()
- Parameters:
listCollaborationsRequest
- AConsumer
that will call methods onListCollaborationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listConfiguredTableAssociations
default ListConfiguredTableAssociationsResponse listConfiguredTableAssociations(ListConfiguredTableAssociationsRequest listConfiguredTableAssociationsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists configured table associations for a membership.
- Parameters:
listConfiguredTableAssociationsRequest
-- Returns:
- Result of the ListConfiguredTableAssociations operation returned by the service.
- See Also:
-
listConfiguredTableAssociations
default ListConfiguredTableAssociationsResponse listConfiguredTableAssociations(Consumer<ListConfiguredTableAssociationsRequest.Builder> listConfiguredTableAssociationsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists configured table associations for a membership.
This is a convenience which creates an instance of the
ListConfiguredTableAssociationsRequest.Builder
avoiding the need to create one manually viaListConfiguredTableAssociationsRequest.builder()
- Parameters:
listConfiguredTableAssociationsRequest
- AConsumer
that will call methods onListConfiguredTableAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListConfiguredTableAssociations operation returned by the service.
- See Also:
-
listConfiguredTableAssociationsPaginator
default ListConfiguredTableAssociationsIterable listConfiguredTableAssociationsPaginator(ListConfiguredTableAssociationsRequest listConfiguredTableAssociationsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists configured table associations for a membership.
This is a variant of
listConfiguredTableAssociations(software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTableAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTableAssociationsIterable responses = client.listConfiguredTableAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTableAssociationsIterable responses = client .listConfiguredTableAssociationsPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTableAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTableAssociationsIterable responses = client.listConfiguredTableAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfiguredTableAssociations(software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTableAssociationsRequest)
operation.- Parameters:
listConfiguredTableAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listConfiguredTableAssociationsPaginator
default ListConfiguredTableAssociationsIterable listConfiguredTableAssociationsPaginator(Consumer<ListConfiguredTableAssociationsRequest.Builder> listConfiguredTableAssociationsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists configured table associations for a membership.
This is a variant of
listConfiguredTableAssociations(software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTableAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTableAssociationsIterable responses = client.listConfiguredTableAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTableAssociationsIterable responses = client .listConfiguredTableAssociationsPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTableAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTableAssociationsIterable responses = client.listConfiguredTableAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfiguredTableAssociations(software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTableAssociationsRequest)
operation.This is a convenience which creates an instance of the
ListConfiguredTableAssociationsRequest.Builder
avoiding the need to create one manually viaListConfiguredTableAssociationsRequest.builder()
- Parameters:
listConfiguredTableAssociationsRequest
- AConsumer
that will call methods onListConfiguredTableAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listConfiguredTables
default ListConfiguredTablesResponse listConfiguredTables(ListConfiguredTablesRequest listConfiguredTablesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists configured tables.
- Parameters:
listConfiguredTablesRequest
-- Returns:
- Result of the ListConfiguredTables operation returned by the service.
- See Also:
-
listConfiguredTables
default ListConfiguredTablesResponse listConfiguredTables(Consumer<ListConfiguredTablesRequest.Builder> listConfiguredTablesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists configured tables.
This is a convenience which creates an instance of the
ListConfiguredTablesRequest.Builder
avoiding the need to create one manually viaListConfiguredTablesRequest.builder()
- Parameters:
listConfiguredTablesRequest
- AConsumer
that will call methods onListConfiguredTablesRequest.Builder
to create a request.- Returns:
- Result of the ListConfiguredTables operation returned by the service.
- See Also:
-
listConfiguredTablesPaginator
default ListConfiguredTablesIterable listConfiguredTablesPaginator(ListConfiguredTablesRequest listConfiguredTablesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists configured tables.
This is a variant of
listConfiguredTables(software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTablesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTablesIterable responses = client.listConfiguredTablesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTablesIterable responses = client .listConfiguredTablesPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTablesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTablesIterable responses = client.listConfiguredTablesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfiguredTables(software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTablesRequest)
operation.- Parameters:
listConfiguredTablesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listConfiguredTablesPaginator
default ListConfiguredTablesIterable listConfiguredTablesPaginator(Consumer<ListConfiguredTablesRequest.Builder> listConfiguredTablesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists configured tables.
This is a variant of
listConfiguredTables(software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTablesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTablesIterable responses = client.listConfiguredTablesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTablesIterable responses = client .listConfiguredTablesPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTablesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListConfiguredTablesIterable responses = client.listConfiguredTablesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfiguredTables(software.amazon.awssdk.services.cleanrooms.model.ListConfiguredTablesRequest)
operation.This is a convenience which creates an instance of the
ListConfiguredTablesRequest.Builder
avoiding the need to create one manually viaListConfiguredTablesRequest.builder()
- Parameters:
listConfiguredTablesRequest
- AConsumer
that will call methods onListConfiguredTablesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMembers
default ListMembersResponse listMembers(ListMembersRequest listMembersRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists all members within a collaboration.
- Parameters:
listMembersRequest
-- Returns:
- Result of the ListMembers operation returned by the service.
- See Also:
-
listMembers
default ListMembersResponse listMembers(Consumer<ListMembersRequest.Builder> listMembersRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists all members within a collaboration.
This is a convenience which creates an instance of the
ListMembersRequest.Builder
avoiding the need to create one manually viaListMembersRequest.builder()
- Parameters:
listMembersRequest
- AConsumer
that will call methods onListMembersRequest.Builder
to create a request.- Returns:
- Result of the ListMembers operation returned by the service.
- See Also:
-
listMembersPaginator
default ListMembersIterable listMembersPaginator(ListMembersRequest listMembersRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists all members within a collaboration.
This is a variant of
listMembers(software.amazon.awssdk.services.cleanrooms.model.ListMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListMembersIterable responses = client.listMembersPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListMembersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMembers(software.amazon.awssdk.services.cleanrooms.model.ListMembersRequest)
operation.- Parameters:
listMembersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMembersPaginator
default ListMembersIterable listMembersPaginator(Consumer<ListMembersRequest.Builder> listMembersRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists all members within a collaboration.
This is a variant of
listMembers(software.amazon.awssdk.services.cleanrooms.model.ListMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListMembersIterable responses = client.listMembersPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListMembersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListMembersIterable responses = client.listMembersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMembers(software.amazon.awssdk.services.cleanrooms.model.ListMembersRequest)
operation.This is a convenience which creates an instance of the
ListMembersRequest.Builder
avoiding the need to create one manually viaListMembersRequest.builder()
- Parameters:
listMembersRequest
- AConsumer
that will call methods onListMembersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMemberships
default ListMembershipsResponse listMemberships(ListMembershipsRequest listMembershipsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists all memberships resources within the caller's account.
- Parameters:
listMembershipsRequest
-- Returns:
- Result of the ListMemberships operation returned by the service.
- See Also:
-
listMemberships
default ListMembershipsResponse listMemberships(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists all memberships resources within the caller's account.
This is a convenience which creates an instance of the
ListMembershipsRequest.Builder
avoiding the need to create one manually viaListMembershipsRequest.builder()
- Parameters:
listMembershipsRequest
- AConsumer
that will call methods onListMembershipsRequest.Builder
to create a request.- Returns:
- Result of the ListMemberships operation returned by the service.
- See Also:
-
listMembershipsPaginator
default ListMembershipsIterable listMembershipsPaginator(ListMembershipsRequest listMembershipsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists all memberships resources within the caller's account.
This is a variant of
listMemberships(software.amazon.awssdk.services.cleanrooms.model.ListMembershipsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListMembershipsIterable responses = client.listMembershipsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListMembershipsIterable responses = client .listMembershipsPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListMembershipsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListMembershipsIterable responses = client.listMembershipsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMemberships(software.amazon.awssdk.services.cleanrooms.model.ListMembershipsRequest)
operation.- Parameters:
listMembershipsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMembershipsPaginator
default ListMembershipsIterable listMembershipsPaginator(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists all memberships resources within the caller's account.
This is a variant of
listMemberships(software.amazon.awssdk.services.cleanrooms.model.ListMembershipsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListMembershipsIterable responses = client.listMembershipsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListMembershipsIterable responses = client .listMembershipsPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListMembershipsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListMembershipsIterable responses = client.listMembershipsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMemberships(software.amazon.awssdk.services.cleanrooms.model.ListMembershipsRequest)
operation.This is a convenience which creates an instance of the
ListMembershipsRequest.Builder
avoiding the need to create one manually viaListMembershipsRequest.builder()
- Parameters:
listMembershipsRequest
- AConsumer
that will call methods onListMembershipsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectedQueries
default ListProtectedQueriesResponse listProtectedQueries(ListProtectedQueriesRequest listProtectedQueriesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists protected queries, sorted by the most recent query.
- Parameters:
listProtectedQueriesRequest
-- Returns:
- Result of the ListProtectedQueries operation returned by the service.
- See Also:
-
listProtectedQueries
default ListProtectedQueriesResponse listProtectedQueries(Consumer<ListProtectedQueriesRequest.Builder> listProtectedQueriesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists protected queries, sorted by the most recent query.
This is a convenience which creates an instance of the
ListProtectedQueriesRequest.Builder
avoiding the need to create one manually viaListProtectedQueriesRequest.builder()
- Parameters:
listProtectedQueriesRequest
- AConsumer
that will call methods onListProtectedQueriesRequest.Builder
to create a request.- Returns:
- Result of the ListProtectedQueries operation returned by the service.
- See Also:
-
listProtectedQueriesPaginator
default ListProtectedQueriesIterable listProtectedQueriesPaginator(ListProtectedQueriesRequest listProtectedQueriesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists protected queries, sorted by the most recent query.
This is a variant of
listProtectedQueries(software.amazon.awssdk.services.cleanrooms.model.ListProtectedQueriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListProtectedQueriesIterable responses = client.listProtectedQueriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListProtectedQueriesIterable responses = client .listProtectedQueriesPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListProtectedQueriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListProtectedQueriesIterable responses = client.listProtectedQueriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectedQueries(software.amazon.awssdk.services.cleanrooms.model.ListProtectedQueriesRequest)
operation.- Parameters:
listProtectedQueriesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProtectedQueriesPaginator
default ListProtectedQueriesIterable listProtectedQueriesPaginator(Consumer<ListProtectedQueriesRequest.Builder> listProtectedQueriesRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists protected queries, sorted by the most recent query.
This is a variant of
listProtectedQueries(software.amazon.awssdk.services.cleanrooms.model.ListProtectedQueriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListProtectedQueriesIterable responses = client.listProtectedQueriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListProtectedQueriesIterable responses = client .listProtectedQueriesPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListProtectedQueriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListProtectedQueriesIterable responses = client.listProtectedQueriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectedQueries(software.amazon.awssdk.services.cleanrooms.model.ListProtectedQueriesRequest)
operation.This is a convenience which creates an instance of the
ListProtectedQueriesRequest.Builder
avoiding the need to create one manually viaListProtectedQueriesRequest.builder()
- Parameters:
listProtectedQueriesRequest
- AConsumer
that will call methods onListProtectedQueriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSchemas
default ListSchemasResponse listSchemas(ListSchemasRequest listSchemasRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists the schemas for relations within a collaboration.
- Parameters:
listSchemasRequest
-- Returns:
- Result of the ListSchemas operation returned by the service.
- See Also:
-
listSchemas
default ListSchemasResponse listSchemas(Consumer<ListSchemasRequest.Builder> listSchemasRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists the schemas for relations within a collaboration.
This is a convenience which creates an instance of the
ListSchemasRequest.Builder
avoiding the need to create one manually viaListSchemasRequest.builder()
- Parameters:
listSchemasRequest
- AConsumer
that will call methods onListSchemasRequest.Builder
to create a request.- Returns:
- Result of the ListSchemas operation returned by the service.
- See Also:
-
listSchemasPaginator
default ListSchemasIterable listSchemasPaginator(ListSchemasRequest listSchemasRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists the schemas for relations within a collaboration.
This is a variant of
listSchemas(software.amazon.awssdk.services.cleanrooms.model.ListSchemasRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListSchemasResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemas(software.amazon.awssdk.services.cleanrooms.model.ListSchemasRequest)
operation.- Parameters:
listSchemasRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSchemasPaginator
default ListSchemasIterable listSchemasPaginator(Consumer<ListSchemasRequest.Builder> listSchemasRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Lists the schemas for relations within a collaboration.
This is a variant of
listSchemas(software.amazon.awssdk.services.cleanrooms.model.ListSchemasRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cleanrooms.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cleanrooms.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); for (software.amazon.awssdk.services.cleanrooms.model.ListSchemasResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cleanrooms.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemas(software.amazon.awssdk.services.cleanrooms.model.ListSchemasRequest)
operation.This is a convenience which creates an instance of the
ListSchemasRequest.Builder
avoiding the need to create one manually viaListSchemasRequest.builder()
- Parameters:
listSchemasRequest
- AConsumer
that will call methods onListSchemasRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CleanRoomsException Lists all of the tags that have been added to a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CleanRoomsException Lists all of the tags that have been added to a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startProtectedQuery
default StartProtectedQueryResponse startProtectedQuery(StartProtectedQueryRequest startProtectedQueryRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a protected query that is started by Clean Rooms.
- Parameters:
startProtectedQueryRequest
-- Returns:
- Result of the StartProtectedQuery operation returned by the service.
- See Also:
-
startProtectedQuery
default StartProtectedQueryResponse startProtectedQuery(Consumer<StartProtectedQueryRequest.Builder> startProtectedQueryRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Creates a protected query that is started by Clean Rooms.
This is a convenience which creates an instance of the
StartProtectedQueryRequest.Builder
avoiding the need to create one manually viaStartProtectedQueryRequest.builder()
- Parameters:
startProtectedQueryRequest
- AConsumer
that will call methods onStartProtectedQueryRequest.Builder
to create a request.- Returns:
- Result of the StartProtectedQuery operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CleanRoomsException Tags a resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CleanRoomsException Tags a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CleanRoomsException Removes a tag or list of tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CleanRoomsException Removes a tag or list of tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAnalysisTemplate
default UpdateAnalysisTemplateResponse updateAnalysisTemplate(UpdateAnalysisTemplateRequest updateAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates the analysis template metadata.
- Parameters:
updateAnalysisTemplateRequest
-- Returns:
- Result of the UpdateAnalysisTemplate operation returned by the service.
- See Also:
-
updateAnalysisTemplate
default UpdateAnalysisTemplateResponse updateAnalysisTemplate(Consumer<UpdateAnalysisTemplateRequest.Builder> updateAnalysisTemplateRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates the analysis template metadata.
This is a convenience which creates an instance of the
UpdateAnalysisTemplateRequest.Builder
avoiding the need to create one manually viaUpdateAnalysisTemplateRequest.builder()
- Parameters:
updateAnalysisTemplateRequest
- AConsumer
that will call methods onUpdateAnalysisTemplateRequest.Builder
to create a request.- Returns:
- Result of the UpdateAnalysisTemplate operation returned by the service.
- See Also:
-
updateCollaboration
default UpdateCollaborationResponse updateCollaboration(UpdateCollaborationRequest updateCollaborationRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates collaboration metadata and can only be called by the collaboration owner.
- Parameters:
updateCollaborationRequest
-- Returns:
- Result of the UpdateCollaboration operation returned by the service.
- See Also:
-
updateCollaboration
default UpdateCollaborationResponse updateCollaboration(Consumer<UpdateCollaborationRequest.Builder> updateCollaborationRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates collaboration metadata and can only be called by the collaboration owner.
This is a convenience which creates an instance of the
UpdateCollaborationRequest.Builder
avoiding the need to create one manually viaUpdateCollaborationRequest.builder()
- Parameters:
updateCollaborationRequest
- AConsumer
that will call methods onUpdateCollaborationRequest.Builder
to create a request.- Returns:
- Result of the UpdateCollaboration operation returned by the service.
- See Also:
-
updateConfiguredTable
default UpdateConfiguredTableResponse updateConfiguredTable(UpdateConfiguredTableRequest updateConfiguredTableRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates a configured table.
- Parameters:
updateConfiguredTableRequest
-- Returns:
- Result of the UpdateConfiguredTable operation returned by the service.
- See Also:
-
updateConfiguredTable
default UpdateConfiguredTableResponse updateConfiguredTable(Consumer<UpdateConfiguredTableRequest.Builder> updateConfiguredTableRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates a configured table.
This is a convenience which creates an instance of the
UpdateConfiguredTableRequest.Builder
avoiding the need to create one manually viaUpdateConfiguredTableRequest.builder()
- Parameters:
updateConfiguredTableRequest
- AConsumer
that will call methods onUpdateConfiguredTableRequest.Builder
to create a request.- Returns:
- Result of the UpdateConfiguredTable operation returned by the service.
- See Also:
-
updateConfiguredTableAnalysisRule
default UpdateConfiguredTableAnalysisRuleResponse updateConfiguredTableAnalysisRule(UpdateConfiguredTableAnalysisRuleRequest updateConfiguredTableAnalysisRuleRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates a configured table analysis rule.
- Parameters:
updateConfiguredTableAnalysisRuleRequest
-- Returns:
- Result of the UpdateConfiguredTableAnalysisRule operation returned by the service.
- See Also:
-
updateConfiguredTableAnalysisRule
default UpdateConfiguredTableAnalysisRuleResponse updateConfiguredTableAnalysisRule(Consumer<UpdateConfiguredTableAnalysisRuleRequest.Builder> updateConfiguredTableAnalysisRuleRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates a configured table analysis rule.
This is a convenience which creates an instance of the
UpdateConfiguredTableAnalysisRuleRequest.Builder
avoiding the need to create one manually viaUpdateConfiguredTableAnalysisRuleRequest.builder()
- Parameters:
updateConfiguredTableAnalysisRuleRequest
- AConsumer
that will call methods onUpdateConfiguredTableAnalysisRuleRequest.Builder
to create a request.- Returns:
- Result of the UpdateConfiguredTableAnalysisRule operation returned by the service.
- See Also:
-
updateConfiguredTableAssociation
default UpdateConfiguredTableAssociationResponse updateConfiguredTableAssociation(UpdateConfiguredTableAssociationRequest updateConfiguredTableAssociationRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates a configured table association.
- Parameters:
updateConfiguredTableAssociationRequest
-- Returns:
- Result of the UpdateConfiguredTableAssociation operation returned by the service.
- See Also:
-
updateConfiguredTableAssociation
default UpdateConfiguredTableAssociationResponse updateConfiguredTableAssociation(Consumer<UpdateConfiguredTableAssociationRequest.Builder> updateConfiguredTableAssociationRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates a configured table association.
This is a convenience which creates an instance of the
UpdateConfiguredTableAssociationRequest.Builder
avoiding the need to create one manually viaUpdateConfiguredTableAssociationRequest.builder()
- Parameters:
updateConfiguredTableAssociationRequest
- AConsumer
that will call methods onUpdateConfiguredTableAssociationRequest.Builder
to create a request.- Returns:
- Result of the UpdateConfiguredTableAssociation operation returned by the service.
- See Also:
-
updateMembership
default UpdateMembershipResponse updateMembership(UpdateMembershipRequest updateMembershipRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates a membership.
- Parameters:
updateMembershipRequest
-- Returns:
- Result of the UpdateMembership operation returned by the service.
- See Also:
-
updateMembership
default UpdateMembershipResponse updateMembership(Consumer<UpdateMembershipRequest.Builder> updateMembershipRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates a membership.
This is a convenience which creates an instance of the
UpdateMembershipRequest.Builder
avoiding the need to create one manually viaUpdateMembershipRequest.builder()
- Parameters:
updateMembershipRequest
- AConsumer
that will call methods onUpdateMembershipRequest.Builder
to create a request.- Returns:
- Result of the UpdateMembership operation returned by the service.
- See Also:
-
updateProtectedQuery
default UpdateProtectedQueryResponse updateProtectedQuery(UpdateProtectedQueryRequest updateProtectedQueryRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates the processing of a currently running query.
- Parameters:
updateProtectedQueryRequest
-- Returns:
- Result of the UpdateProtectedQuery operation returned by the service.
- See Also:
-
updateProtectedQuery
default UpdateProtectedQueryResponse updateProtectedQuery(Consumer<UpdateProtectedQueryRequest.Builder> updateProtectedQueryRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, CleanRoomsException Updates the processing of a currently running query.
This is a convenience which creates an instance of the
UpdateProtectedQueryRequest.Builder
avoiding the need to create one manually viaUpdateProtectedQueryRequest.builder()
- Parameters:
updateProtectedQueryRequest
- AConsumer
that will call methods onUpdateProtectedQueryRequest.Builder
to create a request.- Returns:
- Result of the UpdateProtectedQuery operation returned by the service.
- See Also:
-
create
Create aCleanRoomsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCleanRoomsClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-