# Actions The following actions are supported: + [BatchGetCollaborationAnalysisTemplate](API_BatchGetCollaborationAnalysisTemplate.md) + [BatchGetSchema](API_BatchGetSchema.md) + [BatchGetSchemaAnalysisRule](API_BatchGetSchemaAnalysisRule.md) + [CreateAnalysisTemplate](API_CreateAnalysisTemplate.md) + [CreateCollaboration](API_CreateCollaboration.md) + [CreateCollaborationChangeRequest](API_CreateCollaborationChangeRequest.md) + [CreateConfiguredAudienceModelAssociation](API_CreateConfiguredAudienceModelAssociation.md) + [CreateConfiguredTable](API_CreateConfiguredTable.md) + [CreateConfiguredTableAnalysisRule](API_CreateConfiguredTableAnalysisRule.md) + [CreateConfiguredTableAssociation](API_CreateConfiguredTableAssociation.md) + [CreateConfiguredTableAssociationAnalysisRule](API_CreateConfiguredTableAssociationAnalysisRule.md) + [CreateIdMappingTable](API_CreateIdMappingTable.md) + [CreateIdNamespaceAssociation](API_CreateIdNamespaceAssociation.md) + [CreateMembership](API_CreateMembership.md) + [CreatePrivacyBudgetTemplate](API_CreatePrivacyBudgetTemplate.md) + [DeleteAnalysisTemplate](API_DeleteAnalysisTemplate.md) + [DeleteCollaboration](API_DeleteCollaboration.md) + [DeleteConfiguredAudienceModelAssociation](API_DeleteConfiguredAudienceModelAssociation.md) + [DeleteConfiguredTable](API_DeleteConfiguredTable.md) + [DeleteConfiguredTableAnalysisRule](API_DeleteConfiguredTableAnalysisRule.md) + [DeleteConfiguredTableAssociation](API_DeleteConfiguredTableAssociation.md) + [DeleteConfiguredTableAssociationAnalysisRule](API_DeleteConfiguredTableAssociationAnalysisRule.md) + [DeleteIdMappingTable](API_DeleteIdMappingTable.md) + [DeleteIdNamespaceAssociation](API_DeleteIdNamespaceAssociation.md) + [DeleteMember](API_DeleteMember.md) + [DeleteMembership](API_DeleteMembership.md) + [DeletePrivacyBudgetTemplate](API_DeletePrivacyBudgetTemplate.md) + [GetAnalysisTemplate](API_GetAnalysisTemplate.md) + [GetCollaboration](API_GetCollaboration.md) + [GetCollaborationAnalysisTemplate](API_GetCollaborationAnalysisTemplate.md) + [GetCollaborationChangeRequest](API_GetCollaborationChangeRequest.md) + [GetCollaborationConfiguredAudienceModelAssociation](API_GetCollaborationConfiguredAudienceModelAssociation.md) + [GetCollaborationIdNamespaceAssociation](API_GetCollaborationIdNamespaceAssociation.md) + [GetCollaborationPrivacyBudgetTemplate](API_GetCollaborationPrivacyBudgetTemplate.md) + [GetConfiguredAudienceModelAssociation](API_GetConfiguredAudienceModelAssociation.md) + [GetConfiguredTable](API_GetConfiguredTable.md) + [GetConfiguredTableAnalysisRule](API_GetConfiguredTableAnalysisRule.md) + [GetConfiguredTableAssociation](API_GetConfiguredTableAssociation.md) + [GetConfiguredTableAssociationAnalysisRule](API_GetConfiguredTableAssociationAnalysisRule.md) + [GetIdMappingTable](API_GetIdMappingTable.md) + [GetIdNamespaceAssociation](API_GetIdNamespaceAssociation.md) + [GetMembership](API_GetMembership.md) + [GetPrivacyBudgetTemplate](API_GetPrivacyBudgetTemplate.md) + [GetProtectedJob](API_GetProtectedJob.md) + [GetProtectedQuery](API_GetProtectedQuery.md) + [GetSchema](API_GetSchema.md) + [GetSchemaAnalysisRule](API_GetSchemaAnalysisRule.md) + [ListAnalysisTemplates](API_ListAnalysisTemplates.md) + [ListCollaborationAnalysisTemplates](API_ListCollaborationAnalysisTemplates.md) + [ListCollaborationChangeRequests](API_ListCollaborationChangeRequests.md) + [ListCollaborationConfiguredAudienceModelAssociations](API_ListCollaborationConfiguredAudienceModelAssociations.md) + [ListCollaborationIdNamespaceAssociations](API_ListCollaborationIdNamespaceAssociations.md) + [ListCollaborationPrivacyBudgets](API_ListCollaborationPrivacyBudgets.md) + [ListCollaborationPrivacyBudgetTemplates](API_ListCollaborationPrivacyBudgetTemplates.md) + [ListCollaborations](API_ListCollaborations.md) + [ListConfiguredAudienceModelAssociations](API_ListConfiguredAudienceModelAssociations.md) + [ListConfiguredTableAssociations](API_ListConfiguredTableAssociations.md) + [ListConfiguredTables](API_ListConfiguredTables.md) + [ListIdMappingTables](API_ListIdMappingTables.md) + [ListIdNamespaceAssociations](API_ListIdNamespaceAssociations.md) + [ListMembers](API_ListMembers.md) + [ListMemberships](API_ListMemberships.md) + [ListPrivacyBudgets](API_ListPrivacyBudgets.md) + [ListPrivacyBudgetTemplates](API_ListPrivacyBudgetTemplates.md) + [ListProtectedJobs](API_ListProtectedJobs.md) + [ListProtectedQueries](API_ListProtectedQueries.md) + [ListSchemas](API_ListSchemas.md) + [ListTagsForResource](API_ListTagsForResource.md) + [PopulateIdMappingTable](API_PopulateIdMappingTable.md) + [PreviewPrivacyImpact](API_PreviewPrivacyImpact.md) + [StartProtectedJob](API_StartProtectedJob.md) + [StartProtectedQuery](API_StartProtectedQuery.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateAnalysisTemplate](API_UpdateAnalysisTemplate.md) + [UpdateCollaboration](API_UpdateCollaboration.md) + [UpdateCollaborationChangeRequest](API_UpdateCollaborationChangeRequest.md) + [UpdateConfiguredAudienceModelAssociation](API_UpdateConfiguredAudienceModelAssociation.md) + [UpdateConfiguredTable](API_UpdateConfiguredTable.md) + [UpdateConfiguredTableAnalysisRule](API_UpdateConfiguredTableAnalysisRule.md) + [UpdateConfiguredTableAssociation](API_UpdateConfiguredTableAssociation.md) + [UpdateConfiguredTableAssociationAnalysisRule](API_UpdateConfiguredTableAssociationAnalysisRule.md) + [UpdateIdMappingTable](API_UpdateIdMappingTable.md) + [UpdateIdNamespaceAssociation](API_UpdateIdNamespaceAssociation.md) + [UpdateMembership](API_UpdateMembership.md) + [UpdatePrivacyBudgetTemplate](API_UpdatePrivacyBudgetTemplate.md) + [UpdateProtectedJob](API_UpdateProtectedJob.md) + [UpdateProtectedQuery](API_UpdateProtectedQuery.md) # BatchGetCollaborationAnalysisTemplate Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs). ## Request Syntax ``` POST /collaborations/collaborationIdentifier/batch-analysistemplates HTTP/1.1 Content-type: application/json { "analysisTemplateArns": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_BatchGetCollaborationAnalysisTemplate_RequestSyntax) ** A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [analysisTemplateArns](#API_BatchGetCollaborationAnalysisTemplate_RequestSyntax) ** The Amazon Resource Name (ARN) associated with the analysis template within a collaboration. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 0. Maximum length of 200. Pattern: `arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationAnalysisTemplates": [ { "analysisParameters": [ { "defaultValue": "string", "name": "string", "type": "string" } ], "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "description": "string", "errorMessageConfiguration": { "type": "string" }, "format": "string", "id": "string", "name": "string", "schema": { "referencedTables": [ "string" ] }, "source": { ... }, "sourceMetadata": { ... }, "syntheticDataParameters": { ... }, "updateTime": number, "validations": [ { "reasons": [ { "message": "string" } ], "status": "string", "type": "string" } ] } ], "errors": [ { "arn": "string", "code": "string", "message": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationAnalysisTemplates](#API_BatchGetCollaborationAnalysisTemplate_ResponseSyntax) ** The retrieved list of analysis templates within a collaboration. Type: Array of [CollaborationAnalysisTemplate](API_CollaborationAnalysisTemplate.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. ** [errors](#API_BatchGetCollaborationAnalysisTemplate_ResponseSyntax) ** Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved. Type: Array of [BatchGetCollaborationAnalysisTemplateError](API_BatchGetCollaborationAnalysisTemplateError.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplate) # BatchGetSchema Retrieves multiple schemas by their identifiers. ## Request Syntax ``` POST /collaborations/collaborationIdentifier/batch-schema HTTP/1.1 Content-type: application/json { "names": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_BatchGetSchema_RequestSyntax) ** A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [names](#API_BatchGetSchema_RequestSyntax) ** The names for the schema objects to retrieve. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "errors": [ { "code": "string", "message": "string", "name": "string" } ], "schemas": [ { "analysisMethod": "string", "analysisRuleTypes": [ "string" ], "collaborationArn": "string", "collaborationId": "string", "columns": [ { "name": "string", "type": "string" } ], "createTime": number, "creatorAccountId": "string", "description": "string", "name": "string", "partitionKeys": [ { "name": "string", "type": "string" } ], "resourceArn": "string", "schemaStatusDetails": [ { "analysisRuleType": "string", "analysisType": "string", "configurations": [ "string" ], "reasons": [ { "code": "string", "message": "string" } ], "status": "string" } ], "schemaTypeProperties": { ... }, "selectedAnalysisMethods": [ "string" ], "type": "string", "updateTime": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [errors](#API_BatchGetSchema_ResponseSyntax) ** Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved. Type: Array of [BatchGetSchemaError](API_BatchGetSchemaError.md) objects Array Members: Minimum number of 0 items. Maximum number of 25 items. ** [schemas](#API_BatchGetSchema_ResponseSyntax) ** The retrieved list of schemas. Type: Array of [Schema](API_Schema.md) objects Array Members: Minimum number of 0 items. Maximum number of 25 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/BatchGetSchema) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/BatchGetSchema) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/BatchGetSchema) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/BatchGetSchema) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/BatchGetSchema) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/BatchGetSchema) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/BatchGetSchema) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/BatchGetSchema) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/BatchGetSchema) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/BatchGetSchema) # BatchGetSchemaAnalysisRule Retrieves multiple analysis rule schemas. ## Request Syntax ``` POST /collaborations/collaborationIdentifier/batch-schema-analysis-rule HTTP/1.1 Content-type: application/json { "schemaAnalysisRuleRequests": [ { "name": "string", "type": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_BatchGetSchemaAnalysisRule_RequestSyntax) ** The unique identifier of the collaboration that contains the schema analysis rule. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [schemaAnalysisRuleRequests](#API_BatchGetSchemaAnalysisRule_RequestSyntax) ** The information that's necessary to retrieve a schema analysis rule. Type: Array of [SchemaAnalysisRuleRequest](API_SchemaAnalysisRuleRequest.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisRules": [ { "collaborationId": "string", "collaborationPolicy": { ... }, "consolidatedPolicy": { ... }, "createTime": number, "name": "string", "policy": { ... }, "type": "string", "updateTime": number } ], "errors": [ { "code": "string", "message": "string", "name": "string", "type": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisRules](#API_BatchGetSchemaAnalysisRule_ResponseSyntax) ** The retrieved list of analysis rules. Type: Array of [AnalysisRule](API_AnalysisRule.md) objects Array Members: Minimum number of 0 items. Maximum number of 25 items. ** [errors](#API_BatchGetSchemaAnalysisRule_ResponseSyntax) ** Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved. Type: Array of [BatchGetSchemaAnalysisRuleError](API_BatchGetSchemaAnalysisRuleError.md) objects Array Members: Minimum number of 0 items. Maximum number of 25 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRule) # CreateAnalysisTemplate Creates a new analysis template. ## Request Syntax ``` POST /memberships/membershipIdentifier/analysistemplates HTTP/1.1 Content-type: application/json { "analysisParameters": [ { "defaultValue": "string", "name": "string", "type": "string" } ], "description": "string", "errorMessageConfiguration": { "type": "string" }, "format": "string", "name": "string", "schema": { "referencedTables": [ "string" ] }, "source": { ... }, "syntheticDataParameters": { ... }, "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_CreateAnalysisTemplate_RequestSyntax) ** The identifier for a membership resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [analysisParameters](#API_CreateAnalysisTemplate_RequestSyntax) ** The parameters of the analysis template. Type: Array of [AnalysisParameter](API_AnalysisParameter.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [description](#API_CreateAnalysisTemplate_RequestSyntax) ** The description of the analysis template. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [errorMessageConfiguration](#API_CreateAnalysisTemplate_RequestSyntax) ** The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to `DETAILED`, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments. Type: [ErrorMessageConfiguration](API_ErrorMessageConfiguration.md) object Required: No ** [format](#API_CreateAnalysisTemplate_RequestSyntax) ** The format of the analysis template. Type: String Valid Values: `SQL | PYSPARK_1_0` Required: Yes ** [name](#API_CreateAnalysisTemplate_RequestSyntax) ** The name of the analysis template. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?` Required: Yes ** [schema](#API_CreateAnalysisTemplate_RequestSyntax) ** A relation within an analysis. Type: [AnalysisSchema](API_AnalysisSchema.md) object Required: No ** [source](#API_CreateAnalysisTemplate_RequestSyntax) ** The information in the analysis template. Type: [AnalysisSource](API_AnalysisSource.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [syntheticDataParameters](#API_CreateAnalysisTemplate_RequestSyntax) ** The parameters for generating synthetic data when running the analysis template. Type: [SyntheticDataParameters](API_SyntheticDataParameters.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [tags](#API_CreateAnalysisTemplate_RequestSyntax) ** An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisTemplate": { "analysisParameters": [ { "defaultValue": "string", "name": "string", "type": "string" } ], "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "errorMessageConfiguration": { "type": "string" }, "format": "string", "id": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "schema": { "referencedTables": [ "string" ] }, "source": { ... }, "sourceMetadata": { ... }, "syntheticDataParameters": { ... }, "updateTime": number, "validations": [ { "reasons": [ { "message": "string" } ], "status": "string", "type": "string" } ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisTemplate](#API_CreateAnalysisTemplate_ResponseSyntax) ** The analysis template. Type: [AnalysisTemplate](API_AnalysisTemplate.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateAnalysisTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateAnalysisTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateAnalysisTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateAnalysisTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateAnalysisTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateAnalysisTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateAnalysisTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateAnalysisTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateAnalysisTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateAnalysisTemplate) # CreateCollaboration Creates a new collaboration. ## Request Syntax ``` POST /collaborations HTTP/1.1 Content-type: application/json { "allowedResultRegions": [ "string" ], "analyticsEngine": "string", "autoApprovedChangeRequestTypes": [ "string" ], "creatorDisplayName": "string", "creatorMemberAbilities": [ "string" ], "creatorMLMemberAbilities": { "customMLMemberAbilities": [ "string" ] }, "creatorPaymentConfiguration": { "jobCompute": { "isResponsible": boolean }, "machineLearning": { "modelInference": { "isResponsible": boolean }, "modelTraining": { "isResponsible": boolean }, "syntheticDataGeneration": { "isResponsible": boolean } }, "queryCompute": { "isResponsible": boolean } }, "dataEncryptionMetadata": { "allowCleartext": boolean, "allowDuplicates": boolean, "allowJoinsOnColumnsWithDifferentNames": boolean, "preserveNulls": boolean }, "description": "string", "isMetricsEnabled": boolean, "jobLogStatus": "string", "members": [ { "accountId": "string", "displayName": "string", "memberAbilities": [ "string" ], "mlMemberAbilities": { "customMLMemberAbilities": [ "string" ] }, "paymentConfiguration": { "jobCompute": { "isResponsible": boolean }, "machineLearning": { "modelInference": { "isResponsible": boolean }, "modelTraining": { "isResponsible": boolean }, "syntheticDataGeneration": { "isResponsible": boolean } }, "queryCompute": { "isResponsible": boolean } } } ], "name": "string", "queryLogStatus": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [allowedResultRegions](#API_CreateCollaboration_RequestSyntax) ** The AWS Regions where collaboration query results can be stored. When specified, results can only be written to these Regions. This parameter enables you to meet your compliance and data governance requirements, and implement regional data governance policies. Type: Array of strings Valid Values: `us-west-1 | us-west-2 | us-east-1 | us-east-2 | af-south-1 | ap-east-1 | ap-east-2 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-southeast-5 | ap-southeast-4 | ap-southeast-7 | ap-south-1 | ap-northeast-3 | ap-northeast-1 | ap-northeast-2 | ca-central-1 | ca-west-1 | eu-south-1 | eu-west-3 | eu-south-2 | eu-central-2 | eu-central-1 | eu-north-1 | eu-west-1 | eu-west-2 | me-south-1 | me-central-1 | il-central-1 | sa-east-1 | mx-central-1` Required: No ** [analyticsEngine](#API_CreateCollaboration_RequestSyntax) ** The analytics engine. After July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be available. Type: String Valid Values: `SPARK | CLEAN_ROOMS_SQL` Required: No ** [autoApprovedChangeRequestTypes](#API_CreateCollaboration_RequestSyntax) ** The types of change requests that are automatically approved for this collaboration. Type: Array of strings Valid Values: `ADD_MEMBER | GRANT_RECEIVE_RESULTS_ABILITY | REVOKE_RECEIVE_RESULTS_ABILITY` Required: No ** [creatorDisplayName](#API_CreateCollaboration_RequestSyntax) ** The display name of the collaboration creator. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` Required: Yes ** [creatorMemberAbilities](#API_CreateCollaboration_RequestSyntax) ** The abilities granted to the collaboration creator. Type: Array of strings Valid Values: `CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB` Required: Yes ** [creatorMLMemberAbilities](#API_CreateCollaboration_RequestSyntax) ** The ML abilities granted to the collaboration creator. Type: [MLMemberAbilities](API_MLMemberAbilities.md) object Required: No ** [creatorPaymentConfiguration](#API_CreateCollaboration_RequestSyntax) ** The collaboration creator's payment responsibilities set by the collaboration creator. If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. Type: [PaymentConfiguration](API_PaymentConfiguration.md) object Required: No ** [dataEncryptionMetadata](#API_CreateCollaboration_RequestSyntax) ** The settings for client-side encryption with Cryptographic Computing for Clean Rooms. Type: [DataEncryptionMetadata](API_DataEncryptionMetadata.md) object Required: No ** [description](#API_CreateCollaboration_RequestSyntax) ** A description of the collaboration provided by the collaboration owner. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: Yes ** [isMetricsEnabled](#API_CreateCollaboration_RequestSyntax) ** An indicator as to whether metrics have been enabled or disabled for the collaboration. When `true`, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries. The default value is `false`. Type: Boolean Required: No ** [jobLogStatus](#API_CreateCollaboration_RequestSyntax) ** Specifies whether job logs are enabled for this collaboration. When `ENABLED`, AWS Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`. Type: String Valid Values: `ENABLED | DISABLED` Required: No ** [members](#API_CreateCollaboration_RequestSyntax) ** A list of initial members, not including the creator. This list is immutable. Type: Array of [MemberSpecification](API_MemberSpecification.md) objects Array Members: Minimum number of 0 items. Required: Yes ** [name](#API_CreateCollaboration_RequestSyntax) ** The display name for a collaboration. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` Required: Yes ** [queryLogStatus](#API_CreateCollaboration_RequestSyntax) ** An indicator as to whether query logging has been enabled or disabled for the collaboration. When `ENABLED`, AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`. Type: String Valid Values: `ENABLED | DISABLED` Required: Yes ** [tags](#API_CreateCollaboration_RequestSyntax) ** An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaboration": { "allowedResultRegions": [ "string" ], "analyticsEngine": "string", "arn": "string", "autoApprovedChangeTypes": [ "string" ], "createTime": number, "creatorAccountId": "string", "creatorDisplayName": "string", "dataEncryptionMetadata": { "allowCleartext": boolean, "allowDuplicates": boolean, "allowJoinsOnColumnsWithDifferentNames": boolean, "preserveNulls": boolean }, "description": "string", "id": "string", "isMetricsEnabled": boolean, "jobLogStatus": "string", "membershipArn": "string", "membershipId": "string", "memberStatus": "string", "name": "string", "queryLogStatus": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaboration](#API_CreateCollaboration_ResponseSyntax) ** The collaboration. Type: [Collaboration](API_Collaboration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateCollaboration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateCollaboration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateCollaboration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateCollaboration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateCollaboration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateCollaboration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateCollaboration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateCollaboration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateCollaboration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateCollaboration) # CreateCollaborationChangeRequest Creates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach. ## Request Syntax ``` POST /collaborations/collaborationIdentifier/changeRequests HTTP/1.1 Content-type: application/json { "changes": [ { "specification": { ... }, "specificationType": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_CreateCollaborationChangeRequest_RequestSyntax) ** The identifier of the collaboration that the change request is made against. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [changes](#API_CreateCollaborationChangeRequest_RequestSyntax) ** The list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed. Type: Array of [ChangeInput](API_ChangeInput.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationChangeRequest": { "approvals": { "string" : { "status": "string" } }, "changes": [ { "specification": { ... }, "specificationType": "string", "types": [ "string" ] } ], "collaborationId": "string", "createTime": number, "id": "string", "isAutoApproved": boolean, "status": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationChangeRequest](#API_CreateCollaborationChangeRequest_ResponseSyntax) ** Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created. Type: [CollaborationChangeRequest](API_CollaborationChangeRequest.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateCollaborationChangeRequest) # CreateConfiguredAudienceModelAssociation Provides the details necessary to create a configured audience model association. ## Request Syntax ``` POST /memberships/membershipIdentifier/configuredaudiencemodelassociations HTTP/1.1 Content-type: application/json { "configuredAudienceModelArn": "string", "configuredAudienceModelAssociationName": "string", "description": "string", "manageResourcePolicies": boolean, "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_CreateConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [configuredAudienceModelArn](#API_CreateConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier for the configured audience model that you want to associate. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+` Required: Yes ** [configuredAudienceModelAssociationName](#API_CreateConfiguredAudienceModelAssociation_RequestSyntax) ** The name of the configured audience model association. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` Required: Yes ** [description](#API_CreateConfiguredAudienceModelAssociation_RequestSyntax) ** A description of the configured audience model association. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [manageResourcePolicies](#API_CreateConfiguredAudienceModelAssociation_RequestSyntax) ** When `TRUE`, indicates that the resource policy for the configured audience model resource being associated is configured for AWS Clean Rooms to manage permissions related to the given collaboration. When `FALSE`, indicates that the configured audience model resource owner will manage permissions related to the given collaboration. Setting this to `TRUE` requires you to have permissions to create, update, and delete the resource policy for the `cleanrooms-ml` resource when you call the [DeleteConfiguredAudienceModelAssociation](API_DeleteConfiguredAudienceModelAssociation.md) resource. In addition, if you are the collaboration creator and specify `TRUE`, you must have the same permissions when you call the [DeleteMember](API_DeleteMember.md) and [DeleteCollaboration](API_DeleteCollaboration.md) APIs. Type: Boolean Required: Yes ** [tags](#API_CreateConfiguredAudienceModelAssociation_RequestSyntax) ** An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredAudienceModelAssociation": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "configuredAudienceModelArn": "string", "createTime": number, "description": "string", "id": "string", "manageResourcePolicies": boolean, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredAudienceModelAssociation](#API_CreateConfiguredAudienceModelAssociation_ResponseSyntax) ** Information about the configured audience model association. Type: [ConfiguredAudienceModelAssociation](API_ConfiguredAudienceModelAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateConfiguredAudienceModelAssociation) # CreateConfiguredTable Creates a new configured table resource. ## Request Syntax ``` POST /configuredTables HTTP/1.1 Content-type: application/json { "allowedColumns": [ "string" ], "analysisMethod": "string", "description": "string", "name": "string", "selectedAnalysisMethods": [ "string" ], "tableReference": { ... }, "tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [allowedColumns](#API_CreateConfiguredTable_RequestSyntax) ** The columns of the underlying table that can be used by collaborations or analysis rules. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?` Required: Yes ** [analysisMethod](#API_CreateConfiguredTable_RequestSyntax) ** The analysis method allowed for the configured tables. `DIRECT_QUERY` allows SQL queries to be run directly on this table. `DIRECT_JOB` allows PySpark jobs to be run directly on this table. `MULTIPLE` allows both SQL queries and PySpark jobs to be run directly on this table. Type: String Valid Values: `DIRECT_QUERY | DIRECT_JOB | MULTIPLE` Required: Yes ** [description](#API_CreateConfiguredTable_RequestSyntax) ** A description for the configured table. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [name](#API_CreateConfiguredTable_RequestSyntax) ** The name of the configured table. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` Required: Yes ** [selectedAnalysisMethods](#API_CreateConfiguredTable_RequestSyntax) ** The analysis methods to enable for the configured table. When configured, you must specify at least two analysis methods. Type: Array of strings Valid Values: `DIRECT_QUERY | DIRECT_JOB` Required: No ** [tableReference](#API_CreateConfiguredTable_RequestSyntax) ** A reference to the table being configured. Type: [TableReference](API_TableReference.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [tags](#API_CreateConfiguredTable_RequestSyntax) ** An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredTable": { "allowedColumns": [ "string" ], "analysisMethod": "string", "analysisRuleTypes": [ "string" ], "arn": "string", "createTime": number, "description": "string", "id": "string", "name": "string", "selectedAnalysisMethods": [ "string" ], "tableReference": { ... }, "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredTable](#API_CreateConfiguredTable_ResponseSyntax) ** The created configured table. Type: [ConfiguredTable](API_ConfiguredTable.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateConfiguredTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateConfiguredTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateConfiguredTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateConfiguredTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateConfiguredTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateConfiguredTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateConfiguredTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateConfiguredTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateConfiguredTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateConfiguredTable) # CreateConfiguredTableAnalysisRule Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table. ## Request Syntax ``` POST /configuredTables/configuredTableIdentifier/analysisRule HTTP/1.1 Content-type: application/json { "analysisRulePolicy": { ... }, "analysisRuleType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredTableIdentifier](#API_CreateConfiguredTableAnalysisRule_RequestSyntax) ** The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [analysisRulePolicy](#API_CreateConfiguredTableAnalysisRule_RequestSyntax) ** The analysis rule policy that was created for the configured table. Type: [ConfiguredTableAnalysisRulePolicy](API_ConfiguredTableAnalysisRulePolicy.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [analysisRuleType](#API_CreateConfiguredTableAnalysisRule_RequestSyntax) ** The type of analysis rule. Type: String Valid Values: `AGGREGATION | LIST | CUSTOM` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisRule": { "configuredTableArn": "string", "configuredTableId": "string", "createTime": number, "policy": { ... }, "type": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisRule](#API_CreateConfiguredTableAnalysisRule_ResponseSyntax) ** The analysis rule that was created for the configured table. Type: [ConfiguredTableAnalysisRule](API_ConfiguredTableAnalysisRule.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateConfiguredTableAnalysisRule) # CreateConfiguredTableAssociation Creates a configured table association. A configured table association links a configured table with a collaboration. ## Request Syntax ``` POST /memberships/membershipIdentifier/configuredTableAssociations HTTP/1.1 Content-type: application/json { "configuredTableIdentifier": "string", "description": "string", "name": "string", "roleArn": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_CreateConfiguredTableAssociation_RequestSyntax) ** A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [configuredTableIdentifier](#API_CreateConfiguredTableAssociation_RequestSyntax) ** A unique identifier for the configured table to be associated to. Currently accepts a configured table ID. Type: String Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [description](#API_CreateConfiguredTableAssociation_RequestSyntax) ** A description for the configured table association. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [name](#API_CreateConfiguredTableAssociation_RequestSyntax) ** The name of the configured table association. This name is used to query the underlying configured table. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?` Required: Yes ** [roleArn](#API_CreateConfiguredTableAssociation_RequestSyntax) ** The service will assume this role to access catalog metadata and query the table. Type: String Length Constraints: Minimum length of 32. Maximum length of 512. Pattern: `arn:aws:iam::[\w]+:role/[\w+=./@-]+` Required: Yes ** [tags](#API_CreateConfiguredTableAssociation_RequestSyntax) ** An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredTableAssociation": { "analysisRuleTypes": [ "string" ], "arn": "string", "configuredTableArn": "string", "configuredTableId": "string", "createTime": number, "description": "string", "id": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "roleArn": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredTableAssociation](#API_CreateConfiguredTableAssociation_ResponseSyntax) ** The configured table association. Type: [ConfiguredTableAssociation](API_ConfiguredTableAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateConfiguredTableAssociation) # CreateConfiguredTableAssociationAnalysisRule Creates a new analysis rule for an associated configured table. ## Request Syntax ``` POST /memberships/membershipIdentifier/configuredTableAssociations/configuredTableAssociationIdentifier/analysisRule HTTP/1.1 Content-type: application/json { "analysisRulePolicy": { ... }, "analysisRuleType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredTableAssociationIdentifier](#API_CreateConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The unique ID for the configured table association. Currently accepts the configured table association ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_CreateConfiguredTableAssociationAnalysisRule_RequestSyntax) ** A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [analysisRulePolicy](#API_CreateConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The analysis rule policy that was created for the configured table association. Type: [ConfiguredTableAssociationAnalysisRulePolicy](API_ConfiguredTableAssociationAnalysisRulePolicy.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [analysisRuleType](#API_CreateConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The type of analysis rule. Type: String Valid Values: `AGGREGATION | LIST | CUSTOM` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisRule": { "configuredTableAssociationArn": "string", "configuredTableAssociationId": "string", "createTime": number, "membershipIdentifier": "string", "policy": { ... }, "type": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisRule](#API_CreateConfiguredTableAssociationAnalysisRule_ResponseSyntax) ** The analysis rule for the conﬁgured table association. In the console, the `ConfiguredTableAssociationAnalysisRule` is referred to as the *collaboration analysis rule*. Type: [ConfiguredTableAssociationAnalysisRule](API_ConfiguredTableAssociationAnalysisRule.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateConfiguredTableAssociationAnalysisRule) # CreateIdMappingTable Creates an ID mapping table. ## Request Syntax ``` POST /memberships/membershipIdentifier/idmappingtables HTTP/1.1 Content-type: application/json { "description": "string", "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "kmsKeyArn": "string", "name": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_CreateIdMappingTable_RequestSyntax) ** The unique identifier of the membership that contains the ID mapping table. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [description](#API_CreateIdMappingTable_RequestSyntax) ** A description of the ID mapping table. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [inputReferenceConfig](#API_CreateIdMappingTable_RequestSyntax) ** The input reference configuration needed to create the ID mapping table. Type: [IdMappingTableInputReferenceConfig](API_IdMappingTableInputReferenceConfig.md) object Required: Yes ** [kmsKeyArn](#API_CreateIdMappingTable_RequestSyntax) ** The Amazon Resource Name (ARN) of the AWS KMS key. This value is used to encrypt the mapping table data that is stored by AWS Clean Rooms. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws:kms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:key/[a-zA-Z0-9-]+` Required: No ** [name](#API_CreateIdMappingTable_RequestSyntax) ** A name for the ID mapping table. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?` Required: Yes ** [tags](#API_CreateIdMappingTable_RequestSyntax) ** An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "idMappingTable": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idMappingTableInputSource": [ { "idNamespaceAssociationId": "string", "type": "string" } ] }, "kmsKeyArn": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [idMappingTable](#API_CreateIdMappingTable_ResponseSyntax) ** The ID mapping table that was created. Type: [IdMappingTable](API_IdMappingTable.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateIdMappingTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateIdMappingTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateIdMappingTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateIdMappingTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateIdMappingTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateIdMappingTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateIdMappingTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateIdMappingTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateIdMappingTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateIdMappingTable) # CreateIdNamespaceAssociation Creates an ID namespace association. ## Request Syntax ``` POST /memberships/membershipIdentifier/idnamespaceassociations HTTP/1.1 Content-type: application/json { "description": "string", "idMappingConfig": { "allowUseAsDimensionColumn": boolean }, "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "name": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_CreateIdNamespaceAssociation_RequestSyntax) ** The unique identifier of the membership that contains the ID namespace association. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [description](#API_CreateIdNamespaceAssociation_RequestSyntax) ** The description of the ID namespace association. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [idMappingConfig](#API_CreateIdNamespaceAssociation_RequestSyntax) ** The configuration settings for the ID mapping table. Type: [IdMappingConfig](API_IdMappingConfig.md) object Required: No ** [inputReferenceConfig](#API_CreateIdNamespaceAssociation_RequestSyntax) ** The input reference configuration needed to create the ID namespace association. Type: [IdNamespaceAssociationInputReferenceConfig](API_IdNamespaceAssociationInputReferenceConfig.md) object Required: Yes ** [name](#API_CreateIdNamespaceAssociation_RequestSyntax) ** The name for the ID namespace association. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` Required: Yes ** [tags](#API_CreateIdNamespaceAssociation_RequestSyntax) ** An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "idNamespaceAssociation": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "idMappingConfig": { "allowUseAsDimensionColumn": boolean }, "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idMappingWorkflowsSupported": [ JSON value ], "idNamespaceType": "string" }, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [idNamespaceAssociation](#API_CreateIdNamespaceAssociation_ResponseSyntax) ** The ID namespace association that was created. Type: [IdNamespaceAssociation](API_IdNamespaceAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateIdNamespaceAssociation) # CreateMembership Creates a membership for a specific collaboration identifier and joins the collaboration. ## Request Syntax ``` POST /memberships HTTP/1.1 Content-type: application/json { "collaborationIdentifier": "string", "defaultJobResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "defaultResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "isMetricsEnabled": boolean, "jobLogStatus": "string", "paymentConfiguration": { "jobCompute": { "isResponsible": boolean }, "machineLearning": { "modelInference": { "isResponsible": boolean }, "modelTraining": { "isResponsible": boolean }, "syntheticDataGeneration": { "isResponsible": boolean } }, "queryCompute": { "isResponsible": boolean } }, "queryLogStatus": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [collaborationIdentifier](#API_CreateMembership_RequestSyntax) ** The unique ID for the associated collaboration. Type: String Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [defaultJobResultConfiguration](#API_CreateMembership_RequestSyntax) ** The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs. Type: [MembershipProtectedJobResultConfiguration](API_MembershipProtectedJobResultConfiguration.md) object Required: No ** [defaultResultConfiguration](#API_CreateMembership_RequestSyntax) ** The default protected query result configuration as specified by the member who can receive results. Type: [MembershipProtectedQueryResultConfiguration](API_MembershipProtectedQueryResultConfiguration.md) object Required: No ** [isMetricsEnabled](#API_CreateMembership_RequestSyntax) ** An indicator as to whether Amazon CloudWatch metrics have been enabled or disabled for the membership. Amazon CloudWatch metrics are only available when the collaboration has metrics enabled. This option can be set by collaboration members who have the ability to run queries (analysis runners) or by members who are configured as payers. When `true`, metrics about query execution are collected in Amazon CloudWatch. The default value is `false`. Type: Boolean Required: No ** [jobLogStatus](#API_CreateMembership_RequestSyntax) ** An indicator as to whether job logging has been enabled or disabled for the collaboration. When `ENABLED`, AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`. Type: String Valid Values: `ENABLED | DISABLED` Required: No ** [paymentConfiguration](#API_CreateMembership_RequestSyntax) ** The payment responsibilities accepted by the collaboration member. Not required if the collaboration member has the member ability to run queries. Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator. Type: [MembershipPaymentConfiguration](API_MembershipPaymentConfiguration.md) object Required: No ** [queryLogStatus](#API_CreateMembership_RequestSyntax) ** An indicator as to whether query logging has been enabled or disabled for the membership. When `ENABLED`, AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`. Type: String Valid Values: `ENABLED | DISABLED` Required: Yes ** [tags](#API_CreateMembership_RequestSyntax) ** An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "membership": { "arn": "string", "collaborationArn": "string", "collaborationCreatorAccountId": "string", "collaborationCreatorDisplayName": "string", "collaborationId": "string", "collaborationName": "string", "createTime": number, "defaultJobResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "defaultResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "id": "string", "isMetricsEnabled": boolean, "jobLogStatus": "string", "memberAbilities": [ "string" ], "mlMemberAbilities": { "customMLMemberAbilities": [ "string" ] }, "paymentConfiguration": { "jobCompute": { "isResponsible": boolean }, "machineLearning": { "modelInference": { "isResponsible": boolean }, "modelTraining": { "isResponsible": boolean }, "syntheticDataGeneration": { "isResponsible": boolean } }, "queryCompute": { "isResponsible": boolean } }, "queryLogStatus": "string", "status": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [membership](#API_CreateMembership_ResponseSyntax) ** The membership that was created. Type: [Membership](API_Membership.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreateMembership) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreateMembership) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreateMembership) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreateMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreateMembership) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreateMembership) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreateMembership) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreateMembership) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreateMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreateMembership) # CreatePrivacyBudgetTemplate Creates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the privacy budget template, use the [UpdatePrivacyBudgetTemplate](API_UpdatePrivacyBudgetTemplate.md) operation. ## Request Syntax ``` POST /memberships/membershipIdentifier/privacybudgettemplates HTTP/1.1 Content-type: application/json { "autoRefresh": "string", "parameters": { ... }, "privacyBudgetType": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_CreatePrivacyBudgetTemplate_RequestSyntax) ** A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [autoRefresh](#API_CreatePrivacyBudgetTemplate_RequestSyntax) ** How often the privacy budget refreshes. If you plan to regularly bring new data into the collaboration, you can use `CALENDAR_MONTH` to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes. Type: String Valid Values: `CALENDAR_MONTH | NONE` Required: No ** [parameters](#API_CreatePrivacyBudgetTemplate_RequestSyntax) ** Specifies your parameters for the privacy budget template. Type: [PrivacyBudgetTemplateParametersInput](API_PrivacyBudgetTemplateParametersInput.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [privacyBudgetType](#API_CreatePrivacyBudgetTemplate_RequestSyntax) ** Specifies the type of the privacy budget template. Type: String Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET` Required: Yes ** [tags](#API_CreatePrivacyBudgetTemplate_RequestSyntax) ** An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "privacyBudgetTemplate": { "arn": "string", "autoRefresh": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "id": "string", "membershipArn": "string", "membershipId": "string", "parameters": { ... }, "privacyBudgetType": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [privacyBudgetTemplate](#API_CreatePrivacyBudgetTemplate_ResponseSyntax) ** A summary of the elements in the privacy budget template. Type: [PrivacyBudgetTemplate](API_PrivacyBudgetTemplate.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CreatePrivacyBudgetTemplate) # DeleteAnalysisTemplate Deletes an analysis template. ## Request Syntax ``` DELETE /memberships/membershipIdentifier/analysistemplates/analysisTemplateIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisTemplateIdentifier](#API_DeleteAnalysisTemplate_RequestSyntax) ** The identifier for the analysis template resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_DeleteAnalysisTemplate_RequestSyntax) ** The identifier for a membership resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteAnalysisTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteAnalysisTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteAnalysisTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteAnalysisTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteAnalysisTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteAnalysisTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteAnalysisTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteAnalysisTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteAnalysisTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteAnalysisTemplate) # DeleteCollaboration Deletes a collaboration. It can only be called by the collaboration owner. ## Request Syntax ``` DELETE /collaborations/collaborationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_DeleteCollaboration_RequestSyntax) ** The identifier for the collaboration. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteCollaboration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteCollaboration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteCollaboration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteCollaboration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteCollaboration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteCollaboration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteCollaboration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteCollaboration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteCollaboration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteCollaboration) # DeleteConfiguredAudienceModelAssociation Provides the information necessary to delete a configured audience model association. ## Request Syntax ``` DELETE /memberships/membershipIdentifier/configuredaudiencemodelassociations/configuredAudienceModelAssociationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredAudienceModelAssociationIdentifier](#API_DeleteConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier of the configured audience model association that you want to delete. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_DeleteConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier of the membership that contains the audience model association that you want to delete. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteConfiguredAudienceModelAssociation) # DeleteConfiguredTable Deletes a configured table. ## Request Syntax ``` DELETE /configuredTables/configuredTableIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredTableIdentifier](#API_DeleteConfiguredTable_RequestSyntax) ** The unique ID for the configured table to delete. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteConfiguredTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteConfiguredTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteConfiguredTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteConfiguredTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteConfiguredTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteConfiguredTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteConfiguredTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteConfiguredTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteConfiguredTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteConfiguredTable) # DeleteConfiguredTableAnalysisRule Deletes a configured table analysis rule. ## Request Syntax ``` DELETE /configuredTables/configuredTableIdentifier/analysisRule/analysisRuleType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisRuleType](#API_DeleteConfiguredTableAnalysisRule_RequestSyntax) ** The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type. Valid Values: `AGGREGATION | LIST | CUSTOM` Required: Yes ** [configuredTableIdentifier](#API_DeleteConfiguredTableAnalysisRule_RequestSyntax) ** The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteConfiguredTableAnalysisRule) # DeleteConfiguredTableAssociation Deletes a configured table association. ## Request Syntax ``` DELETE /memberships/membershipIdentifier/configuredTableAssociations/configuredTableAssociationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredTableAssociationIdentifier](#API_DeleteConfiguredTableAssociation_RequestSyntax) ** The unique ID for the configured table association to be deleted. Currently accepts the configured table ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_DeleteConfiguredTableAssociation_RequestSyntax) ** A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteConfiguredTableAssociation) # DeleteConfiguredTableAssociationAnalysisRule Deletes an analysis rule for a configured table association. ## Request Syntax ``` DELETE /memberships/membershipIdentifier/configuredTableAssociations/configuredTableAssociationIdentifier/analysisRule/analysisRuleType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisRuleType](#API_DeleteConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The type of the analysis rule that you want to delete. Valid Values: `AGGREGATION | LIST | CUSTOM` Required: Yes ** [configuredTableAssociationIdentifier](#API_DeleteConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The identiﬁer for the conﬁgured table association that's related to the analysis rule that you want to delete. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_DeleteConfiguredTableAssociationAnalysisRule_RequestSyntax) ** A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteConfiguredTableAssociationAnalysisRule) # DeleteIdMappingTable Deletes an ID mapping table. ## Request Syntax ``` DELETE /memberships/membershipIdentifier/idmappingtables/idMappingTableIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [idMappingTableIdentifier](#API_DeleteIdMappingTable_RequestSyntax) ** The unique identifier of the ID mapping table that you want to delete. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_DeleteIdMappingTable_RequestSyntax) ** The unique identifier of the membership that contains the ID mapping table that you want to delete. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteIdMappingTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteIdMappingTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteIdMappingTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteIdMappingTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteIdMappingTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteIdMappingTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteIdMappingTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteIdMappingTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteIdMappingTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteIdMappingTable) # DeleteIdNamespaceAssociation Deletes an ID namespace association. ## Request Syntax ``` DELETE /memberships/membershipIdentifier/idnamespaceassociations/idNamespaceAssociationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [idNamespaceAssociationIdentifier](#API_DeleteIdNamespaceAssociation_RequestSyntax) ** The unique identifier of the ID namespace association that you want to delete. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_DeleteIdNamespaceAssociation_RequestSyntax) ** The unique identifier of the membership that contains the ID namespace association that you want to delete. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteIdNamespaceAssociation) # DeleteMember 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. ## Request Syntax ``` DELETE /collaborations/collaborationIdentifier/member/accountId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [accountId](#API_DeleteMember_RequestSyntax) ** The account ID of the member to remove. Length Constraints: Fixed length of 12. Pattern: `\d+` Required: Yes ** [collaborationIdentifier](#API_DeleteMember_RequestSyntax) ** The unique identifier for the associated collaboration. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteMember) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteMember) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteMember) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteMember) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteMember) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteMember) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteMember) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteMember) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteMember) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteMember) # DeleteMembership Deletes a specified membership. All resources under a membership must be deleted. ## Request Syntax ``` DELETE /memberships/membershipIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_DeleteMembership_RequestSyntax) ** The identifier for a membership resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeleteMembership) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeleteMembership) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeleteMembership) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeleteMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeleteMembership) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeleteMembership) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeleteMembership) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeleteMembership) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeleteMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeleteMembership) # DeletePrivacyBudgetTemplate Deletes a privacy budget template for a specified collaboration. ## Request Syntax ``` DELETE /memberships/membershipIdentifier/privacybudgettemplates/privacyBudgetTemplateIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_DeletePrivacyBudgetTemplate_RequestSyntax) ** A unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [privacyBudgetTemplateIdentifier](#API_DeletePrivacyBudgetTemplate_RequestSyntax) ** A unique identifier for your privacy budget template. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DeletePrivacyBudgetTemplate) # GetAnalysisTemplate Retrieves an analysis template. ## Request Syntax ``` GET /memberships/membershipIdentifier/analysistemplates/analysisTemplateIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisTemplateIdentifier](#API_GetAnalysisTemplate_RequestSyntax) ** The identifier for the analysis template resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_GetAnalysisTemplate_RequestSyntax) ** The identifier for a membership resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisTemplate": { "analysisParameters": [ { "defaultValue": "string", "name": "string", "type": "string" } ], "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "errorMessageConfiguration": { "type": "string" }, "format": "string", "id": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "schema": { "referencedTables": [ "string" ] }, "source": { ... }, "sourceMetadata": { ... }, "syntheticDataParameters": { ... }, "updateTime": number, "validations": [ { "reasons": [ { "message": "string" } ], "status": "string", "type": "string" } ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisTemplate](#API_GetAnalysisTemplate_ResponseSyntax) ** The analysis template. Type: [AnalysisTemplate](API_AnalysisTemplate.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetAnalysisTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetAnalysisTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetAnalysisTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetAnalysisTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetAnalysisTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetAnalysisTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetAnalysisTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetAnalysisTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetAnalysisTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetAnalysisTemplate) # GetCollaboration Returns metadata about a collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_GetCollaboration_RequestSyntax) ** The identifier for the collaboration. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaboration": { "allowedResultRegions": [ "string" ], "analyticsEngine": "string", "arn": "string", "autoApprovedChangeTypes": [ "string" ], "createTime": number, "creatorAccountId": "string", "creatorDisplayName": "string", "dataEncryptionMetadata": { "allowCleartext": boolean, "allowDuplicates": boolean, "allowJoinsOnColumnsWithDifferentNames": boolean, "preserveNulls": boolean }, "description": "string", "id": "string", "isMetricsEnabled": boolean, "jobLogStatus": "string", "membershipArn": "string", "membershipId": "string", "memberStatus": "string", "name": "string", "queryLogStatus": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaboration](#API_GetCollaboration_ResponseSyntax) ** The entire collaboration for this identifier. Type: [Collaboration](API_Collaboration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetCollaboration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetCollaboration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetCollaboration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetCollaboration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetCollaboration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetCollaboration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetCollaboration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetCollaboration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetCollaboration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetCollaboration) # GetCollaborationAnalysisTemplate Retrieves an analysis template within a collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/analysistemplates/analysisTemplateArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisTemplateArn](#API_GetCollaborationAnalysisTemplate_RequestSyntax) ** The Amazon Resource Name (ARN) associated with the analysis template within a collaboration. Length Constraints: Minimum length of 0. Maximum length of 200. Pattern: `arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+` Required: Yes ** [collaborationIdentifier](#API_GetCollaborationAnalysisTemplate_RequestSyntax) ** A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationAnalysisTemplate": { "analysisParameters": [ { "defaultValue": "string", "name": "string", "type": "string" } ], "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "description": "string", "errorMessageConfiguration": { "type": "string" }, "format": "string", "id": "string", "name": "string", "schema": { "referencedTables": [ "string" ] }, "source": { ... }, "sourceMetadata": { ... }, "syntheticDataParameters": { ... }, "updateTime": number, "validations": [ { "reasons": [ { "message": "string" } ], "status": "string", "type": "string" } ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationAnalysisTemplate](#API_GetCollaborationAnalysisTemplate_ResponseSyntax) ** The analysis template within a collaboration. Type: [CollaborationAnalysisTemplate](API_CollaborationAnalysisTemplate.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetCollaborationAnalysisTemplate) # GetCollaborationChangeRequest Retrieves detailed information about a specific collaboration change request. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/changeRequests/changeRequestIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [changeRequestIdentifier](#API_GetCollaborationChangeRequest_RequestSyntax) ** A unique identifier for the change request to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [collaborationIdentifier](#API_GetCollaborationChangeRequest_RequestSyntax) ** The identifier of the collaboration that the change request is made against. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationChangeRequest": { "approvals": { "string" : { "status": "string" } }, "changes": [ { "specification": { ... }, "specificationType": "string", "types": [ "string" ] } ], "collaborationId": "string", "createTime": number, "id": "string", "isAutoApproved": boolean, "status": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationChangeRequest](#API_GetCollaborationChangeRequest_ResponseSyntax) ** The collaboration change request that was requested. Type: [CollaborationChangeRequest](API_CollaborationChangeRequest.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetCollaborationChangeRequest) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetCollaborationChangeRequest) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetCollaborationChangeRequest) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetCollaborationChangeRequest) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetCollaborationChangeRequest) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetCollaborationChangeRequest) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetCollaborationChangeRequest) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetCollaborationChangeRequest) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetCollaborationChangeRequest) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetCollaborationChangeRequest) # GetCollaborationConfiguredAudienceModelAssociation Retrieves a configured audience model association within a collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/configuredaudiencemodelassociations/configuredAudienceModelAssociationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_GetCollaborationConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [configuredAudienceModelAssociationIdentifier](#API_GetCollaborationConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier for the configured audience model association that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationConfiguredAudienceModelAssociation": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "configuredAudienceModelArn": "string", "createTime": number, "creatorAccountId": "string", "description": "string", "id": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationConfiguredAudienceModelAssociation](#API_GetCollaborationConfiguredAudienceModelAssociation_ResponseSyntax) ** The metadata of the configured audience model association. Type: [CollaborationConfiguredAudienceModelAssociation](API_CollaborationConfiguredAudienceModelAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetCollaborationConfiguredAudienceModelAssociation) # GetCollaborationIdNamespaceAssociation Retrieves an ID namespace association from a specific collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/idnamespaceassociations/idNamespaceAssociationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_GetCollaborationIdNamespaceAssociation_RequestSyntax) ** The unique identifier of the collaboration that contains the ID namespace association that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [idNamespaceAssociationIdentifier](#API_GetCollaborationIdNamespaceAssociation_RequestSyntax) ** The unique identifier of the ID namespace association that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationIdNamespaceAssociation": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "description": "string", "id": "string", "idMappingConfig": { "allowUseAsDimensionColumn": boolean }, "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idMappingWorkflowsSupported": [ JSON value ], "idNamespaceType": "string" }, "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationIdNamespaceAssociation](#API_GetCollaborationIdNamespaceAssociation_ResponseSyntax) ** The ID namespace association that you requested. Type: [CollaborationIdNamespaceAssociation](API_CollaborationIdNamespaceAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetCollaborationIdNamespaceAssociation) # GetCollaborationPrivacyBudgetTemplate Returns details about a specified privacy budget template. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/privacybudgettemplates/privacyBudgetTemplateIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_GetCollaborationPrivacyBudgetTemplate_RequestSyntax) ** A unique identifier for one of your collaborations. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [privacyBudgetTemplateIdentifier](#API_GetCollaborationPrivacyBudgetTemplate_RequestSyntax) ** A unique identifier for one of your privacy budget templates. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationPrivacyBudgetTemplate": { "arn": "string", "autoRefresh": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "id": "string", "parameters": { ... }, "privacyBudgetType": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationPrivacyBudgetTemplate](#API_GetCollaborationPrivacyBudgetTemplate_ResponseSyntax) ** Returns the details of the privacy budget template that you requested. Type: [CollaborationPrivacyBudgetTemplate](API_CollaborationPrivacyBudgetTemplate.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetCollaborationPrivacyBudgetTemplate) # GetConfiguredAudienceModelAssociation Returns information about a configured audience model association. ## Request Syntax ``` GET /memberships/membershipIdentifier/configuredaudiencemodelassociations/configuredAudienceModelAssociationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredAudienceModelAssociationIdentifier](#API_GetConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier for the configured audience model association that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_GetConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier for the membership that contains the configured audience model association that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredAudienceModelAssociation": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "configuredAudienceModelArn": "string", "createTime": number, "description": "string", "id": "string", "manageResourcePolicies": boolean, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredAudienceModelAssociation](#API_GetConfiguredAudienceModelAssociation_ResponseSyntax) ** Information about the configured audience model association that you requested. Type: [ConfiguredAudienceModelAssociation](API_ConfiguredAudienceModelAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetConfiguredAudienceModelAssociation) # GetConfiguredTable Retrieves a configured table. ## Request Syntax ``` GET /configuredTables/configuredTableIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredTableIdentifier](#API_GetConfiguredTable_RequestSyntax) ** The unique ID for the configured table to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredTable": { "allowedColumns": [ "string" ], "analysisMethod": "string", "analysisRuleTypes": [ "string" ], "arn": "string", "createTime": number, "description": "string", "id": "string", "name": "string", "selectedAnalysisMethods": [ "string" ], "tableReference": { ... }, "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredTable](#API_GetConfiguredTable_ResponseSyntax) ** The retrieved configured table. Type: [ConfiguredTable](API_ConfiguredTable.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetConfiguredTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetConfiguredTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetConfiguredTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetConfiguredTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetConfiguredTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetConfiguredTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetConfiguredTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetConfiguredTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetConfiguredTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetConfiguredTable) # GetConfiguredTableAnalysisRule Retrieves a configured table analysis rule. ## Request Syntax ``` GET /configuredTables/configuredTableIdentifier/analysisRule/analysisRuleType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisRuleType](#API_GetConfiguredTableAnalysisRule_RequestSyntax) ** The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type. Valid Values: `AGGREGATION | LIST | CUSTOM` Required: Yes ** [configuredTableIdentifier](#API_GetConfiguredTableAnalysisRule_RequestSyntax) ** The unique identifier for the configured table to retrieve. Currently accepts the configured table ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisRule": { "configuredTableArn": "string", "configuredTableId": "string", "createTime": number, "policy": { ... }, "type": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisRule](#API_GetConfiguredTableAnalysisRule_ResponseSyntax) ** The entire analysis rule output. Type: [ConfiguredTableAnalysisRule](API_ConfiguredTableAnalysisRule.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetConfiguredTableAnalysisRule) # GetConfiguredTableAssociation Retrieves a configured table association. ## Request Syntax ``` GET /memberships/membershipIdentifier/configuredTableAssociations/configuredTableAssociationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredTableAssociationIdentifier](#API_GetConfiguredTableAssociation_RequestSyntax) ** The unique ID for the configured table association to retrieve. Currently accepts the configured table ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_GetConfiguredTableAssociation_RequestSyntax) ** A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredTableAssociation": { "analysisRuleTypes": [ "string" ], "arn": "string", "configuredTableArn": "string", "configuredTableId": "string", "createTime": number, "description": "string", "id": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "roleArn": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredTableAssociation](#API_GetConfiguredTableAssociation_ResponseSyntax) ** The entire configured table association object. Type: [ConfiguredTableAssociation](API_ConfiguredTableAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetConfiguredTableAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetConfiguredTableAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetConfiguredTableAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetConfiguredTableAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetConfiguredTableAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetConfiguredTableAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetConfiguredTableAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetConfiguredTableAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetConfiguredTableAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetConfiguredTableAssociation) # GetConfiguredTableAssociationAnalysisRule Retrieves the analysis rule for a configured table association. ## Request Syntax ``` GET /memberships/membershipIdentifier/configuredTableAssociations/configuredTableAssociationIdentifier/analysisRule/analysisRuleType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisRuleType](#API_GetConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The type of analysis rule that you want to retrieve. Valid Values: `AGGREGATION | LIST | CUSTOM` Required: Yes ** [configuredTableAssociationIdentifier](#API_GetConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The identiﬁer for the conﬁgured table association that's related to the analysis rule. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_GetConfiguredTableAssociationAnalysisRule_RequestSyntax) ** A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisRule": { "configuredTableAssociationArn": "string", "configuredTableAssociationId": "string", "createTime": number, "membershipIdentifier": "string", "policy": { ... }, "type": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisRule](#API_GetConfiguredTableAssociationAnalysisRule_ResponseSyntax) ** The analysis rule for the conﬁgured table association. In the console, the `ConfiguredTableAssociationAnalysisRule` is referred to as the *collaboration analysis rule*. Type: [ConfiguredTableAssociationAnalysisRule](API_ConfiguredTableAssociationAnalysisRule.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule) # GetIdMappingTable Retrieves an ID mapping table. ## Request Syntax ``` GET /memberships/membershipIdentifier/idmappingtables/idMappingTableIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [idMappingTableIdentifier](#API_GetIdMappingTable_RequestSyntax) ** The unique identifier of the ID mapping table identifier that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_GetIdMappingTable_RequestSyntax) ** The unique identifier of the membership that contains the ID mapping table that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "idMappingTable": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idMappingTableInputSource": [ { "idNamespaceAssociationId": "string", "type": "string" } ] }, "kmsKeyArn": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [idMappingTable](#API_GetIdMappingTable_ResponseSyntax) ** The ID mapping table that you requested. Type: [IdMappingTable](API_IdMappingTable.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetIdMappingTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetIdMappingTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetIdMappingTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetIdMappingTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetIdMappingTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetIdMappingTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetIdMappingTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetIdMappingTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetIdMappingTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetIdMappingTable) # GetIdNamespaceAssociation Retrieves an ID namespace association. ## Request Syntax ``` GET /memberships/membershipIdentifier/idnamespaceassociations/idNamespaceAssociationIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [idNamespaceAssociationIdentifier](#API_GetIdNamespaceAssociation_RequestSyntax) ** The unique identifier of the ID namespace association that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_GetIdNamespaceAssociation_RequestSyntax) ** The unique identifier of the membership that contains the ID namespace association that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "idNamespaceAssociation": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "idMappingConfig": { "allowUseAsDimensionColumn": boolean }, "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idMappingWorkflowsSupported": [ JSON value ], "idNamespaceType": "string" }, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [idNamespaceAssociation](#API_GetIdNamespaceAssociation_ResponseSyntax) ** The ID namespace association that you requested. Type: [IdNamespaceAssociation](API_IdNamespaceAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetIdNamespaceAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetIdNamespaceAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetIdNamespaceAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetIdNamespaceAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetIdNamespaceAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetIdNamespaceAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetIdNamespaceAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetIdNamespaceAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetIdNamespaceAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetIdNamespaceAssociation) # GetMembership Retrieves a specified membership for an identifier. ## Request Syntax ``` GET /memberships/membershipIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_GetMembership_RequestSyntax) ** The identifier for a membership resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "membership": { "arn": "string", "collaborationArn": "string", "collaborationCreatorAccountId": "string", "collaborationCreatorDisplayName": "string", "collaborationId": "string", "collaborationName": "string", "createTime": number, "defaultJobResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "defaultResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "id": "string", "isMetricsEnabled": boolean, "jobLogStatus": "string", "memberAbilities": [ "string" ], "mlMemberAbilities": { "customMLMemberAbilities": [ "string" ] }, "paymentConfiguration": { "jobCompute": { "isResponsible": boolean }, "machineLearning": { "modelInference": { "isResponsible": boolean }, "modelTraining": { "isResponsible": boolean }, "syntheticDataGeneration": { "isResponsible": boolean } }, "queryCompute": { "isResponsible": boolean } }, "queryLogStatus": "string", "status": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [membership](#API_GetMembership_ResponseSyntax) ** The membership retrieved for the provided identifier. Type: [Membership](API_Membership.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetMembership) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetMembership) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetMembership) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetMembership) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetMembership) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetMembership) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetMembership) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetMembership) # GetPrivacyBudgetTemplate Returns details for a specified privacy budget template. ## Request Syntax ``` GET /memberships/membershipIdentifier/privacybudgettemplates/privacyBudgetTemplateIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_GetPrivacyBudgetTemplate_RequestSyntax) ** A unique identifier for one of your memberships for a collaboration. The privacy budget template is retrieved from the collaboration that this membership belongs to. Accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [privacyBudgetTemplateIdentifier](#API_GetPrivacyBudgetTemplate_RequestSyntax) ** A unique identifier for your privacy budget template. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "privacyBudgetTemplate": { "arn": "string", "autoRefresh": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "id": "string", "membershipArn": "string", "membershipId": "string", "parameters": { ... }, "privacyBudgetType": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [privacyBudgetTemplate](#API_GetPrivacyBudgetTemplate_ResponseSyntax) ** Returns the details of the privacy budget template that you requested. Type: [PrivacyBudgetTemplate](API_PrivacyBudgetTemplate.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetPrivacyBudgetTemplate) # GetProtectedJob Returns job processing metadata. ## Request Syntax ``` GET /memberships/membershipIdentifier/protectedJobs/protectedJobIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_GetProtectedJob_RequestSyntax) ** The identifier for a membership in a protected job instance. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [protectedJobIdentifier](#API_GetProtectedJob_RequestSyntax) ** The identifier for the protected job instance. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "protectedJob": { "computeConfiguration": { ... }, "createTime": number, "error": { "code": "string", "message": "string" }, "id": "string", "jobParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" } }, "membershipArn": "string", "membershipId": "string", "result": { "output": { ... } }, "resultConfiguration": { "outputConfiguration": { ... } }, "statistics": { "billedResourceUtilization": { "units": number }, "totalDurationInMillis": number }, "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [protectedJob](#API_GetProtectedJob_ResponseSyntax) ** The protected job metadata. Type: [ProtectedJob](API_ProtectedJob.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetProtectedJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetProtectedJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetProtectedJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetProtectedJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetProtectedJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetProtectedJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetProtectedJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetProtectedJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetProtectedJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetProtectedJob) # GetProtectedQuery Returns query processing metadata. ## Request Syntax ``` GET /memberships/membershipIdentifier/protectedQueries/protectedQueryIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_GetProtectedQuery_RequestSyntax) ** The identifier for a membership in a protected query instance. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [protectedQueryIdentifier](#API_GetProtectedQuery_RequestSyntax) ** The identifier for a protected query instance. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "protectedQuery": { "computeConfiguration": { ... }, "createTime": number, "differentialPrivacy": { "sensitivityParameters": [ { "aggregationExpression": "string", "aggregationType": "string", "maxColumnValue": number, "minColumnValue": number, "userContributionLimit": number } ] }, "error": { "code": "string", "message": "string" }, "id": "string", "membershipArn": "string", "membershipId": "string", "result": { "output": { ... } }, "resultConfiguration": { "outputConfiguration": { ... } }, "sqlParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" }, "queryString": "string" }, "statistics": { "billedResourceUtilization": { "units": number }, "totalDurationInMillis": number }, "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [protectedQuery](#API_GetProtectedQuery_ResponseSyntax) ** The query processing metadata. Type: [ProtectedQuery](API_ProtectedQuery.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetProtectedQuery) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetProtectedQuery) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetProtectedQuery) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetProtectedQuery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetProtectedQuery) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetProtectedQuery) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetProtectedQuery) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetProtectedQuery) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetProtectedQuery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetProtectedQuery) # GetSchema Retrieves the schema for a relation within a collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/schemas/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_GetSchema_RequestSyntax) ** A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [name](#API_GetSchema_RequestSyntax) ** The name of the relation to retrieve the schema for. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "schema": { "analysisMethod": "string", "analysisRuleTypes": [ "string" ], "collaborationArn": "string", "collaborationId": "string", "columns": [ { "name": "string", "type": "string" } ], "createTime": number, "creatorAccountId": "string", "description": "string", "name": "string", "partitionKeys": [ { "name": "string", "type": "string" } ], "resourceArn": "string", "schemaStatusDetails": [ { "analysisRuleType": "string", "analysisType": "string", "configurations": [ "string" ], "reasons": [ { "code": "string", "message": "string" } ], "status": "string" } ], "schemaTypeProperties": { ... }, "selectedAnalysisMethods": [ "string" ], "type": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [schema](#API_GetSchema_ResponseSyntax) ** The entire schema object. Type: [Schema](API_Schema.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetSchema) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetSchema) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetSchema) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetSchema) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetSchema) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetSchema) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetSchema) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetSchema) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetSchema) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetSchema) # GetSchemaAnalysisRule Retrieves a schema analysis rule. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/schemas/name/analysisRule/type HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_GetSchemaAnalysisRule_RequestSyntax) ** A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [name](#API_GetSchemaAnalysisRule_RequestSyntax) ** The name of the schema to retrieve the analysis rule for. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?` Required: Yes ** [type](#API_GetSchemaAnalysisRule_RequestSyntax) ** The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type. Valid Values: `AGGREGATION | LIST | CUSTOM | ID_MAPPING_TABLE` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisRule": { "collaborationId": "string", "collaborationPolicy": { ... }, "consolidatedPolicy": { ... }, "createTime": number, "name": "string", "policy": { ... }, "type": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisRule](#API_GetSchemaAnalysisRule_ResponseSyntax) ** A specification about how data from the configured table can be used. Type: [AnalysisRule](API_AnalysisRule.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/GetSchemaAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/GetSchemaAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GetSchemaAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/GetSchemaAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GetSchemaAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/GetSchemaAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/GetSchemaAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/GetSchemaAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/GetSchemaAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GetSchemaAnalysisRule) # ListAnalysisTemplates Lists analysis templates that the caller owns. ## Request Syntax ``` GET /memberships/membershipIdentifier/analysistemplates?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListAnalysisTemplates_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [membershipIdentifier](#API_ListAnalysisTemplates_RequestSyntax) ** The identifier for a membership resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [nextToken](#API_ListAnalysisTemplates_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisTemplateSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "isSyntheticData": boolean, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisTemplateSummaries](#API_ListAnalysisTemplates_ResponseSyntax) ** Lists analysis template metadata. Type: Array of [AnalysisTemplateSummary](API_AnalysisTemplateSummary.md) objects ** [nextToken](#API_ListAnalysisTemplates_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListAnalysisTemplates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListAnalysisTemplates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListAnalysisTemplates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListAnalysisTemplates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListAnalysisTemplates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListAnalysisTemplates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListAnalysisTemplates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListAnalysisTemplates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListAnalysisTemplates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListAnalysisTemplates) # ListCollaborationAnalysisTemplates Lists analysis templates within a collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/analysistemplates?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_ListCollaborationAnalysisTemplates_RequestSyntax) ** A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [maxResults](#API_ListCollaborationAnalysisTemplates_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListCollaborationAnalysisTemplates_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationAnalysisTemplateSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "description": "string", "id": "string", "isSyntheticData": boolean, "name": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationAnalysisTemplateSummaries](#API_ListCollaborationAnalysisTemplates_ResponseSyntax) ** The metadata of the analysis template within a collaboration. Type: Array of [CollaborationAnalysisTemplateSummary](API_CollaborationAnalysisTemplateSummary.md) objects ** [nextToken](#API_ListCollaborationAnalysisTemplates_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListCollaborationAnalysisTemplates) # ListCollaborationChangeRequests Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/changeRequests?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_ListCollaborationChangeRequests_RequestSyntax) ** The identifier of the collaboration that the change request is made against. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [maxResults](#API_ListCollaborationChangeRequests_RequestSyntax) ** The maximum number of results that are returned for an API request call. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListCollaborationChangeRequests_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ** [status](#API_ListCollaborationChangeRequests_RequestSyntax) ** A filter to only return change requests with the specified status. Valid Values: `PENDING | APPROVED | CANCELLED | DENIED | COMMITTED` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationChangeRequestSummaries": [ { "approvals": { "string" : { "status": "string" } }, "changes": [ { "specification": { ... }, "specificationType": "string", "types": [ "string" ] } ], "collaborationId": "string", "createTime": number, "id": "string", "isAutoApproved": boolean, "status": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationChangeRequestSummaries](#API_ListCollaborationChangeRequests_ResponseSyntax) ** The list of collaboration change request summaries. Type: Array of [CollaborationChangeRequestSummary](API_CollaborationChangeRequestSummary.md) objects ** [nextToken](#API_ListCollaborationChangeRequests_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListCollaborationChangeRequests) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListCollaborationChangeRequests) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListCollaborationChangeRequests) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListCollaborationChangeRequests) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListCollaborationChangeRequests) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListCollaborationChangeRequests) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListCollaborationChangeRequests) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListCollaborationChangeRequests) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListCollaborationChangeRequests) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListCollaborationChangeRequests) # ListCollaborationConfiguredAudienceModelAssociations Lists configured audience model associations within a collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/configuredaudiencemodelassociations?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_ListCollaborationConfiguredAudienceModelAssociations_RequestSyntax) ** A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [maxResults](#API_ListCollaborationConfiguredAudienceModelAssociations_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListCollaborationConfiguredAudienceModelAssociations_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationConfiguredAudienceModelAssociationSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "description": "string", "id": "string", "name": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationConfiguredAudienceModelAssociationSummaries](#API_ListCollaborationConfiguredAudienceModelAssociations_ResponseSyntax) ** The metadata of the configured audience model association within a collaboration. Type: Array of [CollaborationConfiguredAudienceModelAssociationSummary](API_CollaborationConfiguredAudienceModelAssociationSummary.md) objects ** [nextToken](#API_ListCollaborationConfiguredAudienceModelAssociations_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListCollaborationConfiguredAudienceModelAssociations) # ListCollaborationIdNamespaceAssociations Returns a list of the ID namespace associations in a collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/idnamespaceassociations?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_ListCollaborationIdNamespaceAssociations_RequestSyntax) ** The unique identifier of the collaboration that contains the ID namespace associations that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [maxResults](#API_ListCollaborationIdNamespaceAssociations_RequestSyntax) ** The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.> Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListCollaborationIdNamespaceAssociations_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationIdNamespaceAssociationSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "description": "string", "id": "string", "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idNamespaceType": "string" }, "name": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationIdNamespaceAssociationSummaries](#API_ListCollaborationIdNamespaceAssociations_ResponseSyntax) ** The summary information of the collaboration ID namespace associations that you requested. Type: Array of [CollaborationIdNamespaceAssociationSummary](API_CollaborationIdNamespaceAssociationSummary.md) objects ** [nextToken](#API_ListCollaborationIdNamespaceAssociations_ResponseSyntax) ** The token value provided to access the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListCollaborationIdNamespaceAssociations) # ListCollaborationPrivacyBudgets 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. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/privacybudgets?accessBudgetResourceArn=accessBudgetResourceArn&maxResults=maxResults&nextToken=nextToken&privacyBudgetType=privacyBudgetType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [accessBudgetResourceArn](#API_ListCollaborationPrivacyBudgets_RequestSyntax) ** The Amazon Resource Name (ARN) of the Configured Table Association (ConfiguredTableAssociation) used to filter privacy budgets. Length Constraints: Minimum length of 0. Maximum length of 200. Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/(configuredtableassociation|intermediatetable)/[\d\w-]+` ** [collaborationIdentifier](#API_ListCollaborationPrivacyBudgets_RequestSyntax) ** A unique identifier for one of your collaborations. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [maxResults](#API_ListCollaborationPrivacyBudgets_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListCollaborationPrivacyBudgets_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ** [privacyBudgetType](#API_ListCollaborationPrivacyBudgets_RequestSyntax) ** Specifies the type of the privacy budget. Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationPrivacyBudgetSummaries": [ { "budget": { ... }, "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "id": "string", "privacyBudgetTemplateArn": "string", "privacyBudgetTemplateId": "string", "type": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationPrivacyBudgetSummaries](#API_ListCollaborationPrivacyBudgets_ResponseSyntax) ** Summaries of the collaboration privacy budgets. Type: Array of [CollaborationPrivacyBudgetSummary](API_CollaborationPrivacyBudgetSummary.md) objects ** [nextToken](#API_ListCollaborationPrivacyBudgets_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets) # ListCollaborationPrivacyBudgetTemplates Returns an array that summarizes each privacy budget template in a specified collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/privacybudgettemplates?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_ListCollaborationPrivacyBudgetTemplates_RequestSyntax) ** A unique identifier for one of your collaborations. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [maxResults](#API_ListCollaborationPrivacyBudgetTemplates_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListCollaborationPrivacyBudgetTemplates_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationPrivacyBudgetTemplateSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "id": "string", "privacyBudgetType": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationPrivacyBudgetTemplateSummaries](#API_ListCollaborationPrivacyBudgetTemplates_ResponseSyntax) ** An array that summarizes the collaboration privacy budget templates. The summary includes collaboration information, creation information, the privacy budget type. Type: Array of [CollaborationPrivacyBudgetTemplateSummary](API_CollaborationPrivacyBudgetTemplateSummary.md) objects ** [nextToken](#API_ListCollaborationPrivacyBudgetTemplates_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgetTemplates) # ListCollaborations Lists collaborations the caller owns, is active in, or has been invited to. ## Request Syntax ``` GET /collaborations?maxResults=maxResults&memberStatus=memberStatus&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListCollaborations_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [memberStatus](#API_ListCollaborations_RequestSyntax) ** The caller's status in a collaboration. Valid Values: `INVITED | ACTIVE` ** [nextToken](#API_ListCollaborations_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationList": [ { "analyticsEngine": "string", "arn": "string", "createTime": number, "creatorAccountId": "string", "creatorDisplayName": "string", "id": "string", "membershipArn": "string", "membershipId": "string", "memberStatus": "string", "name": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationList](#API_ListCollaborations_ResponseSyntax) ** The list of collaborations. Type: Array of [CollaborationSummary](API_CollaborationSummary.md) objects ** [nextToken](#API_ListCollaborations_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListCollaborations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListCollaborations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListCollaborations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListCollaborations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListCollaborations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListCollaborations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListCollaborations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListCollaborations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListCollaborations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListCollaborations) # ListConfiguredAudienceModelAssociations Lists information about requested configured audience model associations. ## Request Syntax ``` GET /memberships/membershipIdentifier/configuredaudiencemodelassociations?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListConfiguredAudienceModelAssociations_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [membershipIdentifier](#API_ListConfiguredAudienceModelAssociations_RequestSyntax) ** A unique identifier for a membership that contains the configured audience model associations that you want to retrieve. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [nextToken](#API_ListConfiguredAudienceModelAssociations_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredAudienceModelAssociationSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "configuredAudienceModelArn": "string", "createTime": number, "description": "string", "id": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredAudienceModelAssociationSummaries](#API_ListConfiguredAudienceModelAssociations_ResponseSyntax) ** Summaries of the configured audience model associations that you requested. Type: Array of [ConfiguredAudienceModelAssociationSummary](API_ConfiguredAudienceModelAssociationSummary.md) objects ** [nextToken](#API_ListConfiguredAudienceModelAssociations_ResponseSyntax) ** The token value provided to access the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListConfiguredAudienceModelAssociations) # ListConfiguredTableAssociations Lists configured table associations for a membership. ## Request Syntax ``` GET /memberships/membershipIdentifier/configuredTableAssociations?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListConfiguredTableAssociations_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [membershipIdentifier](#API_ListConfiguredTableAssociations_RequestSyntax) ** A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [nextToken](#API_ListConfiguredTableAssociations_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredTableAssociationSummaries": [ { "analysisRuleTypes": [ "string" ], "arn": "string", "configuredTableId": "string", "createTime": number, "id": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredTableAssociationSummaries](#API_ListConfiguredTableAssociations_ResponseSyntax) ** The retrieved list of configured table associations. Type: Array of [ConfiguredTableAssociationSummary](API_ConfiguredTableAssociationSummary.md) objects ** [nextToken](#API_ListConfiguredTableAssociations_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListConfiguredTableAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListConfiguredTableAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListConfiguredTableAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListConfiguredTableAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListConfiguredTableAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListConfiguredTableAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListConfiguredTableAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListConfiguredTableAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListConfiguredTableAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListConfiguredTableAssociations) # ListConfiguredTables Lists configured tables. ## Request Syntax ``` GET /configuredTables?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListConfiguredTables_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListConfiguredTables_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredTableSummaries": [ { "analysisMethod": "string", "analysisRuleTypes": [ "string" ], "arn": "string", "createTime": number, "id": "string", "name": "string", "selectedAnalysisMethods": [ "string" ], "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredTableSummaries](#API_ListConfiguredTables_ResponseSyntax) ** The configured tables listed by the request. Type: Array of [ConfiguredTableSummary](API_ConfiguredTableSummary.md) objects ** [nextToken](#API_ListConfiguredTables_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListConfiguredTables) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListConfiguredTables) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListConfiguredTables) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListConfiguredTables) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListConfiguredTables) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListConfiguredTables) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListConfiguredTables) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListConfiguredTables) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListConfiguredTables) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListConfiguredTables) # ListIdMappingTables Returns a list of ID mapping tables. ## Request Syntax ``` GET /memberships/membershipIdentifier/idmappingtables?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListIdMappingTables_RequestSyntax) ** The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [membershipIdentifier](#API_ListIdMappingTables_RequestSyntax) ** The unique identifier of the membership that contains the ID mapping tables that you want to view. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [nextToken](#API_ListIdMappingTables_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "idMappingTableSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [idMappingTableSummaries](#API_ListIdMappingTables_ResponseSyntax) ** The summary information of the ID mapping tables that you requested. Type: Array of [IdMappingTableSummary](API_IdMappingTableSummary.md) objects ** [nextToken](#API_ListIdMappingTables_ResponseSyntax) ** The token value provided to access the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListIdMappingTables) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListIdMappingTables) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListIdMappingTables) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListIdMappingTables) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListIdMappingTables) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListIdMappingTables) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListIdMappingTables) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListIdMappingTables) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListIdMappingTables) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListIdMappingTables) # ListIdNamespaceAssociations Returns a list of ID namespace associations. ## Request Syntax ``` GET /memberships/membershipIdentifier/idnamespaceassociations?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListIdNamespaceAssociations_RequestSyntax) ** The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [membershipIdentifier](#API_ListIdNamespaceAssociations_RequestSyntax) ** The unique identifier of the membership that contains the ID namespace association that you want to view. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [nextToken](#API_ListIdNamespaceAssociations_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "idNamespaceAssociationSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idNamespaceType": "string" }, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [idNamespaceAssociationSummaries](#API_ListIdNamespaceAssociations_ResponseSyntax) ** The summary information of the ID namespace associations that you requested. Type: Array of [IdNamespaceAssociationSummary](API_IdNamespaceAssociationSummary.md) objects ** [nextToken](#API_ListIdNamespaceAssociations_ResponseSyntax) ** The token value provided to access the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListIdNamespaceAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListIdNamespaceAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListIdNamespaceAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListIdNamespaceAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListIdNamespaceAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListIdNamespaceAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListIdNamespaceAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListIdNamespaceAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListIdNamespaceAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListIdNamespaceAssociations) # ListMembers Lists all members within a collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/members?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_ListMembers_RequestSyntax) ** The identifier of the collaboration in which the members are listed. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [maxResults](#API_ListMembers_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListMembers_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "memberSummaries": [ { "abilities": [ "string" ], "accountId": "string", "createTime": number, "displayName": "string", "membershipArn": "string", "membershipId": "string", "mlAbilities": { "customMLMemberAbilities": [ "string" ] }, "paymentConfiguration": { "jobCompute": { "isResponsible": boolean }, "machineLearning": { "modelInference": { "isResponsible": boolean }, "modelTraining": { "isResponsible": boolean }, "syntheticDataGeneration": { "isResponsible": boolean } }, "queryCompute": { "isResponsible": boolean } }, "status": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [memberSummaries](#API_ListMembers_ResponseSyntax) ** The list of members returned by the ListMembers operation. Type: Array of [MemberSummary](API_MemberSummary.md) objects ** [nextToken](#API_ListMembers_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListMembers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListMembers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListMembers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListMembers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListMembers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListMembers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListMembers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListMembers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListMembers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListMembers) # ListMemberships Lists all memberships resources within the caller's account. ## Request Syntax ``` GET /memberships?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListMemberships_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListMemberships_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ** [status](#API_ListMemberships_RequestSyntax) ** A filter which will return only memberships in the specified status. Valid Values: `ACTIVE | REMOVED | COLLABORATION_DELETED` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "membershipSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationCreatorAccountId": "string", "collaborationCreatorDisplayName": "string", "collaborationId": "string", "collaborationName": "string", "createTime": number, "id": "string", "memberAbilities": [ "string" ], "mlMemberAbilities": { "customMLMemberAbilities": [ "string" ] }, "paymentConfiguration": { "jobCompute": { "isResponsible": boolean }, "machineLearning": { "modelInference": { "isResponsible": boolean }, "modelTraining": { "isResponsible": boolean }, "syntheticDataGeneration": { "isResponsible": boolean } }, "queryCompute": { "isResponsible": boolean } }, "status": "string", "updateTime": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [membershipSummaries](#API_ListMemberships_ResponseSyntax) ** The list of memberships returned from the ListMemberships operation. Type: Array of [MembershipSummary](API_MembershipSummary.md) objects ** [nextToken](#API_ListMemberships_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListMemberships) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListMemberships) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListMemberships) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListMemberships) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListMemberships) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListMemberships) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListMemberships) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListMemberships) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListMemberships) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListMemberships) # ListPrivacyBudgets Returns detailed information about the privacy budgets in a specified membership. ## Request Syntax ``` GET /memberships/membershipIdentifier/privacybudgets?accessBudgetResourceArn=accessBudgetResourceArn&maxResults=maxResults&nextToken=nextToken&privacyBudgetType=privacyBudgetType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [accessBudgetResourceArn](#API_ListPrivacyBudgets_RequestSyntax) ** The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by. Length Constraints: Minimum length of 0. Maximum length of 200. Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/(configuredtableassociation|intermediatetable)/[\d\w-]+` ** [maxResults](#API_ListPrivacyBudgets_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [membershipIdentifier](#API_ListPrivacyBudgets_RequestSyntax) ** A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [nextToken](#API_ListPrivacyBudgets_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ** [privacyBudgetType](#API_ListPrivacyBudgets_RequestSyntax) ** The privacy budget type. Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "privacyBudgetSummaries": [ { "budget": { ... }, "collaborationArn": "string", "collaborationId": "string", "createTime": number, "id": "string", "membershipArn": "string", "membershipId": "string", "privacyBudgetTemplateArn": "string", "privacyBudgetTemplateId": "string", "type": "string", "updateTime": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListPrivacyBudgets_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ** [privacyBudgetSummaries](#API_ListPrivacyBudgets_ResponseSyntax) ** An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details. Type: Array of [PrivacyBudgetSummary](API_PrivacyBudgetSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListPrivacyBudgets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListPrivacyBudgets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListPrivacyBudgets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListPrivacyBudgets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListPrivacyBudgets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListPrivacyBudgets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListPrivacyBudgets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListPrivacyBudgets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListPrivacyBudgets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListPrivacyBudgets) # ListPrivacyBudgetTemplates Returns detailed information about the privacy budget templates in a specified membership. ## Request Syntax ``` GET /memberships/membershipIdentifier/privacybudgettemplates?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListPrivacyBudgetTemplates_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [membershipIdentifier](#API_ListPrivacyBudgetTemplates_RequestSyntax) ** A unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [nextToken](#API_ListPrivacyBudgetTemplates_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "privacyBudgetTemplateSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "id": "string", "membershipArn": "string", "membershipId": "string", "privacyBudgetType": "string", "updateTime": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListPrivacyBudgetTemplates_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ** [privacyBudgetTemplateSummaries](#API_ListPrivacyBudgetTemplates_ResponseSyntax) ** An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type. Type: Array of [PrivacyBudgetTemplateSummary](API_PrivacyBudgetTemplateSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListPrivacyBudgetTemplates) # ListProtectedJobs Lists protected jobs, sorted by most recent job. ## Request Syntax ``` GET /memberships/membershipIdentifier/protectedJobs?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListProtectedJobs_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [membershipIdentifier](#API_ListProtectedJobs_RequestSyntax) ** The identifier for the membership in the collaboration. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [nextToken](#API_ListProtectedJobs_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ** [status](#API_ListProtectedJobs_RequestSyntax) ** A filter on the status of the protected job. Valid Values: `SUBMITTED | STARTED | CANCELLED | CANCELLING | FAILED | SUCCESS` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "protectedJobs": [ { "createTime": number, "id": "string", "membershipArn": "string", "membershipId": "string", "receiverConfigurations": [ { "analysisType": "string", "configurationDetails": { ... } } ], "status": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListProtectedJobs_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ** [protectedJobs](#API_ListProtectedJobs_ResponseSyntax) ** A list of protected job summaries. Type: Array of [ProtectedJobSummary](API_ProtectedJobSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListProtectedJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListProtectedJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListProtectedJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListProtectedJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListProtectedJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListProtectedJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListProtectedJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListProtectedJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListProtectedJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListProtectedJobs) # ListProtectedQueries Lists protected queries, sorted by the most recent query. ## Request Syntax ``` GET /memberships/membershipIdentifier/protectedQueries?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListProtectedQueries_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [membershipIdentifier](#API_ListProtectedQueries_RequestSyntax) ** The identifier for the membership in the collaboration. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [nextToken](#API_ListProtectedQueries_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ** [status](#API_ListProtectedQueries_RequestSyntax) ** A filter on the status of the protected query. Valid Values: `SUBMITTED | STARTED | CANCELLED | CANCELLING | FAILED | SUCCESS | TIMED_OUT` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "protectedQueries": [ { "createTime": number, "id": "string", "membershipArn": "string", "membershipId": "string", "receiverConfigurations": [ { "analysisType": "string", "configurationDetails": { ... } } ], "status": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListProtectedQueries_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ** [protectedQueries](#API_ListProtectedQueries_ResponseSyntax) ** A list of protected queries. Type: Array of [ProtectedQuerySummary](API_ProtectedQuerySummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListProtectedQueries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListProtectedQueries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListProtectedQueries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListProtectedQueries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListProtectedQueries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListProtectedQueries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListProtectedQueries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListProtectedQueries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListProtectedQueries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListProtectedQueries) # ListSchemas Lists the schemas for relations within a collaboration. ## Request Syntax ``` GET /collaborations/collaborationIdentifier/schemas?maxResults=maxResults&nextToken=nextToken&schemaType=schemaType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_ListSchemas_RequestSyntax) ** A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [maxResults](#API_ListSchemas_RequestSyntax) ** The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListSchemas_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 0. Maximum length of 10240. ** [schemaType](#API_ListSchemas_RequestSyntax) ** If present, filter schemas by schema type. Valid Values: `TABLE | ID_MAPPING_TABLE` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "schemaSummaries": [ { "analysisMethod": "string", "analysisRuleTypes": [ "string" ], "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "name": "string", "resourceArn": "string", "selectedAnalysisMethods": [ "string" ], "type": "string", "updateTime": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListSchemas_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ** [schemaSummaries](#API_ListSchemas_ResponseSyntax) ** The retrieved list of schemas. Type: Array of [SchemaSummary](API_SchemaSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListSchemas) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListSchemas) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListSchemas) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListSchemas) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListSchemas) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListSchemas) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListSchemas) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListSchemas) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListSchemas) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListSchemas) # ListTagsForResource Lists all of the tags that have been added to a resource. ## Request Syntax ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) associated with the resource you want to list tags on. Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:[\d\w/-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [tags](#API_ListTagsForResource_ResponseSyntax) ** A map of objects specifying each key name and value. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ListTagsForResource) # PopulateIdMappingTable Defines the information that's necessary to populate an ID mapping table. ## Request Syntax ``` POST /memberships/membershipIdentifier/idmappingtables/idMappingTableIdentifier/populate HTTP/1.1 Content-type: application/json { "jobType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [idMappingTableIdentifier](#API_PopulateIdMappingTable_RequestSyntax) ** The unique identifier of the ID mapping table that you want to populate. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_PopulateIdMappingTable_RequestSyntax) ** The unique identifier of the membership that contains the ID mapping table that you want to populate. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [jobType](#API_PopulateIdMappingTable_RequestSyntax) ** The job type of the rule-based ID mapping job. Valid values include: `INCREMENTAL`: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in AWS Entity Resolution with `incrementalRunConfig` specified. `BATCH`: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in AWS Entity Resolution but `incrementalRunConfig` wasn't specified. `DELETE_ONLY`: Processes only deletion requests from `BatchDeleteUniqueId`, which is set in AWS Entity Resolution. For more information about `incrementalRunConfig` and `BatchDeleteUniqueId`, see the [AWS Entity Resolution API Reference](https://docs.aws.amazon.com/entityresolution/latest/apireference/Welcome.html). Type: String Valid Values: `BATCH | INCREMENTAL | DELETE_ONLY` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "idMappingJobId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [idMappingJobId](#API_PopulateIdMappingTable_ResponseSyntax) ** The unique identifier of the mapping job that will populate the ID mapping table. Type: String Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/PopulateIdMappingTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/PopulateIdMappingTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PopulateIdMappingTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/PopulateIdMappingTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PopulateIdMappingTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/PopulateIdMappingTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/PopulateIdMappingTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/PopulateIdMappingTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/PopulateIdMappingTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PopulateIdMappingTable) # PreviewPrivacyImpact An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters. ## Request Syntax ``` POST /memberships/membershipIdentifier/previewprivacyimpact HTTP/1.1 Content-type: application/json { "parameters": { ... } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_PreviewPrivacyImpact_RequestSyntax) ** A unique identifier for one of your memberships for a collaboration. Accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [parameters](#API_PreviewPrivacyImpact_RequestSyntax) ** Specifies the desired epsilon and noise parameters to preview. Type: [PreviewPrivacyImpactParametersInput](API_PreviewPrivacyImpactParametersInput.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "privacyImpact": { ... } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [privacyImpact](#API_PreviewPrivacyImpact_ResponseSyntax) ** An estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters. This does not change the privacy budget. Type: [PrivacyImpact](API_PrivacyImpact.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/PreviewPrivacyImpact) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/PreviewPrivacyImpact) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PreviewPrivacyImpact) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/PreviewPrivacyImpact) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PreviewPrivacyImpact) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/PreviewPrivacyImpact) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/PreviewPrivacyImpact) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/PreviewPrivacyImpact) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/PreviewPrivacyImpact) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PreviewPrivacyImpact) # StartProtectedJob Creates a protected job that is started by AWS Clean Rooms. ## Request Syntax ``` POST /memberships/membershipIdentifier/protectedJobs HTTP/1.1 Content-type: application/json { "computeConfiguration": { ... }, "jobParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" } }, "resultConfiguration": { "outputConfiguration": { ... } }, "type": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_StartProtectedJob_RequestSyntax) ** A unique identifier for the membership to run this job against. Currently accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [computeConfiguration](#API_StartProtectedJob_RequestSyntax) ** The compute configuration for the protected job. Type: [ProtectedJobComputeConfiguration](API_ProtectedJobComputeConfiguration.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [jobParameters](#API_StartProtectedJob_RequestSyntax) ** The job parameters. Type: [ProtectedJobParameters](API_ProtectedJobParameters.md) object Required: Yes ** [resultConfiguration](#API_StartProtectedJob_RequestSyntax) ** The details needed to write the job results. Type: [ProtectedJobResultConfigurationInput](API_ProtectedJobResultConfigurationInput.md) object Required: No ** [type](#API_StartProtectedJob_RequestSyntax) ** The type of protected job to start. Type: String Valid Values: `PYSPARK` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "protectedJob": { "computeConfiguration": { ... }, "createTime": number, "error": { "code": "string", "message": "string" }, "id": "string", "jobParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" } }, "membershipArn": "string", "membershipId": "string", "result": { "output": { ... } }, "resultConfiguration": { "outputConfiguration": { ... } }, "statistics": { "billedResourceUtilization": { "units": number }, "totalDurationInMillis": number }, "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [protectedJob](#API_StartProtectedJob_ResponseSyntax) ** The protected job. Type: [ProtectedJob](API_ProtectedJob.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/StartProtectedJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/StartProtectedJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/StartProtectedJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/StartProtectedJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/StartProtectedJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/StartProtectedJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/StartProtectedJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/StartProtectedJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/StartProtectedJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/StartProtectedJob) # StartProtectedQuery Creates a protected query that is started by AWS Clean Rooms. ## Request Syntax ``` POST /memberships/membershipIdentifier/protectedQueries HTTP/1.1 Content-type: application/json { "computeConfiguration": { ... }, "resultConfiguration": { "outputConfiguration": { ... } }, "sqlParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" }, "queryString": "string" }, "type": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_StartProtectedQuery_RequestSyntax) ** A unique identifier for the membership to run this query against. Currently accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [computeConfiguration](#API_StartProtectedQuery_RequestSyntax) ** The compute configuration for the protected query. Type: [ComputeConfiguration](API_ComputeConfiguration.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [resultConfiguration](#API_StartProtectedQuery_RequestSyntax) ** The details needed to write the query results. Type: [ProtectedQueryResultConfiguration](API_ProtectedQueryResultConfiguration.md) object Required: No ** [sqlParameters](#API_StartProtectedQuery_RequestSyntax) ** The protected SQL query parameters. Type: [ProtectedQuerySQLParameters](API_ProtectedQuerySQLParameters.md) object Required: Yes ** [type](#API_StartProtectedQuery_RequestSyntax) ** The type of the protected query to be started. Type: String Valid Values: `SQL` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "protectedQuery": { "computeConfiguration": { ... }, "createTime": number, "differentialPrivacy": { "sensitivityParameters": [ { "aggregationExpression": "string", "aggregationType": "string", "maxColumnValue": number, "minColumnValue": number, "userContributionLimit": number } ] }, "error": { "code": "string", "message": "string" }, "id": "string", "membershipArn": "string", "membershipId": "string", "result": { "output": { ... } }, "resultConfiguration": { "outputConfiguration": { ... } }, "sqlParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" }, "queryString": "string" }, "statistics": { "billedResourceUtilization": { "units": number }, "totalDurationInMillis": number }, "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [protectedQuery](#API_StartProtectedQuery_ResponseSyntax) ** The protected query. Type: [ProtectedQuery](API_ProtectedQuery.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/StartProtectedQuery) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/StartProtectedQuery) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/StartProtectedQuery) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/StartProtectedQuery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/StartProtectedQuery) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/StartProtectedQuery) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/StartProtectedQuery) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/StartProtectedQuery) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/StartProtectedQuery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/StartProtectedQuery) # TagResource Tags a resource. ## Request Syntax ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) associated with the resource you want to tag. Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:[\d\w/-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [tags](#API_TagResource_RequestSyntax) ** A map of objects specifying each key name and value. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/TagResource) # UntagResource Removes a tag or list of tags from a resource. ## Request Syntax ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from. Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:[\d\w/-]+` Required: Yes ** [tagKeys](#API_UntagResource_RequestSyntax) ** A list of key names of tags to be removed. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UntagResource) # UpdateAnalysisTemplate Updates the analysis template metadata. ## Request Syntax ``` PATCH /memberships/membershipIdentifier/analysistemplates/analysisTemplateIdentifier HTTP/1.1 Content-type: application/json { "description": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisTemplateIdentifier](#API_UpdateAnalysisTemplate_RequestSyntax) ** The identifier for the analysis template resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_UpdateAnalysisTemplate_RequestSyntax) ** The identifier for a membership resource. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [description](#API_UpdateAnalysisTemplate_RequestSyntax) ** A new description for the analysis template. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisTemplate": { "analysisParameters": [ { "defaultValue": "string", "name": "string", "type": "string" } ], "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "errorMessageConfiguration": { "type": "string" }, "format": "string", "id": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "schema": { "referencedTables": [ "string" ] }, "source": { ... }, "sourceMetadata": { ... }, "syntheticDataParameters": { ... }, "updateTime": number, "validations": [ { "reasons": [ { "message": "string" } ], "status": "string", "type": "string" } ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisTemplate](#API_UpdateAnalysisTemplate_ResponseSyntax) ** The analysis template. Type: [AnalysisTemplate](API_AnalysisTemplate.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateAnalysisTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateAnalysisTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateAnalysisTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateAnalysisTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateAnalysisTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateAnalysisTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateAnalysisTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateAnalysisTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateAnalysisTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateAnalysisTemplate) # UpdateCollaboration Updates collaboration metadata and can only be called by the collaboration owner. ## Request Syntax ``` PATCH /collaborations/collaborationIdentifier HTTP/1.1 Content-type: application/json { "analyticsEngine": "string", "description": "string", "name": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [collaborationIdentifier](#API_UpdateCollaboration_RequestSyntax) ** The identifier for the collaboration. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [analyticsEngine](#API_UpdateCollaboration_RequestSyntax) ** The analytics engine. After July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be available. Type: String Valid Values: `SPARK | CLEAN_ROOMS_SQL` Required: No ** [description](#API_UpdateCollaboration_RequestSyntax) ** A description of the collaboration. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [name](#API_UpdateCollaboration_RequestSyntax) ** A human-readable identifier provided by the collaboration owner. Display names are not unique. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaboration": { "allowedResultRegions": [ "string" ], "analyticsEngine": "string", "arn": "string", "autoApprovedChangeTypes": [ "string" ], "createTime": number, "creatorAccountId": "string", "creatorDisplayName": "string", "dataEncryptionMetadata": { "allowCleartext": boolean, "allowDuplicates": boolean, "allowJoinsOnColumnsWithDifferentNames": boolean, "preserveNulls": boolean }, "description": "string", "id": "string", "isMetricsEnabled": boolean, "jobLogStatus": "string", "membershipArn": "string", "membershipId": "string", "memberStatus": "string", "name": "string", "queryLogStatus": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaboration](#API_UpdateCollaboration_ResponseSyntax) ** The entire collaboration that has been updated. Type: [Collaboration](API_Collaboration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateCollaboration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateCollaboration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateCollaboration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateCollaboration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateCollaboration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateCollaboration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateCollaboration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateCollaboration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateCollaboration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateCollaboration) # UpdateCollaborationChangeRequest Updates an existing collaboration change request. This operation allows approval actions for pending change requests in collaborations (APPROVE, DENY, CANCEL, COMMIT). For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request. ## Request Syntax ``` PATCH /collaborations/collaborationIdentifier/changeRequests/changeRequestIdentifier HTTP/1.1 Content-type: application/json { "action": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [changeRequestIdentifier](#API_UpdateCollaborationChangeRequest_RequestSyntax) ** The unique identifier of the specific change request to be updated within the collaboration. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [collaborationIdentifier](#API_UpdateCollaborationChangeRequest_RequestSyntax) ** The unique identifier of the collaboration that contains the change request to be updated. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [action](#API_UpdateCollaborationChangeRequest_RequestSyntax) ** The action to perform on the change request. Valid values include APPROVE (approve the change), DENY (reject the change), CANCEL (cancel the request), and COMMIT (commit after the request is approved). For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request. Type: String Valid Values: `APPROVE | DENY | CANCEL | COMMIT` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "collaborationChangeRequest": { "approvals": { "string" : { "status": "string" } }, "changes": [ { "specification": { ... }, "specificationType": "string", "types": [ "string" ] } ], "collaborationId": "string", "createTime": number, "id": "string", "isAutoApproved": boolean, "status": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [collaborationChangeRequest](#API_UpdateCollaborationChangeRequest_ResponseSyntax) ** Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created. Type: [CollaborationChangeRequest](API_CollaborationChangeRequest.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateCollaborationChangeRequest) # UpdateConfiguredAudienceModelAssociation Provides the details necessary to update a configured audience model association. ## Request Syntax ``` PATCH /memberships/membershipIdentifier/configuredaudiencemodelassociations/configuredAudienceModelAssociationIdentifier HTTP/1.1 Content-type: application/json { "description": "string", "name": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredAudienceModelAssociationIdentifier](#API_UpdateConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier for the configured audience model association that you want to update. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_UpdateConfiguredAudienceModelAssociation_RequestSyntax) ** A unique identifier of the membership that contains the configured audience model association that you want to update. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [description](#API_UpdateConfiguredAudienceModelAssociation_RequestSyntax) ** A new description for the configured audience model association. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [name](#API_UpdateConfiguredAudienceModelAssociation_RequestSyntax) ** A new name for the configured audience model association. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredAudienceModelAssociation": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "configuredAudienceModelArn": "string", "createTime": number, "description": "string", "id": "string", "manageResourcePolicies": boolean, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredAudienceModelAssociation](#API_UpdateConfiguredAudienceModelAssociation_ResponseSyntax) ** Details about the configured audience model association that you updated. Type: [ConfiguredAudienceModelAssociation](API_ConfiguredAudienceModelAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateConfiguredAudienceModelAssociation) # UpdateConfiguredTable Updates a configured table. ## Request Syntax ``` PATCH /configuredTables/configuredTableIdentifier HTTP/1.1 Content-type: application/json { "allowedColumns": [ "string" ], "analysisMethod": "string", "description": "string", "name": "string", "selectedAnalysisMethods": [ "string" ], "tableReference": { ... } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredTableIdentifier](#API_UpdateConfiguredTable_RequestSyntax) ** The identifier for the configured table to update. Currently accepts the configured table ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [allowedColumns](#API_UpdateConfiguredTable_RequestSyntax) ** The columns of the underlying table that can be used by collaborations or analysis rules. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?` Required: No ** [analysisMethod](#API_UpdateConfiguredTable_RequestSyntax) ** The analysis method for the configured table. `DIRECT_QUERY` allows SQL queries to be run directly on this table. `DIRECT_JOB` allows PySpark jobs to be run directly on this table. `MULTIPLE` allows both SQL queries and PySpark jobs to be run directly on this table. Type: String Valid Values: `DIRECT_QUERY | DIRECT_JOB | MULTIPLE` Required: No ** [description](#API_UpdateConfiguredTable_RequestSyntax) ** A new description for the configured table. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [name](#API_UpdateConfiguredTable_RequestSyntax) ** A new name for the configured table. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` Required: No ** [selectedAnalysisMethods](#API_UpdateConfiguredTable_RequestSyntax) ** The selected analysis methods for the table configuration update. Type: Array of strings Valid Values: `DIRECT_QUERY | DIRECT_JOB` Required: No ** [tableReference](#API_UpdateConfiguredTable_RequestSyntax) ** A pointer to the dataset that underlies this table. Type: [TableReference](API_TableReference.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredTable": { "allowedColumns": [ "string" ], "analysisMethod": "string", "analysisRuleTypes": [ "string" ], "arn": "string", "createTime": number, "description": "string", "id": "string", "name": "string", "selectedAnalysisMethods": [ "string" ], "tableReference": { ... }, "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredTable](#API_UpdateConfiguredTable_ResponseSyntax) ** The updated configured table. Type: [ConfiguredTable](API_ConfiguredTable.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ServiceQuotaExceededException ** Request denied because service quota has been exceeded. ** quotaName ** The name of the quota. ** quotaValue ** The value of the quota. HTTP Status Code: 402 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateConfiguredTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateConfiguredTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateConfiguredTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateConfiguredTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateConfiguredTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateConfiguredTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateConfiguredTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateConfiguredTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateConfiguredTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateConfiguredTable) # UpdateConfiguredTableAnalysisRule Updates a configured table analysis rule. ## Request Syntax ``` PATCH /configuredTables/configuredTableIdentifier/analysisRule/analysisRuleType HTTP/1.1 Content-type: application/json { "analysisRulePolicy": { ... } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisRuleType](#API_UpdateConfiguredTableAnalysisRule_RequestSyntax) ** The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type. Valid Values: `AGGREGATION | LIST | CUSTOM` Required: Yes ** [configuredTableIdentifier](#API_UpdateConfiguredTableAnalysisRule_RequestSyntax) ** The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [analysisRulePolicy](#API_UpdateConfiguredTableAnalysisRule_RequestSyntax) ** The new analysis rule policy for the configured table analysis rule. Type: [ConfiguredTableAnalysisRulePolicy](API_ConfiguredTableAnalysisRulePolicy.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisRule": { "configuredTableArn": "string", "configuredTableId": "string", "createTime": number, "policy": { ... }, "type": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisRule](#API_UpdateConfiguredTableAnalysisRule_ResponseSyntax) ** The entire updated analysis rule. Type: [ConfiguredTableAnalysisRule](API_ConfiguredTableAnalysisRule.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateConfiguredTableAnalysisRule) # UpdateConfiguredTableAssociation Updates a configured table association. ## Request Syntax ``` PATCH /memberships/membershipIdentifier/configuredTableAssociations/configuredTableAssociationIdentifier HTTP/1.1 Content-type: application/json { "description": "string", "roleArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [configuredTableAssociationIdentifier](#API_UpdateConfiguredTableAssociation_RequestSyntax) ** The unique identifier for the configured table association to update. Currently accepts the configured table association ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_UpdateConfiguredTableAssociation_RequestSyntax) ** The unique ID for the membership that the configured table association belongs to. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [description](#API_UpdateConfiguredTableAssociation_RequestSyntax) ** A new description for the configured table association. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [roleArn](#API_UpdateConfiguredTableAssociation_RequestSyntax) ** The service will assume this role to access catalog metadata and query the table. Type: String Length Constraints: Minimum length of 32. Maximum length of 512. Pattern: `arn:aws:iam::[\w]+:role/[\w+=./@-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configuredTableAssociation": { "analysisRuleTypes": [ "string" ], "arn": "string", "configuredTableArn": "string", "configuredTableId": "string", "createTime": number, "description": "string", "id": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "roleArn": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configuredTableAssociation](#API_UpdateConfiguredTableAssociation_ResponseSyntax) ** The entire updated configured table association. Type: [ConfiguredTableAssociation](API_ConfiguredTableAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateConfiguredTableAssociation) # UpdateConfiguredTableAssociationAnalysisRule Updates the analysis rule for a configured table association. ## Request Syntax ``` PATCH /memberships/membershipIdentifier/configuredTableAssociations/configuredTableAssociationIdentifier/analysisRule/analysisRuleType HTTP/1.1 Content-type: application/json { "analysisRulePolicy": { ... } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisRuleType](#API_UpdateConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The analysis rule type that you want to update. Valid Values: `AGGREGATION | LIST | CUSTOM` Required: Yes ** [configuredTableAssociationIdentifier](#API_UpdateConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The identifier for the configured table association to update. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_UpdateConfiguredTableAssociationAnalysisRule_RequestSyntax) ** A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [analysisRulePolicy](#API_UpdateConfiguredTableAssociationAnalysisRule_RequestSyntax) ** The updated analysis rule policy for the conﬁgured table association. Type: [ConfiguredTableAssociationAnalysisRulePolicy](API_ConfiguredTableAssociationAnalysisRulePolicy.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisRule": { "configuredTableAssociationArn": "string", "configuredTableAssociationId": "string", "createTime": number, "membershipIdentifier": "string", "policy": { ... }, "type": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [analysisRule](#API_UpdateConfiguredTableAssociationAnalysisRule_ResponseSyntax) ** The updated analysis rule for the conﬁgured table association. In the console, the `ConfiguredTableAssociationAnalysisRule` is referred to as the *collaboration analysis rule*. Type: [ConfiguredTableAssociationAnalysisRule](API_ConfiguredTableAssociationAnalysisRule.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateConfiguredTableAssociationAnalysisRule) # UpdateIdMappingTable Provides the details that are necessary to update an ID mapping table. ## Request Syntax ``` PATCH /memberships/membershipIdentifier/idmappingtables/idMappingTableIdentifier HTTP/1.1 Content-type: application/json { "description": "string", "kmsKeyArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [idMappingTableIdentifier](#API_UpdateIdMappingTable_RequestSyntax) ** The unique identifier of the ID mapping table that you want to update. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_UpdateIdMappingTable_RequestSyntax) ** The unique identifier of the membership that contains the ID mapping table that you want to update. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [description](#API_UpdateIdMappingTable_RequestSyntax) ** A new description for the ID mapping table. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [kmsKeyArn](#API_UpdateIdMappingTable_RequestSyntax) ** The Amazon Resource Name (ARN) of the AWS KMS key. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws:kms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:key/[a-zA-Z0-9-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "idMappingTable": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idMappingTableInputSource": [ { "idNamespaceAssociationId": "string", "type": "string" } ] }, "kmsKeyArn": "string", "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [idMappingTable](#API_UpdateIdMappingTable_ResponseSyntax) ** The updated ID mapping table. Type: [IdMappingTable](API_IdMappingTable.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateIdMappingTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateIdMappingTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateIdMappingTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateIdMappingTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateIdMappingTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateIdMappingTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateIdMappingTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateIdMappingTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateIdMappingTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateIdMappingTable) # UpdateIdNamespaceAssociation Provides the details that are necessary to update an ID namespace association. ## Request Syntax ``` PATCH /memberships/membershipIdentifier/idnamespaceassociations/idNamespaceAssociationIdentifier HTTP/1.1 Content-type: application/json { "description": "string", "idMappingConfig": { "allowUseAsDimensionColumn": boolean }, "name": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [idNamespaceAssociationIdentifier](#API_UpdateIdNamespaceAssociation_RequestSyntax) ** The unique identifier of the ID namespace association that you want to update. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [membershipIdentifier](#API_UpdateIdNamespaceAssociation_RequestSyntax) ** The unique identifier of the membership that contains the ID namespace association that you want to update. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [description](#API_UpdateIdNamespaceAssociation_RequestSyntax) ** A new description for the ID namespace association. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*` Required: No ** [idMappingConfig](#API_UpdateIdNamespaceAssociation_RequestSyntax) ** The configuration settings for the ID mapping table. Type: [IdMappingConfig](API_IdMappingConfig.md) object Required: No ** [name](#API_UpdateIdNamespaceAssociation_RequestSyntax) ** A new name for the ID namespace association. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "idNamespaceAssociation": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "idMappingConfig": { "allowUseAsDimensionColumn": boolean }, "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idMappingWorkflowsSupported": [ JSON value ], "idNamespaceType": "string" }, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [idNamespaceAssociation](#API_UpdateIdNamespaceAssociation_ResponseSyntax) ** The updated ID namespace association. Type: [IdNamespaceAssociation](API_IdNamespaceAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateIdNamespaceAssociation) # UpdateMembership Updates a membership. ## Request Syntax ``` PATCH /memberships/membershipIdentifier HTTP/1.1 Content-type: application/json { "defaultJobResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "defaultResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "jobLogStatus": "string", "queryLogStatus": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_UpdateMembership_RequestSyntax) ** The unique identifier of the membership. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [defaultJobResultConfiguration](#API_UpdateMembership_RequestSyntax) ** The default job result configuration. Type: [MembershipProtectedJobResultConfiguration](API_MembershipProtectedJobResultConfiguration.md) object Required: No ** [defaultResultConfiguration](#API_UpdateMembership_RequestSyntax) ** The default protected query result configuration as specified by the member who can receive results. Type: [MembershipProtectedQueryResultConfiguration](API_MembershipProtectedQueryResultConfiguration.md) object Required: No ** [jobLogStatus](#API_UpdateMembership_RequestSyntax) ** An indicator as to whether job logging has been enabled or disabled for the collaboration. When `ENABLED`, AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`. Type: String Valid Values: `ENABLED | DISABLED` Required: No ** [queryLogStatus](#API_UpdateMembership_RequestSyntax) ** An indicator as to whether query logging has been enabled or disabled for the membership. When `ENABLED`, AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`. Type: String Valid Values: `ENABLED | DISABLED` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "membership": { "arn": "string", "collaborationArn": "string", "collaborationCreatorAccountId": "string", "collaborationCreatorDisplayName": "string", "collaborationId": "string", "collaborationName": "string", "createTime": number, "defaultJobResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "defaultResultConfiguration": { "outputConfiguration": { ... }, "roleArn": "string" }, "id": "string", "isMetricsEnabled": boolean, "jobLogStatus": "string", "memberAbilities": [ "string" ], "mlMemberAbilities": { "customMLMemberAbilities": [ "string" ] }, "paymentConfiguration": { "jobCompute": { "isResponsible": boolean }, "machineLearning": { "modelInference": { "isResponsible": boolean }, "modelTraining": { "isResponsible": boolean }, "syntheticDataGeneration": { "isResponsible": boolean } }, "queryCompute": { "isResponsible": boolean } }, "queryLogStatus": "string", "status": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [membership](#API_UpdateMembership_ResponseSyntax) ** The membership object. Type: [Membership](API_Membership.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateMembership) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateMembership) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateMembership) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateMembership) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateMembership) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateMembership) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateMembership) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateMembership) # UpdatePrivacyBudgetTemplate Updates the privacy budget template for the specified collaboration. ## Request Syntax ``` PATCH /memberships/membershipIdentifier/privacybudgettemplates/privacyBudgetTemplateIdentifier HTTP/1.1 Content-type: application/json { "parameters": { ... }, "privacyBudgetType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_UpdatePrivacyBudgetTemplate_RequestSyntax) ** A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [privacyBudgetTemplateIdentifier](#API_UpdatePrivacyBudgetTemplate_RequestSyntax) ** A unique identifier for your privacy budget template that you want to update. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [parameters](#API_UpdatePrivacyBudgetTemplate_RequestSyntax) ** Specifies the epsilon and noise parameters for the privacy budget template. Type: [PrivacyBudgetTemplateUpdateParameters](API_PrivacyBudgetTemplateUpdateParameters.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [privacyBudgetType](#API_UpdatePrivacyBudgetTemplate_RequestSyntax) ** Specifies the type of the privacy budget template. Type: String Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "privacyBudgetTemplate": { "arn": "string", "autoRefresh": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "id": "string", "membershipArn": "string", "membershipId": "string", "parameters": { ... }, "privacyBudgetType": "string", "updateTime": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [privacyBudgetTemplate](#API_UpdatePrivacyBudgetTemplate_ResponseSyntax) ** Summary of the privacy budget template. Type: [PrivacyBudgetTemplate](API_PrivacyBudgetTemplate.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdatePrivacyBudgetTemplate) # UpdateProtectedJob Updates the processing of a currently running job. ## Request Syntax ``` PATCH /memberships/membershipIdentifier/protectedJobs/protectedJobIdentifier HTTP/1.1 Content-type: application/json { "targetStatus": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_UpdateProtectedJob_RequestSyntax) ** The identifier for a member of a protected job instance. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [protectedJobIdentifier](#API_UpdateProtectedJob_RequestSyntax) ** The identifier of the protected job to update. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [targetStatus](#API_UpdateProtectedJob_RequestSyntax) ** The target status of a protected job. Used to update the execution status of a currently running job. Type: String Valid Values: `CANCELLED` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "protectedJob": { "computeConfiguration": { ... }, "createTime": number, "error": { "code": "string", "message": "string" }, "id": "string", "jobParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" } }, "membershipArn": "string", "membershipId": "string", "result": { "output": { ... } }, "resultConfiguration": { "outputConfiguration": { ... } }, "statistics": { "billedResourceUtilization": { "units": number }, "totalDurationInMillis": number }, "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [protectedJob](#API_UpdateProtectedJob_ResponseSyntax) ** The protected job output. Type: [ProtectedJob](API_ProtectedJob.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateProtectedJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateProtectedJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateProtectedJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateProtectedJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateProtectedJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateProtectedJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateProtectedJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateProtectedJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateProtectedJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateProtectedJob) # UpdateProtectedQuery Updates the processing of a currently running query. ## Request Syntax ``` PATCH /memberships/membershipIdentifier/protectedQueries/protectedQueryIdentifier HTTP/1.1 Content-type: application/json { "targetStatus": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [membershipIdentifier](#API_UpdateProtectedQuery_RequestSyntax) ** The identifier for a member of a protected query instance. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ** [protectedQueryIdentifier](#API_UpdateProtectedQuery_RequestSyntax) ** The identifier for a protected query instance. Length Constraints: Fixed length of 36. Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [targetStatus](#API_UpdateProtectedQuery_RequestSyntax) ** The target status of a query. Used to update the execution status of a currently running query. Type: String Valid Values: `CANCELLED` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "protectedQuery": { "computeConfiguration": { ... }, "createTime": number, "differentialPrivacy": { "sensitivityParameters": [ { "aggregationExpression": "string", "aggregationType": "string", "maxColumnValue": number, "minColumnValue": number, "userContributionLimit": number } ] }, "error": { "code": "string", "message": "string" }, "id": "string", "membershipArn": "string", "membershipId": "string", "result": { "output": { ... } }, "resultConfiguration": { "outputConfiguration": { ... } }, "sqlParameters": { "analysisTemplateArn": "string", "parameters": { "string" : "string" }, "queryString": "string" }, "statistics": { "billedResourceUtilization": { "units": number }, "totalDurationInMillis": number }, "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [protectedQuery](#API_UpdateProtectedQuery_ResponseSyntax) ** The protected query output. Type: [ProtectedQuery](API_ProtectedQuery.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Caller does not have sufficient access to perform this action. ** reason ** A reason code for the exception. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** reason ** A reason code for the exception. ** resourceId ** The ID of the conflicting resource. ** resourceType ** The type of the conflicting resource. HTTP Status Code: 409 ** InternalServerException ** Unexpected error during processing of request. HTTP Status Code: 500 ** ResourceNotFoundException ** Request references a resource which does not exist. ** resourceId ** The Id of the missing resource. ** resourceType ** The type of the missing resource. HTTP Status Code: 404 ** ThrottlingException ** Request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the specified constraints. ** fieldList ** Validation errors for specific input parameters. ** reason ** A reason code for the exception. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cleanrooms-2022-02-17/UpdateProtectedQuery) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cleanrooms-2022-02-17/UpdateProtectedQuery) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/UpdateProtectedQuery) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cleanrooms-2022-02-17/UpdateProtectedQuery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/UpdateProtectedQuery) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cleanrooms-2022-02-17/UpdateProtectedQuery) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cleanrooms-2022-02-17/UpdateProtectedQuery) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cleanrooms-2022-02-17/UpdateProtectedQuery) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cleanrooms-2022-02-17/UpdateProtectedQuery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/UpdateProtectedQuery)