com.amazonaws.services.cleanrooms.AWSCleanRooms Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-cleanrooms Show documentation
Show all versions of aws-java-sdk-cleanrooms Show documentation
The AWS Java SDK for AWS Clean Rooms module holds the client classes that are used for communicating with AWS Clean Rooms Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cleanrooms;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.cleanrooms.model.*;
/**
* Interface for accessing AWS Clean Rooms Service.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.cleanrooms.AbstractAWSCleanRooms} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCleanRooms {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "cleanrooms";
/**
*
* Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
*
*
* @param batchGetCollaborationAnalysisTemplateRequest
* @return Result of the BatchGetCollaborationAnalysisTemplate operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.BatchGetCollaborationAnalysisTemplate
* @see AWS API Documentation
*/
BatchGetCollaborationAnalysisTemplateResult batchGetCollaborationAnalysisTemplate(
BatchGetCollaborationAnalysisTemplateRequest batchGetCollaborationAnalysisTemplateRequest);
/**
*
* Retrieves multiple schemas by their identifiers.
*
*
* @param batchGetSchemaRequest
* @return Result of the BatchGetSchema operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.BatchGetSchema
* @see AWS API
* Documentation
*/
BatchGetSchemaResult batchGetSchema(BatchGetSchemaRequest batchGetSchemaRequest);
/**
*
* Retrieves multiple analysis rule schemas.
*
*
* @param batchGetSchemaAnalysisRuleRequest
* @return Result of the BatchGetSchemaAnalysisRule operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.BatchGetSchemaAnalysisRule
* @see AWS API Documentation
*/
BatchGetSchemaAnalysisRuleResult batchGetSchemaAnalysisRule(BatchGetSchemaAnalysisRuleRequest batchGetSchemaAnalysisRuleRequest);
/**
*
* Creates a new analysis template.
*
*
* @param createAnalysisTemplateRequest
* @return Result of the CreateAnalysisTemplate operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ServiceQuotaExceededException
* Request denied because service quota has been exceeded.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreateAnalysisTemplate
* @see AWS API Documentation
*/
CreateAnalysisTemplateResult createAnalysisTemplate(CreateAnalysisTemplateRequest createAnalysisTemplateRequest);
/**
*
* Creates a new collaboration.
*
*
* @param createCollaborationRequest
* @return Result of the CreateCollaboration operation returned by the service.
* @throws ServiceQuotaExceededException
* Request denied because service quota has been exceeded.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreateCollaboration
* @see AWS
* API Documentation
*/
CreateCollaborationResult createCollaboration(CreateCollaborationRequest createCollaborationRequest);
/**
*
* Provides the details necessary to create a configured audience model association.
*
*
* @param createConfiguredAudienceModelAssociationRequest
* @return Result of the CreateConfiguredAudienceModelAssociation operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ServiceQuotaExceededException
* Request denied because service quota has been exceeded.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreateConfiguredAudienceModelAssociation
* @see AWS API Documentation
*/
CreateConfiguredAudienceModelAssociationResult createConfiguredAudienceModelAssociation(
CreateConfiguredAudienceModelAssociationRequest createConfiguredAudienceModelAssociationRequest);
/**
*
* Creates a new configured table resource.
*
*
* @param createConfiguredTableRequest
* @return Result of the CreateConfiguredTable operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ServiceQuotaExceededException
* Request denied because service quota has been exceeded.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreateConfiguredTable
* @see AWS API Documentation
*/
CreateConfiguredTableResult createConfiguredTable(CreateConfiguredTableRequest createConfiguredTableRequest);
/**
*
* Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given
* configured table.
*
*
* @param createConfiguredTableAnalysisRuleRequest
* @return Result of the CreateConfiguredTableAnalysisRule operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreateConfiguredTableAnalysisRule
* @see AWS API Documentation
*/
CreateConfiguredTableAnalysisRuleResult createConfiguredTableAnalysisRule(CreateConfiguredTableAnalysisRuleRequest createConfiguredTableAnalysisRuleRequest);
/**
*
* Creates a configured table association. A configured table association links a configured table with a
* collaboration.
*
*
* @param createConfiguredTableAssociationRequest
* @return Result of the CreateConfiguredTableAssociation operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ServiceQuotaExceededException
* Request denied because service quota has been exceeded.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreateConfiguredTableAssociation
* @see AWS API Documentation
*/
CreateConfiguredTableAssociationResult createConfiguredTableAssociation(CreateConfiguredTableAssociationRequest createConfiguredTableAssociationRequest);
/**
*
* Creates a new analysis rule for an associated configured table.
*
*
* @param createConfiguredTableAssociationAnalysisRuleRequest
* @return Result of the CreateConfiguredTableAssociationAnalysisRule operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreateConfiguredTableAssociationAnalysisRule
* @see AWS API Documentation
*/
CreateConfiguredTableAssociationAnalysisRuleResult createConfiguredTableAssociationAnalysisRule(
CreateConfiguredTableAssociationAnalysisRuleRequest createConfiguredTableAssociationAnalysisRuleRequest);
/**
*
* Creates an ID mapping table.
*
*
* @param createIdMappingTableRequest
* @return Result of the CreateIdMappingTable operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ServiceQuotaExceededException
* Request denied because service quota has been exceeded.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreateIdMappingTable
* @see AWS API Documentation
*/
CreateIdMappingTableResult createIdMappingTable(CreateIdMappingTableRequest createIdMappingTableRequest);
/**
*
* Creates a membership for a specific collaboration identifier and joins the collaboration.
*
*
* @param createMembershipRequest
* @return Result of the CreateMembership operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ServiceQuotaExceededException
* Request denied because service quota has been exceeded.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreateMembership
* @see AWS
* API Documentation
*/
CreateMembershipResult createMembership(CreateMembershipRequest createMembershipRequest);
/**
*
* Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget
* template, but it can be deleted and recreated. If you need to change the privacy budget template for a
* membership, use the UpdatePrivacyBudgetTemplate operation.
*
*
* @param createPrivacyBudgetTemplateRequest
* @return Result of the CreatePrivacyBudgetTemplate operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.CreatePrivacyBudgetTemplate
* @see AWS API Documentation
*/
CreatePrivacyBudgetTemplateResult createPrivacyBudgetTemplate(CreatePrivacyBudgetTemplateRequest createPrivacyBudgetTemplateRequest);
/**
*
* Deletes an analysis template.
*
*
* @param deleteAnalysisTemplateRequest
* @return Result of the DeleteAnalysisTemplate operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteAnalysisTemplate
* @see AWS API Documentation
*/
DeleteAnalysisTemplateResult deleteAnalysisTemplate(DeleteAnalysisTemplateRequest deleteAnalysisTemplateRequest);
/**
*
* Deletes a collaboration. It can only be called by the collaboration owner.
*
*
* @param deleteCollaborationRequest
* @return Result of the DeleteCollaboration operation returned by the service.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteCollaboration
* @see AWS
* API Documentation
*/
DeleteCollaborationResult deleteCollaboration(DeleteCollaborationRequest deleteCollaborationRequest);
/**
*
* Provides the information necessary to delete a configured audience model association.
*
*
* @param deleteConfiguredAudienceModelAssociationRequest
* @return Result of the DeleteConfiguredAudienceModelAssociation operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteConfiguredAudienceModelAssociation
* @see AWS API Documentation
*/
DeleteConfiguredAudienceModelAssociationResult deleteConfiguredAudienceModelAssociation(
DeleteConfiguredAudienceModelAssociationRequest deleteConfiguredAudienceModelAssociationRequest);
/**
*
* Deletes a configured table.
*
*
* @param deleteConfiguredTableRequest
* @return Result of the DeleteConfiguredTable operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteConfiguredTable
* @see AWS API Documentation
*/
DeleteConfiguredTableResult deleteConfiguredTable(DeleteConfiguredTableRequest deleteConfiguredTableRequest);
/**
*
* Deletes a configured table analysis rule.
*
*
* @param deleteConfiguredTableAnalysisRuleRequest
* @return Result of the DeleteConfiguredTableAnalysisRule operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteConfiguredTableAnalysisRule
* @see AWS API Documentation
*/
DeleteConfiguredTableAnalysisRuleResult deleteConfiguredTableAnalysisRule(DeleteConfiguredTableAnalysisRuleRequest deleteConfiguredTableAnalysisRuleRequest);
/**
*
* Deletes a configured table association.
*
*
* @param deleteConfiguredTableAssociationRequest
* @return Result of the DeleteConfiguredTableAssociation operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteConfiguredTableAssociation
* @see AWS API Documentation
*/
DeleteConfiguredTableAssociationResult deleteConfiguredTableAssociation(DeleteConfiguredTableAssociationRequest deleteConfiguredTableAssociationRequest);
/**
*
* Deletes an analysis rule for a configured table association.
*
*
* @param deleteConfiguredTableAssociationAnalysisRuleRequest
* @return Result of the DeleteConfiguredTableAssociationAnalysisRule operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteConfiguredTableAssociationAnalysisRule
* @see AWS API Documentation
*/
DeleteConfiguredTableAssociationAnalysisRuleResult deleteConfiguredTableAssociationAnalysisRule(
DeleteConfiguredTableAssociationAnalysisRuleRequest deleteConfiguredTableAssociationAnalysisRuleRequest);
/**
*
* Deletes an ID mapping table.
*
*
* @param deleteIdMappingTableRequest
* @return Result of the DeleteIdMappingTable operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteIdMappingTable
* @see AWS API Documentation
*/
DeleteIdMappingTableResult deleteIdMappingTable(DeleteIdMappingTableRequest deleteIdMappingTableRequest);
/**
*
* Deletes an ID namespace association.
*
*
* @param deleteIdNamespaceAssociationRequest
* @return Result of the DeleteIdNamespaceAssociation operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteIdNamespaceAssociation
* @see AWS API Documentation
*/
DeleteIdNamespaceAssociationResult deleteIdNamespaceAssociation(DeleteIdNamespaceAssociationRequest deleteIdNamespaceAssociationRequest);
/**
*
* 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.
*
*
* @param deleteMemberRequest
* @return Result of the DeleteMember operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteMember
* @see AWS API
* Documentation
*/
DeleteMemberResult deleteMember(DeleteMemberRequest deleteMemberRequest);
/**
*
* Deletes a specified membership. All resources under a membership must be deleted.
*
*
* @param deleteMembershipRequest
* @return Result of the DeleteMembership operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeleteMembership
* @see AWS
* API Documentation
*/
DeleteMembershipResult deleteMembership(DeleteMembershipRequest deleteMembershipRequest);
/**
*
* Deletes a privacy budget template for a specified membership.
*
*
* @param deletePrivacyBudgetTemplateRequest
* @return Result of the DeletePrivacyBudgetTemplate operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.DeletePrivacyBudgetTemplate
* @see AWS API Documentation
*/
DeletePrivacyBudgetTemplateResult deletePrivacyBudgetTemplate(DeletePrivacyBudgetTemplateRequest deletePrivacyBudgetTemplateRequest);
/**
*
* Retrieves an analysis template.
*
*
* @param getAnalysisTemplateRequest
* @return Result of the GetAnalysisTemplate operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetAnalysisTemplate
* @see AWS
* API Documentation
*/
GetAnalysisTemplateResult getAnalysisTemplate(GetAnalysisTemplateRequest getAnalysisTemplateRequest);
/**
*
* Returns metadata about a collaboration.
*
*
* @param getCollaborationRequest
* @return Result of the GetCollaboration operation returned by the service.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetCollaboration
* @see AWS
* API Documentation
*/
GetCollaborationResult getCollaboration(GetCollaborationRequest getCollaborationRequest);
/**
*
* Retrieves an analysis template within a collaboration.
*
*
* @param getCollaborationAnalysisTemplateRequest
* @return Result of the GetCollaborationAnalysisTemplate operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetCollaborationAnalysisTemplate
* @see AWS API Documentation
*/
GetCollaborationAnalysisTemplateResult getCollaborationAnalysisTemplate(GetCollaborationAnalysisTemplateRequest getCollaborationAnalysisTemplateRequest);
/**
*
* Retrieves a configured audience model association within a collaboration.
*
*
* @param getCollaborationConfiguredAudienceModelAssociationRequest
* @return Result of the GetCollaborationConfiguredAudienceModelAssociation operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetCollaborationConfiguredAudienceModelAssociation
* @see AWS API Documentation
*/
GetCollaborationConfiguredAudienceModelAssociationResult getCollaborationConfiguredAudienceModelAssociation(
GetCollaborationConfiguredAudienceModelAssociationRequest getCollaborationConfiguredAudienceModelAssociationRequest);
/**
*
* Returns details about a specified privacy budget template.
*
*
* @param getCollaborationPrivacyBudgetTemplateRequest
* @return Result of the GetCollaborationPrivacyBudgetTemplate operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetCollaborationPrivacyBudgetTemplate
* @see AWS API Documentation
*/
GetCollaborationPrivacyBudgetTemplateResult getCollaborationPrivacyBudgetTemplate(
GetCollaborationPrivacyBudgetTemplateRequest getCollaborationPrivacyBudgetTemplateRequest);
/**
*
* Returns information about a configured audience model association.
*
*
* @param getConfiguredAudienceModelAssociationRequest
* @return Result of the GetConfiguredAudienceModelAssociation operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetConfiguredAudienceModelAssociation
* @see AWS API Documentation
*/
GetConfiguredAudienceModelAssociationResult getConfiguredAudienceModelAssociation(
GetConfiguredAudienceModelAssociationRequest getConfiguredAudienceModelAssociationRequest);
/**
*
* Retrieves a configured table.
*
*
* @param getConfiguredTableRequest
* @return Result of the GetConfiguredTable operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetConfiguredTable
* @see AWS
* API Documentation
*/
GetConfiguredTableResult getConfiguredTable(GetConfiguredTableRequest getConfiguredTableRequest);
/**
*
* Retrieves a configured table analysis rule.
*
*
* @param getConfiguredTableAnalysisRuleRequest
* @return Result of the GetConfiguredTableAnalysisRule operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetConfiguredTableAnalysisRule
* @see AWS API Documentation
*/
GetConfiguredTableAnalysisRuleResult getConfiguredTableAnalysisRule(GetConfiguredTableAnalysisRuleRequest getConfiguredTableAnalysisRuleRequest);
/**
*
* Retrieves a configured table association.
*
*
* @param getConfiguredTableAssociationRequest
* @return Result of the GetConfiguredTableAssociation operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetConfiguredTableAssociation
* @see AWS API Documentation
*/
GetConfiguredTableAssociationResult getConfiguredTableAssociation(GetConfiguredTableAssociationRequest getConfiguredTableAssociationRequest);
/**
*
* Retrieves the analysis rule for a configured table association.
*
*
* @param getConfiguredTableAssociationAnalysisRuleRequest
* @return Result of the GetConfiguredTableAssociationAnalysisRule operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetConfiguredTableAssociationAnalysisRule
* @see AWS API Documentation
*/
GetConfiguredTableAssociationAnalysisRuleResult getConfiguredTableAssociationAnalysisRule(
GetConfiguredTableAssociationAnalysisRuleRequest getConfiguredTableAssociationAnalysisRuleRequest);
/**
*
* Retrieves an ID mapping table.
*
*
* @param getIdMappingTableRequest
* @return Result of the GetIdMappingTable operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetIdMappingTable
* @see AWS
* API Documentation
*/
GetIdMappingTableResult getIdMappingTable(GetIdMappingTableRequest getIdMappingTableRequest);
/**
*
* Retrieves a specified membership for an identifier.
*
*
* @param getMembershipRequest
* @return Result of the GetMembership operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetMembership
* @see AWS API
* Documentation
*/
GetMembershipResult getMembership(GetMembershipRequest getMembershipRequest);
/**
*
* Returns details for a specified privacy budget template.
*
*
* @param getPrivacyBudgetTemplateRequest
* @return Result of the GetPrivacyBudgetTemplate operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetPrivacyBudgetTemplate
* @see AWS API Documentation
*/
GetPrivacyBudgetTemplateResult getPrivacyBudgetTemplate(GetPrivacyBudgetTemplateRequest getPrivacyBudgetTemplateRequest);
/**
*
* Returns query processing metadata.
*
*
* @param getProtectedQueryRequest
* @return Result of the GetProtectedQuery operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetProtectedQuery
* @see AWS
* API Documentation
*/
GetProtectedQueryResult getProtectedQuery(GetProtectedQueryRequest getProtectedQueryRequest);
/**
*
* Retrieves the schema for a relation within a collaboration.
*
*
* @param getSchemaRequest
* @return Result of the GetSchema operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetSchema
* @see AWS API
* Documentation
*/
GetSchemaResult getSchema(GetSchemaRequest getSchemaRequest);
/**
*
* Retrieves a schema analysis rule.
*
*
* @param getSchemaAnalysisRuleRequest
* @return Result of the GetSchemaAnalysisRule operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.GetSchemaAnalysisRule
* @see AWS API Documentation
*/
GetSchemaAnalysisRuleResult getSchemaAnalysisRule(GetSchemaAnalysisRuleRequest getSchemaAnalysisRuleRequest);
/**
*
* Lists analysis templates that the caller owns.
*
*
* @param listAnalysisTemplatesRequest
* @return Result of the ListAnalysisTemplates operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListAnalysisTemplates
* @see AWS API Documentation
*/
ListAnalysisTemplatesResult listAnalysisTemplates(ListAnalysisTemplatesRequest listAnalysisTemplatesRequest);
/**
*
* Lists analysis templates within a collaboration.
*
*
* @param listCollaborationAnalysisTemplatesRequest
* @return Result of the ListCollaborationAnalysisTemplates operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListCollaborationAnalysisTemplates
* @see AWS API Documentation
*/
ListCollaborationAnalysisTemplatesResult listCollaborationAnalysisTemplates(
ListCollaborationAnalysisTemplatesRequest listCollaborationAnalysisTemplatesRequest);
/**
*
* Lists configured audience model associations within a collaboration.
*
*
* @param listCollaborationConfiguredAudienceModelAssociationsRequest
* @return Result of the ListCollaborationConfiguredAudienceModelAssociations operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListCollaborationConfiguredAudienceModelAssociations
* @see AWS API Documentation
*/
ListCollaborationConfiguredAudienceModelAssociationsResult listCollaborationConfiguredAudienceModelAssociations(
ListCollaborationConfiguredAudienceModelAssociationsRequest listCollaborationConfiguredAudienceModelAssociationsRequest);
/**
*
* Returns a list of the ID namespace associations in a collaboration.
*
*
* @param listCollaborationIdNamespaceAssociationsRequest
* @return Result of the ListCollaborationIdNamespaceAssociations operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListCollaborationIdNamespaceAssociations
* @see AWS API Documentation
*/
ListCollaborationIdNamespaceAssociationsResult listCollaborationIdNamespaceAssociations(
ListCollaborationIdNamespaceAssociationsRequest listCollaborationIdNamespaceAssociationsRequest);
/**
*
* Returns an array that summarizes each privacy budget template in a specified collaboration.
*
*
* @param listCollaborationPrivacyBudgetTemplatesRequest
* @return Result of the ListCollaborationPrivacyBudgetTemplates operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListCollaborationPrivacyBudgetTemplates
* @see AWS API Documentation
*/
ListCollaborationPrivacyBudgetTemplatesResult listCollaborationPrivacyBudgetTemplates(
ListCollaborationPrivacyBudgetTemplatesRequest listCollaborationPrivacyBudgetTemplatesRequest);
/**
*
* Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the
* collaboration ARN, creation time, creating account, and privacy budget details.
*
*
* @param listCollaborationPrivacyBudgetsRequest
* @return Result of the ListCollaborationPrivacyBudgets operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListCollaborationPrivacyBudgets
* @see AWS API Documentation
*/
ListCollaborationPrivacyBudgetsResult listCollaborationPrivacyBudgets(ListCollaborationPrivacyBudgetsRequest listCollaborationPrivacyBudgetsRequest);
/**
*
* Lists collaborations the caller owns, is active in, or has been invited to.
*
*
* @param listCollaborationsRequest
* @return Result of the ListCollaborations operation returned by the service.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListCollaborations
* @see AWS
* API Documentation
*/
ListCollaborationsResult listCollaborations(ListCollaborationsRequest listCollaborationsRequest);
/**
*
* Lists information about requested configured audience model associations.
*
*
* @param listConfiguredAudienceModelAssociationsRequest
* @return Result of the ListConfiguredAudienceModelAssociations operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListConfiguredAudienceModelAssociations
* @see AWS API Documentation
*/
ListConfiguredAudienceModelAssociationsResult listConfiguredAudienceModelAssociations(
ListConfiguredAudienceModelAssociationsRequest listConfiguredAudienceModelAssociationsRequest);
/**
*
* Lists configured table associations for a membership.
*
*
* @param listConfiguredTableAssociationsRequest
* @return Result of the ListConfiguredTableAssociations operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListConfiguredTableAssociations
* @see AWS API Documentation
*/
ListConfiguredTableAssociationsResult listConfiguredTableAssociations(ListConfiguredTableAssociationsRequest listConfiguredTableAssociationsRequest);
/**
*
* Lists configured tables.
*
*
* @param listConfiguredTablesRequest
* @return Result of the ListConfiguredTables operation returned by the service.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListConfiguredTables
* @see AWS API Documentation
*/
ListConfiguredTablesResult listConfiguredTables(ListConfiguredTablesRequest listConfiguredTablesRequest);
/**
*
* Returns a list of ID mapping tables.
*
*
* @param listIdMappingTablesRequest
* @return Result of the ListIdMappingTables operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListIdMappingTables
* @see AWS
* API Documentation
*/
ListIdMappingTablesResult listIdMappingTables(ListIdMappingTablesRequest listIdMappingTablesRequest);
/**
*
* Returns a list of ID namespace associations.
*
*
* @param listIdNamespaceAssociationsRequest
* @return Result of the ListIdNamespaceAssociations operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListIdNamespaceAssociations
* @see AWS API Documentation
*/
ListIdNamespaceAssociationsResult listIdNamespaceAssociations(ListIdNamespaceAssociationsRequest listIdNamespaceAssociationsRequest);
/**
*
* Lists all members within a collaboration.
*
*
* @param listMembersRequest
* @return Result of the ListMembers operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListMembers
* @see AWS API
* Documentation
*/
ListMembersResult listMembers(ListMembersRequest listMembersRequest);
/**
*
* Lists all memberships resources within the caller's account.
*
*
* @param listMembershipsRequest
* @return Result of the ListMemberships operation returned by the service.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListMemberships
* @see AWS API
* Documentation
*/
ListMembershipsResult listMemberships(ListMembershipsRequest listMembershipsRequest);
/**
*
* Returns detailed information about the privacy budget templates in a specified membership.
*
*
* @param listPrivacyBudgetTemplatesRequest
* @return Result of the ListPrivacyBudgetTemplates operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListPrivacyBudgetTemplates
* @see AWS API Documentation
*/
ListPrivacyBudgetTemplatesResult listPrivacyBudgetTemplates(ListPrivacyBudgetTemplatesRequest listPrivacyBudgetTemplatesRequest);
/**
*
* Returns detailed information about the privacy budgets in a specified membership.
*
*
* @param listPrivacyBudgetsRequest
* @return Result of the ListPrivacyBudgets operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListPrivacyBudgets
* @see AWS
* API Documentation
*/
ListPrivacyBudgetsResult listPrivacyBudgets(ListPrivacyBudgetsRequest listPrivacyBudgetsRequest);
/**
*
* Lists protected queries, sorted by the most recent query.
*
*
* @param listProtectedQueriesRequest
* @return Result of the ListProtectedQueries operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListProtectedQueries
* @see AWS API Documentation
*/
ListProtectedQueriesResult listProtectedQueries(ListProtectedQueriesRequest listProtectedQueriesRequest);
/**
*
* Lists the schemas for relations within a collaboration.
*
*
* @param listSchemasRequest
* @return Result of the ListSchemas operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.ListSchemas
* @see AWS API
* Documentation
*/
ListSchemasResult listSchemas(ListSchemasRequest listSchemasRequest);
/**
*
* Lists all of the tags that have been added to a resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @sample AWSCleanRooms.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Defines the information that's necessary to populate an ID mapping table.
*
*
* @param populateIdMappingTableRequest
* @return Result of the PopulateIdMappingTable operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.PopulateIdMappingTable
* @see AWS API Documentation
*/
PopulateIdMappingTableResult populateIdMappingTable(PopulateIdMappingTableRequest populateIdMappingTableRequest);
/**
*
* An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise
* parameters.
*
*
* @param previewPrivacyImpactRequest
* @return Result of the PreviewPrivacyImpact operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.PreviewPrivacyImpact
* @see AWS API Documentation
*/
PreviewPrivacyImpactResult previewPrivacyImpact(PreviewPrivacyImpactRequest previewPrivacyImpactRequest);
/**
*
* Creates a protected query that is started by Clean Rooms.
*
*
* @param startProtectedQueryRequest
* @return Result of the StartProtectedQuery operation returned by the service.
* @throws ServiceQuotaExceededException
* Request denied because service quota has been exceeded.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.StartProtectedQuery
* @see AWS
* API Documentation
*/
StartProtectedQueryResult startProtectedQuery(StartProtectedQueryRequest startProtectedQueryRequest);
/**
*
* Tags a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @sample AWSCleanRooms.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes a tag or list of tags from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @sample AWSCleanRooms.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the analysis template metadata.
*
*
* @param updateAnalysisTemplateRequest
* @return Result of the UpdateAnalysisTemplate operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateAnalysisTemplate
* @see AWS API Documentation
*/
UpdateAnalysisTemplateResult updateAnalysisTemplate(UpdateAnalysisTemplateRequest updateAnalysisTemplateRequest);
/**
*
* Updates collaboration metadata and can only be called by the collaboration owner.
*
*
* @param updateCollaborationRequest
* @return Result of the UpdateCollaboration operation returned by the service.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateCollaboration
* @see AWS
* API Documentation
*/
UpdateCollaborationResult updateCollaboration(UpdateCollaborationRequest updateCollaborationRequest);
/**
*
* Provides the details necessary to update a configured audience model association.
*
*
* @param updateConfiguredAudienceModelAssociationRequest
* @return Result of the UpdateConfiguredAudienceModelAssociation operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateConfiguredAudienceModelAssociation
* @see AWS API Documentation
*/
UpdateConfiguredAudienceModelAssociationResult updateConfiguredAudienceModelAssociation(
UpdateConfiguredAudienceModelAssociationRequest updateConfiguredAudienceModelAssociationRequest);
/**
*
* Updates a configured table.
*
*
* @param updateConfiguredTableRequest
* @return Result of the UpdateConfiguredTable operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateConfiguredTable
* @see AWS API Documentation
*/
UpdateConfiguredTableResult updateConfiguredTable(UpdateConfiguredTableRequest updateConfiguredTableRequest);
/**
*
* Updates a configured table analysis rule.
*
*
* @param updateConfiguredTableAnalysisRuleRequest
* @return Result of the UpdateConfiguredTableAnalysisRule operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateConfiguredTableAnalysisRule
* @see AWS API Documentation
*/
UpdateConfiguredTableAnalysisRuleResult updateConfiguredTableAnalysisRule(UpdateConfiguredTableAnalysisRuleRequest updateConfiguredTableAnalysisRuleRequest);
/**
*
* Updates a configured table association.
*
*
* @param updateConfiguredTableAssociationRequest
* @return Result of the UpdateConfiguredTableAssociation operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateConfiguredTableAssociation
* @see AWS API Documentation
*/
UpdateConfiguredTableAssociationResult updateConfiguredTableAssociation(UpdateConfiguredTableAssociationRequest updateConfiguredTableAssociationRequest);
/**
*
* Updates the analysis rule for a configured table association.
*
*
* @param updateConfiguredTableAssociationAnalysisRuleRequest
* @return Result of the UpdateConfiguredTableAssociationAnalysisRule operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateConfiguredTableAssociationAnalysisRule
* @see AWS API Documentation
*/
UpdateConfiguredTableAssociationAnalysisRuleResult updateConfiguredTableAssociationAnalysisRule(
UpdateConfiguredTableAssociationAnalysisRuleRequest updateConfiguredTableAssociationAnalysisRuleRequest);
/**
*
* Provides the details that are necessary to update an ID mapping table.
*
*
* @param updateIdMappingTableRequest
* @return Result of the UpdateIdMappingTable operation returned by the service.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateIdMappingTable
* @see AWS API Documentation
*/
UpdateIdMappingTableResult updateIdMappingTable(UpdateIdMappingTableRequest updateIdMappingTableRequest);
/**
*
* Updates a membership.
*
*
* @param updateMembershipRequest
* @return Result of the UpdateMembership operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateMembership
* @see AWS
* API Documentation
*/
UpdateMembershipResult updateMembership(UpdateMembershipRequest updateMembershipRequest);
/**
*
* Updates the privacy budget template for the specified membership.
*
*
* @param updatePrivacyBudgetTemplateRequest
* @return Result of the UpdatePrivacyBudgetTemplate operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdatePrivacyBudgetTemplate
* @see AWS API Documentation
*/
UpdatePrivacyBudgetTemplateResult updatePrivacyBudgetTemplate(UpdatePrivacyBudgetTemplateRequest updatePrivacyBudgetTemplateRequest);
/**
*
* Updates the processing of a currently running query.
*
*
* @param updateProtectedQueryRequest
* @return Result of the UpdateProtectedQuery operation returned by the service.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* Request references a resource which does not exist.
* @throws InternalServerException
* Unexpected error during processing of request.
* @throws ValidationException
* The input fails to satisfy the specified constraints.
* @throws ThrottlingException
* Request was denied due to request throttling.
* @throws AccessDeniedException
* Caller does not have sufficient access to perform this action.
* @sample AWSCleanRooms.UpdateProtectedQuery
* @see AWS API Documentation
*/
UpdateProtectedQueryResult updateProtectedQuery(UpdateProtectedQueryRequest updateProtectedQueryRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* 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 a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}