@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCleanRoomsClient extends AmazonWebServiceClient implements AWSCleanRooms
Welcome to the AWS Clean Rooms API Reference.
AWS Clean Rooms is an AWS 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 AWS Clean Rooms concepts, procedures, and best practices, see the AWS Clean Rooms User Guide.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSCleanRoomsClientBuilder builder()
public BatchGetSchemaResult batchGetSchema(BatchGetSchemaRequest request)
Retrieves multiple schemas by their identifiers.
batchGetSchema
in interface AWSCleanRooms
batchGetSchemaRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public CreateCollaborationResult createCollaboration(CreateCollaborationRequest request)
Creates a new collaboration.
createCollaboration
in interface AWSCleanRooms
createCollaborationRequest
- ServiceQuotaExceededException
- Request denied because service quota has been exceeded.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public CreateConfiguredTableResult createConfiguredTable(CreateConfiguredTableRequest request)
Creates a new configured table resource.
createConfiguredTable
in interface AWSCleanRooms
createConfiguredTableRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException
- Request denied because service quota has been exceeded.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public CreateConfiguredTableAnalysisRuleResult createConfiguredTableAnalysisRule(CreateConfiguredTableAnalysisRuleRequest request)
Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
createConfiguredTableAnalysisRule
in interface AWSCleanRooms
createConfiguredTableAnalysisRuleRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public CreateConfiguredTableAssociationResult createConfiguredTableAssociation(CreateConfiguredTableAssociationRequest request)
Creates a configured table association. A configured table association links a configured table with a collaboration.
createConfiguredTableAssociation
in interface AWSCleanRooms
createConfiguredTableAssociationRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException
- Request denied because service quota has been exceeded.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public CreateMembershipResult createMembership(CreateMembershipRequest request)
Creates a membership for a specific collaboration identifier and joins the collaboration.
createMembership
in interface AWSCleanRooms
createMembershipRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException
- Request denied because service quota has been exceeded.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public DeleteCollaborationResult deleteCollaboration(DeleteCollaborationRequest request)
Deletes a collaboration. It can only be called by the collaboration owner.
deleteCollaboration
in interface AWSCleanRooms
deleteCollaborationRequest
- InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public DeleteConfiguredTableResult deleteConfiguredTable(DeleteConfiguredTableRequest request)
Deletes a configured table.
deleteConfiguredTable
in interface AWSCleanRooms
deleteConfiguredTableRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public DeleteConfiguredTableAnalysisRuleResult deleteConfiguredTableAnalysisRule(DeleteConfiguredTableAnalysisRuleRequest request)
Deletes a configured table analysis rule.
deleteConfiguredTableAnalysisRule
in interface AWSCleanRooms
deleteConfiguredTableAnalysisRuleRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public DeleteConfiguredTableAssociationResult deleteConfiguredTableAssociation(DeleteConfiguredTableAssociationRequest request)
Deletes a configured table association.
deleteConfiguredTableAssociation
in interface AWSCleanRooms
deleteConfiguredTableAssociationRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public DeleteMemberResult deleteMember(DeleteMemberRequest request)
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.
deleteMember
in interface AWSCleanRooms
deleteMemberRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public DeleteMembershipResult deleteMembership(DeleteMembershipRequest request)
Deletes a specified membership. All resources under a membership must be deleted.
deleteMembership
in interface AWSCleanRooms
deleteMembershipRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public GetCollaborationResult getCollaboration(GetCollaborationRequest request)
Returns metadata about a collaboration.
getCollaboration
in interface AWSCleanRooms
getCollaborationRequest
- InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public GetConfiguredTableResult getConfiguredTable(GetConfiguredTableRequest request)
Retrieves a configured table.
getConfiguredTable
in interface AWSCleanRooms
getConfiguredTableRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public GetConfiguredTableAnalysisRuleResult getConfiguredTableAnalysisRule(GetConfiguredTableAnalysisRuleRequest request)
Retrieves a configured table analysis rule.
getConfiguredTableAnalysisRule
in interface AWSCleanRooms
getConfiguredTableAnalysisRuleRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public GetConfiguredTableAssociationResult getConfiguredTableAssociation(GetConfiguredTableAssociationRequest request)
Retrieves a configured table association.
getConfiguredTableAssociation
in interface AWSCleanRooms
getConfiguredTableAssociationRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public GetMembershipResult getMembership(GetMembershipRequest request)
Retrieves a specified membership for an identifier.
getMembership
in interface AWSCleanRooms
getMembershipRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public GetProtectedQueryResult getProtectedQuery(GetProtectedQueryRequest request)
Returns query processing metadata.
getProtectedQuery
in interface AWSCleanRooms
getProtectedQueryRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public GetSchemaResult getSchema(GetSchemaRequest request)
Retrieves the schema for a relation within a collaboration.
getSchema
in interface AWSCleanRooms
getSchemaRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public GetSchemaAnalysisRuleResult getSchemaAnalysisRule(GetSchemaAnalysisRuleRequest request)
Retrieves a schema analysis rule.
getSchemaAnalysisRule
in interface AWSCleanRooms
getSchemaAnalysisRuleRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public ListCollaborationsResult listCollaborations(ListCollaborationsRequest request)
Lists collaborations the caller owns, is active in, or has been invited to.
listCollaborations
in interface AWSCleanRooms
listCollaborationsRequest
- InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public ListConfiguredTableAssociationsResult listConfiguredTableAssociations(ListConfiguredTableAssociationsRequest request)
Lists configured table associations for a membership.
listConfiguredTableAssociations
in interface AWSCleanRooms
listConfiguredTableAssociationsRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public ListConfiguredTablesResult listConfiguredTables(ListConfiguredTablesRequest request)
Lists configured tables.
listConfiguredTables
in interface AWSCleanRooms
listConfiguredTablesRequest
- InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public ListMembersResult listMembers(ListMembersRequest request)
Lists all members within a collaboration.
listMembers
in interface AWSCleanRooms
listMembersRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public ListMembershipsResult listMemberships(ListMembershipsRequest request)
Lists all memberships resources within the caller's account.
listMemberships
in interface AWSCleanRooms
listMembershipsRequest
- InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public ListProtectedQueriesResult listProtectedQueries(ListProtectedQueriesRequest request)
Lists protected queries, sorted by the most recent query.
listProtectedQueries
in interface AWSCleanRooms
listProtectedQueriesRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public ListSchemasResult listSchemas(ListSchemasRequest request)
Lists the schemas for relations within a collaboration.
listSchemas
in interface AWSCleanRooms
listSchemasRequest
- ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all of the tags that have been added to a resource.
listTagsForResource
in interface AWSCleanRooms
listTagsForResourceRequest
- ResourceNotFoundException
- Request references a resource which does not exist.ValidationException
- The input fails to satisfy the specified constraints.public StartProtectedQueryResult startProtectedQuery(StartProtectedQueryRequest request)
Creates a protected query that is started by AWS Clean Rooms.
startProtectedQuery
in interface AWSCleanRooms
startProtectedQueryRequest
- ServiceQuotaExceededException
- Request denied because service quota has been exceeded.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public TagResourceResult tagResource(TagResourceRequest request)
Tags a resource.
tagResource
in interface AWSCleanRooms
tagResourceRequest
- ResourceNotFoundException
- Request references a resource which does not exist.ValidationException
- The input fails to satisfy the specified constraints.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag or list of tags from a resource.
untagResource
in interface AWSCleanRooms
untagResourceRequest
- ResourceNotFoundException
- Request references a resource which does not exist.ValidationException
- The input fails to satisfy the specified constraints.public UpdateCollaborationResult updateCollaboration(UpdateCollaborationRequest request)
Updates collaboration metadata and can only be called by the collaboration owner.
updateCollaboration
in interface AWSCleanRooms
updateCollaborationRequest
- InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public UpdateConfiguredTableResult updateConfiguredTable(UpdateConfiguredTableRequest request)
Updates a configured table.
updateConfiguredTable
in interface AWSCleanRooms
updateConfiguredTableRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public UpdateConfiguredTableAnalysisRuleResult updateConfiguredTableAnalysisRule(UpdateConfiguredTableAnalysisRuleRequest request)
Updates a configured table analysis rule.
updateConfiguredTableAnalysisRule
in interface AWSCleanRooms
updateConfiguredTableAnalysisRuleRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public UpdateConfiguredTableAssociationResult updateConfiguredTableAssociation(UpdateConfiguredTableAssociationRequest request)
Updates a configured table association.
updateConfiguredTableAssociation
in interface AWSCleanRooms
updateConfiguredTableAssociationRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public UpdateMembershipResult updateMembership(UpdateMembershipRequest request)
Updates a membership.
updateMembership
in interface AWSCleanRooms
updateMembershipRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public UpdateProtectedQueryResult updateProtectedQuery(UpdateProtectedQueryRequest request)
Updates the processing of a currently running query.
updateProtectedQuery
in interface AWSCleanRooms
updateProtectedQueryRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- Request references a resource which does not exist.InternalServerException
- Unexpected error during processing of request.ValidationException
- The input fails to satisfy the specified constraints.ThrottlingException
- Request was denied due to request throttling.AccessDeniedException
- Caller does not have sufficient access to perform this action.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSCleanRooms
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSCleanRooms
shutdown
in class AmazonWebServiceClient