@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCleanRoomsClient extends AmazonWebServiceClient implements AWSCleanRooms
AWS Clean Rooms is in preview release and is subject to change.
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 combined data 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.
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIXaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetprotected static final ClientConfigurationFactory configFactory
public static AWSCleanRoomsClientBuilder builder()
public BatchGetSchemaResult batchGetSchema(BatchGetSchemaRequest request)
Retrieves multiple schemas by their identifiers.
batchGetSchema in interface AWSCleanRoomsbatchGetSchemaRequest - 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 AWSCleanRoomscreateCollaborationRequest - 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 AWSCleanRoomscreateConfiguredTableRequest - 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 AWSCleanRoomscreateConfiguredTableAnalysisRuleRequest - 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 AWSCleanRoomscreateConfiguredTableAssociationRequest - 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 AWSCleanRoomscreateMembershipRequest - 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 AWSCleanRoomsdeleteCollaborationRequest - 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 AWSCleanRoomsdeleteConfiguredTableRequest - 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 AWSCleanRoomsdeleteConfiguredTableAnalysisRuleRequest - 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 AWSCleanRoomsdeleteConfiguredTableAssociationRequest - 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 AWSCleanRoomsdeleteMemberRequest - 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 AWSCleanRoomsdeleteMembershipRequest - 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 AWSCleanRoomsgetCollaborationRequest - 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 AWSCleanRoomsgetConfiguredTableRequest - 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 AWSCleanRoomsgetConfiguredTableAnalysisRuleRequest - 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 AWSCleanRoomsgetConfiguredTableAssociationRequest - 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 AWSCleanRoomsgetMembershipRequest - 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 AWSCleanRoomsgetProtectedQueryRequest - 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 AWSCleanRoomsgetSchemaRequest - 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 AWSCleanRoomsgetSchemaAnalysisRuleRequest - 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 AWSCleanRoomslistCollaborationsRequest - 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 AWSCleanRoomslistConfiguredTableAssociationsRequest - 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 AWSCleanRoomslistConfiguredTablesRequest - 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 AWSCleanRoomslistMembersRequest - 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 AWSCleanRoomslistMembershipsRequest - 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 AWSCleanRoomslistProtectedQueriesRequest - 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 AWSCleanRoomslistSchemasRequest - 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 StartProtectedQueryResult startProtectedQuery(StartProtectedQueryRequest request)
Creates a protected query that is started by AWS Clean Rooms.
startProtectedQuery in interface AWSCleanRoomsstartProtectedQueryRequest - 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 UpdateCollaborationResult updateCollaboration(UpdateCollaborationRequest request)
Updates collaboration metadata and can only be called by the collaboration owner.
updateCollaboration in interface AWSCleanRoomsupdateCollaborationRequest - 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 AWSCleanRoomsupdateConfiguredTableRequest - 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 AWSCleanRoomsupdateConfiguredTableAnalysisRuleRequest - 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 AWSCleanRoomsupdateConfiguredTableAssociationRequest - 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 AWSCleanRoomsupdateMembershipRequest - 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 AWSCleanRoomsupdateProtectedQueryRequest - 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 AWSCleanRoomsrequest - The originally executed requestpublic void shutdown()
AWSCleanRoomsshutdown in interface AWSCleanRoomsshutdown in class AmazonWebServiceClientCopyright © 2023. All rights reserved.