| Current File : //proc/self/root/lib/python3/dist-packages/botocore/data/cleanrooms/2022-02-17/service-2.json |
{
"version":"2.0",
"metadata":{
"apiVersion":"2022-02-17",
"endpointPrefix":"cleanrooms",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS Clean Rooms Service",
"serviceId":"CleanRooms",
"signatureVersion":"v4",
"signingName":"cleanrooms",
"uid":"cleanrooms-2022-02-17"
},
"operations":{
"BatchGetCollaborationAnalysisTemplate":{
"name":"BatchGetCollaborationAnalysisTemplate",
"http":{
"method":"POST",
"requestUri":"/collaborations/{collaborationIdentifier}/batch-analysistemplates",
"responseCode":200
},
"input":{"shape":"BatchGetCollaborationAnalysisTemplateInput"},
"output":{"shape":"BatchGetCollaborationAnalysisTemplateOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).</p>"
},
"BatchGetSchema":{
"name":"BatchGetSchema",
"http":{
"method":"POST",
"requestUri":"/collaborations/{collaborationIdentifier}/batch-schema",
"responseCode":200
},
"input":{"shape":"BatchGetSchemaInput"},
"output":{"shape":"BatchGetSchemaOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves multiple schemas by their identifiers.</p>"
},
"CreateAnalysisTemplate":{
"name":"CreateAnalysisTemplate",
"http":{
"method":"POST",
"requestUri":"/memberships/{membershipIdentifier}/analysistemplates",
"responseCode":200
},
"input":{"shape":"CreateAnalysisTemplateInput"},
"output":{"shape":"CreateAnalysisTemplateOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a new analysis template.</p>"
},
"CreateCollaboration":{
"name":"CreateCollaboration",
"http":{
"method":"POST",
"requestUri":"/collaborations",
"responseCode":200
},
"input":{"shape":"CreateCollaborationInput"},
"output":{"shape":"CreateCollaborationOutput"},
"errors":[
{"shape":"ServiceQuotaExceededException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a new collaboration.</p>"
},
"CreateConfiguredAudienceModelAssociation":{
"name":"CreateConfiguredAudienceModelAssociation",
"http":{
"method":"POST",
"requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations",
"responseCode":200
},
"input":{"shape":"CreateConfiguredAudienceModelAssociationInput"},
"output":{"shape":"CreateConfiguredAudienceModelAssociationOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Provides the details necessary to create a configured audience model association.</p>"
},
"CreateConfiguredTable":{
"name":"CreateConfiguredTable",
"http":{
"method":"POST",
"requestUri":"/configuredTables",
"responseCode":200
},
"input":{"shape":"CreateConfiguredTableInput"},
"output":{"shape":"CreateConfiguredTableOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a new configured table resource.</p>",
"idempotent":true
},
"CreateConfiguredTableAnalysisRule":{
"name":"CreateConfiguredTableAnalysisRule",
"http":{
"method":"POST",
"requestUri":"/configuredTables/{configuredTableIdentifier}/analysisRule",
"responseCode":200
},
"input":{"shape":"CreateConfiguredTableAnalysisRuleInput"},
"output":{"shape":"CreateConfiguredTableAnalysisRuleOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.</p>",
"idempotent":true
},
"CreateConfiguredTableAssociation":{
"name":"CreateConfiguredTableAssociation",
"http":{
"method":"POST",
"requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations",
"responseCode":200
},
"input":{"shape":"CreateConfiguredTableAssociationInput"},
"output":{"shape":"CreateConfiguredTableAssociationOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a configured table association. A configured table association links a configured table with a collaboration.</p>"
},
"CreateMembership":{
"name":"CreateMembership",
"http":{
"method":"POST",
"requestUri":"/memberships",
"responseCode":200
},
"input":{"shape":"CreateMembershipInput"},
"output":{"shape":"CreateMembershipOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a membership for a specific collaboration identifier and joins the collaboration.</p>"
},
"CreatePrivacyBudgetTemplate":{
"name":"CreatePrivacyBudgetTemplate",
"http":{
"method":"POST",
"requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates",
"responseCode":200
},
"input":{"shape":"CreatePrivacyBudgetTemplateInput"},
"output":{"shape":"CreatePrivacyBudgetTemplateOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the <a>UpdatePrivacyBudgetTemplate</a> operation.</p>"
},
"DeleteAnalysisTemplate":{
"name":"DeleteAnalysisTemplate",
"http":{
"method":"DELETE",
"requestUri":"/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}",
"responseCode":204
},
"input":{"shape":"DeleteAnalysisTemplateInput"},
"output":{"shape":"DeleteAnalysisTemplateOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes an analysis template.</p>",
"idempotent":true
},
"DeleteCollaboration":{
"name":"DeleteCollaboration",
"http":{
"method":"DELETE",
"requestUri":"/collaborations/{collaborationIdentifier}",
"responseCode":204
},
"input":{"shape":"DeleteCollaborationInput"},
"output":{"shape":"DeleteCollaborationOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes a collaboration. It can only be called by the collaboration owner.</p>",
"idempotent":true
},
"DeleteConfiguredAudienceModelAssociation":{
"name":"DeleteConfiguredAudienceModelAssociation",
"http":{
"method":"DELETE",
"requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}",
"responseCode":204
},
"input":{"shape":"DeleteConfiguredAudienceModelAssociationInput"},
"output":{"shape":"DeleteConfiguredAudienceModelAssociationOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Provides the information necessary to delete a configured audience model association.</p>",
"idempotent":true
},
"DeleteConfiguredTable":{
"name":"DeleteConfiguredTable",
"http":{
"method":"DELETE",
"requestUri":"/configuredTables/{configuredTableIdentifier}",
"responseCode":204
},
"input":{"shape":"DeleteConfiguredTableInput"},
"output":{"shape":"DeleteConfiguredTableOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes a configured table.</p>",
"idempotent":true
},
"DeleteConfiguredTableAnalysisRule":{
"name":"DeleteConfiguredTableAnalysisRule",
"http":{
"method":"DELETE",
"requestUri":"/configuredTables/{configuredTableIdentifier}/analysisRule/{analysisRuleType}",
"responseCode":204
},
"input":{"shape":"DeleteConfiguredTableAnalysisRuleInput"},
"output":{"shape":"DeleteConfiguredTableAnalysisRuleOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes a configured table analysis rule.</p>",
"idempotent":true
},
"DeleteConfiguredTableAssociation":{
"name":"DeleteConfiguredTableAssociation",
"http":{
"method":"DELETE",
"requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}",
"responseCode":204
},
"input":{"shape":"DeleteConfiguredTableAssociationInput"},
"output":{"shape":"DeleteConfiguredTableAssociationOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes a configured table association.</p>",
"idempotent":true
},
"DeleteMember":{
"name":"DeleteMember",
"http":{
"method":"DELETE",
"requestUri":"/collaborations/{collaborationIdentifier}/member/{accountId}",
"responseCode":204
},
"input":{"shape":"DeleteMemberInput"},
"output":{"shape":"DeleteMemberOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>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.</p>",
"idempotent":true
},
"DeleteMembership":{
"name":"DeleteMembership",
"http":{
"method":"DELETE",
"requestUri":"/memberships/{membershipIdentifier}",
"responseCode":204
},
"input":{"shape":"DeleteMembershipInput"},
"output":{"shape":"DeleteMembershipOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes a specified membership. All resources under a membership must be deleted.</p>",
"idempotent":true
},
"DeletePrivacyBudgetTemplate":{
"name":"DeletePrivacyBudgetTemplate",
"http":{
"method":"DELETE",
"requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}",
"responseCode":204
},
"input":{"shape":"DeletePrivacyBudgetTemplateInput"},
"output":{"shape":"DeletePrivacyBudgetTemplateOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes a privacy budget template for a specified membership.</p>",
"idempotent":true
},
"GetAnalysisTemplate":{
"name":"GetAnalysisTemplate",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}",
"responseCode":200
},
"input":{"shape":"GetAnalysisTemplateInput"},
"output":{"shape":"GetAnalysisTemplateOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves an analysis template.</p>"
},
"GetCollaboration":{
"name":"GetCollaboration",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}",
"responseCode":200
},
"input":{"shape":"GetCollaborationInput"},
"output":{"shape":"GetCollaborationOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Returns metadata about a collaboration.</p>"
},
"GetCollaborationAnalysisTemplate":{
"name":"GetCollaborationAnalysisTemplate",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/analysistemplates/{analysisTemplateArn}",
"responseCode":200
},
"input":{"shape":"GetCollaborationAnalysisTemplateInput"},
"output":{"shape":"GetCollaborationAnalysisTemplateOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves an analysis template within a collaboration.</p>"
},
"GetCollaborationConfiguredAudienceModelAssociation":{
"name":"GetCollaborationConfiguredAudienceModelAssociation",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}",
"responseCode":200
},
"input":{"shape":"GetCollaborationConfiguredAudienceModelAssociationInput"},
"output":{"shape":"GetCollaborationConfiguredAudienceModelAssociationOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a configured audience model association within a collaboration.</p>"
},
"GetCollaborationPrivacyBudgetTemplate":{
"name":"GetCollaborationPrivacyBudgetTemplate",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}",
"responseCode":200
},
"input":{"shape":"GetCollaborationPrivacyBudgetTemplateInput"},
"output":{"shape":"GetCollaborationPrivacyBudgetTemplateOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Returns details about a specified privacy budget template.</p>"
},
"GetConfiguredAudienceModelAssociation":{
"name":"GetConfiguredAudienceModelAssociation",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}",
"responseCode":200
},
"input":{"shape":"GetConfiguredAudienceModelAssociationInput"},
"output":{"shape":"GetConfiguredAudienceModelAssociationOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Returns information about a configured audience model association.</p>"
},
"GetConfiguredTable":{
"name":"GetConfiguredTable",
"http":{
"method":"GET",
"requestUri":"/configuredTables/{configuredTableIdentifier}",
"responseCode":200
},
"input":{"shape":"GetConfiguredTableInput"},
"output":{"shape":"GetConfiguredTableOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a configured table.</p>"
},
"GetConfiguredTableAnalysisRule":{
"name":"GetConfiguredTableAnalysisRule",
"http":{
"method":"GET",
"requestUri":"/configuredTables/{configuredTableIdentifier}/analysisRule/{analysisRuleType}",
"responseCode":200
},
"input":{"shape":"GetConfiguredTableAnalysisRuleInput"},
"output":{"shape":"GetConfiguredTableAnalysisRuleOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a configured table analysis rule.</p>"
},
"GetConfiguredTableAssociation":{
"name":"GetConfiguredTableAssociation",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}",
"responseCode":200
},
"input":{"shape":"GetConfiguredTableAssociationInput"},
"output":{"shape":"GetConfiguredTableAssociationOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a configured table association.</p>"
},
"GetMembership":{
"name":"GetMembership",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}",
"responseCode":200
},
"input":{"shape":"GetMembershipInput"},
"output":{"shape":"GetMembershipOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a specified membership for an identifier.</p>"
},
"GetPrivacyBudgetTemplate":{
"name":"GetPrivacyBudgetTemplate",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}",
"responseCode":200
},
"input":{"shape":"GetPrivacyBudgetTemplateInput"},
"output":{"shape":"GetPrivacyBudgetTemplateOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Returns details for a specified privacy budget template.</p>"
},
"GetProtectedQuery":{
"name":"GetProtectedQuery",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/protectedQueries/{protectedQueryIdentifier}",
"responseCode":200
},
"input":{"shape":"GetProtectedQueryInput"},
"output":{"shape":"GetProtectedQueryOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Returns query processing metadata.</p>"
},
"GetSchema":{
"name":"GetSchema",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/schemas/{name}",
"responseCode":200
},
"input":{"shape":"GetSchemaInput"},
"output":{"shape":"GetSchemaOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves the schema for a relation within a collaboration.</p>"
},
"GetSchemaAnalysisRule":{
"name":"GetSchemaAnalysisRule",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/schemas/{name}/analysisRule/{type}",
"responseCode":200
},
"input":{"shape":"GetSchemaAnalysisRuleInput"},
"output":{"shape":"GetSchemaAnalysisRuleOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a schema analysis rule.</p>"
},
"ListAnalysisTemplates":{
"name":"ListAnalysisTemplates",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/analysistemplates",
"responseCode":200
},
"input":{"shape":"ListAnalysisTemplatesInput"},
"output":{"shape":"ListAnalysisTemplatesOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists analysis templates that the caller owns.</p>"
},
"ListCollaborationAnalysisTemplates":{
"name":"ListCollaborationAnalysisTemplates",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/analysistemplates",
"responseCode":200
},
"input":{"shape":"ListCollaborationAnalysisTemplatesInput"},
"output":{"shape":"ListCollaborationAnalysisTemplatesOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists analysis templates within a collaboration.</p>"
},
"ListCollaborationConfiguredAudienceModelAssociations":{
"name":"ListCollaborationConfiguredAudienceModelAssociations",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/configuredaudiencemodelassociations",
"responseCode":200
},
"input":{"shape":"ListCollaborationConfiguredAudienceModelAssociationsInput"},
"output":{"shape":"ListCollaborationConfiguredAudienceModelAssociationsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists configured audience model associations within a collaboration.</p>"
},
"ListCollaborationPrivacyBudgetTemplates":{
"name":"ListCollaborationPrivacyBudgetTemplates",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/privacybudgettemplates",
"responseCode":200
},
"input":{"shape":"ListCollaborationPrivacyBudgetTemplatesInput"},
"output":{"shape":"ListCollaborationPrivacyBudgetTemplatesOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Returns an array that summarizes each privacy budget template in a specified collaboration.</p>"
},
"ListCollaborationPrivacyBudgets":{
"name":"ListCollaborationPrivacyBudgets",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/privacybudgets",
"responseCode":200
},
"input":{"shape":"ListCollaborationPrivacyBudgetsInput"},
"output":{"shape":"ListCollaborationPrivacyBudgetsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>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.</p>"
},
"ListCollaborations":{
"name":"ListCollaborations",
"http":{
"method":"GET",
"requestUri":"/collaborations",
"responseCode":200
},
"input":{"shape":"ListCollaborationsInput"},
"output":{"shape":"ListCollaborationsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists collaborations the caller owns, is active in, or has been invited to.</p>"
},
"ListConfiguredAudienceModelAssociations":{
"name":"ListConfiguredAudienceModelAssociations",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations",
"responseCode":200
},
"input":{"shape":"ListConfiguredAudienceModelAssociationsInput"},
"output":{"shape":"ListConfiguredAudienceModelAssociationsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists information about requested configured audience model associations.</p>"
},
"ListConfiguredTableAssociations":{
"name":"ListConfiguredTableAssociations",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations",
"responseCode":200
},
"input":{"shape":"ListConfiguredTableAssociationsInput"},
"output":{"shape":"ListConfiguredTableAssociationsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists configured table associations for a membership.</p>"
},
"ListConfiguredTables":{
"name":"ListConfiguredTables",
"http":{
"method":"GET",
"requestUri":"/configuredTables",
"responseCode":200
},
"input":{"shape":"ListConfiguredTablesInput"},
"output":{"shape":"ListConfiguredTablesOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists configured tables.</p>"
},
"ListMembers":{
"name":"ListMembers",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/members",
"responseCode":200
},
"input":{"shape":"ListMembersInput"},
"output":{"shape":"ListMembersOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists all members within a collaboration.</p>"
},
"ListMemberships":{
"name":"ListMemberships",
"http":{
"method":"GET",
"requestUri":"/memberships",
"responseCode":200
},
"input":{"shape":"ListMembershipsInput"},
"output":{"shape":"ListMembershipsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists all memberships resources within the caller's account.</p>"
},
"ListPrivacyBudgetTemplates":{
"name":"ListPrivacyBudgetTemplates",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates",
"responseCode":200
},
"input":{"shape":"ListPrivacyBudgetTemplatesInput"},
"output":{"shape":"ListPrivacyBudgetTemplatesOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Returns detailed information about the privacy budget templates in a specified membership.</p>"
},
"ListPrivacyBudgets":{
"name":"ListPrivacyBudgets",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/privacybudgets",
"responseCode":200
},
"input":{"shape":"ListPrivacyBudgetsInput"},
"output":{"shape":"ListPrivacyBudgetsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Returns detailed information about the privacy budgets in a specified membership.</p>"
},
"ListProtectedQueries":{
"name":"ListProtectedQueries",
"http":{
"method":"GET",
"requestUri":"/memberships/{membershipIdentifier}/protectedQueries",
"responseCode":200
},
"input":{"shape":"ListProtectedQueriesInput"},
"output":{"shape":"ListProtectedQueriesOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists protected queries, sorted by the most recent query.</p>"
},
"ListSchemas":{
"name":"ListSchemas",
"http":{
"method":"GET",
"requestUri":"/collaborations/{collaborationIdentifier}/schemas",
"responseCode":200
},
"input":{"shape":"ListSchemasInput"},
"output":{"shape":"ListSchemasOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists the schemas for relations within a collaboration.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags/{resourceArn}",
"responseCode":200
},
"input":{"shape":"ListTagsForResourceInput"},
"output":{"shape":"ListTagsForResourceOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Lists all of the tags that have been added to a resource.</p>"
},
"PreviewPrivacyImpact":{
"name":"PreviewPrivacyImpact",
"http":{
"method":"POST",
"requestUri":"/memberships/{membershipIdentifier}/previewprivacyimpact",
"responseCode":200
},
"input":{"shape":"PreviewPrivacyImpactInput"},
"output":{"shape":"PreviewPrivacyImpactOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.</p>"
},
"StartProtectedQuery":{
"name":"StartProtectedQuery",
"http":{
"method":"POST",
"requestUri":"/memberships/{membershipIdentifier}/protectedQueries",
"responseCode":200
},
"input":{"shape":"StartProtectedQueryInput"},
"output":{"shape":"StartProtectedQueryOutput"},
"errors":[
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a protected query that is started by Clean Rooms.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}",
"responseCode":200
},
"input":{"shape":"TagResourceInput"},
"output":{"shape":"TagResourceOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Tags a resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resourceArn}",
"responseCode":200
},
"input":{"shape":"UntagResourceInput"},
"output":{"shape":"UntagResourceOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Removes a tag or list of tags from a resource.</p>"
},
"UpdateAnalysisTemplate":{
"name":"UpdateAnalysisTemplate",
"http":{
"method":"PATCH",
"requestUri":"/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}",
"responseCode":200
},
"input":{"shape":"UpdateAnalysisTemplateInput"},
"output":{"shape":"UpdateAnalysisTemplateOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates the analysis template metadata.</p>"
},
"UpdateCollaboration":{
"name":"UpdateCollaboration",
"http":{
"method":"PATCH",
"requestUri":"/collaborations/{collaborationIdentifier}",
"responseCode":200
},
"input":{"shape":"UpdateCollaborationInput"},
"output":{"shape":"UpdateCollaborationOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates collaboration metadata and can only be called by the collaboration owner.</p>"
},
"UpdateConfiguredAudienceModelAssociation":{
"name":"UpdateConfiguredAudienceModelAssociation",
"http":{
"method":"PATCH",
"requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}",
"responseCode":200
},
"input":{"shape":"UpdateConfiguredAudienceModelAssociationInput"},
"output":{"shape":"UpdateConfiguredAudienceModelAssociationOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Provides the details necessary to update a configured audience model association.</p>"
},
"UpdateConfiguredTable":{
"name":"UpdateConfiguredTable",
"http":{
"method":"PATCH",
"requestUri":"/configuredTables/{configuredTableIdentifier}",
"responseCode":200
},
"input":{"shape":"UpdateConfiguredTableInput"},
"output":{"shape":"UpdateConfiguredTableOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates a configured table.</p>"
},
"UpdateConfiguredTableAnalysisRule":{
"name":"UpdateConfiguredTableAnalysisRule",
"http":{
"method":"PATCH",
"requestUri":"/configuredTables/{configuredTableIdentifier}/analysisRule/{analysisRuleType}",
"responseCode":200
},
"input":{"shape":"UpdateConfiguredTableAnalysisRuleInput"},
"output":{"shape":"UpdateConfiguredTableAnalysisRuleOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates a configured table analysis rule.</p>"
},
"UpdateConfiguredTableAssociation":{
"name":"UpdateConfiguredTableAssociation",
"http":{
"method":"PATCH",
"requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}",
"responseCode":200
},
"input":{"shape":"UpdateConfiguredTableAssociationInput"},
"output":{"shape":"UpdateConfiguredTableAssociationOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates a configured table association.</p>"
},
"UpdateMembership":{
"name":"UpdateMembership",
"http":{
"method":"PATCH",
"requestUri":"/memberships/{membershipIdentifier}",
"responseCode":200
},
"input":{"shape":"UpdateMembershipInput"},
"output":{"shape":"UpdateMembershipOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates a membership.</p>"
},
"UpdatePrivacyBudgetTemplate":{
"name":"UpdatePrivacyBudgetTemplate",
"http":{
"method":"PATCH",
"requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}",
"responseCode":200
},
"input":{"shape":"UpdatePrivacyBudgetTemplateInput"},
"output":{"shape":"UpdatePrivacyBudgetTemplateOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates the privacy budget template for the specified membership.</p>"
},
"UpdateProtectedQuery":{
"name":"UpdateProtectedQuery",
"http":{
"method":"PATCH",
"requestUri":"/memberships/{membershipIdentifier}/protectedQueries/{protectedQueryIdentifier}",
"responseCode":200
},
"input":{"shape":"UpdateProtectedQueryInput"},
"output":{"shape":"UpdateProtectedQueryOutput"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates the processing of a currently running query.</p>",
"idempotent":true
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"message":{"shape":"String"},
"reason":{
"shape":"AccessDeniedExceptionReason",
"documentation":"<p>A reason code for the exception.</p>"
}
},
"documentation":"<p>Caller does not have sufficient access to perform this action.</p>",
"error":{
"httpStatusCode":403,
"senderFault":true
},
"exception":true
},
"AccessDeniedExceptionReason":{
"type":"string",
"enum":["INSUFFICIENT_PERMISSIONS"]
},
"AccountId":{
"type":"string",
"max":12,
"min":12,
"pattern":"\\d+"
},
"AggregateColumn":{
"type":"structure",
"required":[
"columnNames",
"function"
],
"members":{
"columnNames":{
"shape":"AggregateColumnColumnNamesList",
"documentation":"<p>Column names in configured table of aggregate columns.</p>"
},
"function":{
"shape":"AggregateFunctionName",
"documentation":"<p>Aggregation function that can be applied to aggregate column in query.</p>"
}
},
"documentation":"<p>Column in configured table that can be used in aggregate function in query.</p>"
},
"AggregateColumnColumnNamesList":{
"type":"list",
"member":{"shape":"AnalysisRuleColumnName"},
"min":1
},
"AggregateFunctionName":{
"type":"string",
"enum":[
"SUM",
"SUM_DISTINCT",
"COUNT",
"COUNT_DISTINCT",
"AVG"
]
},
"AggregationConstraint":{
"type":"structure",
"required":[
"columnName",
"minimum",
"type"
],
"members":{
"columnName":{
"shape":"AnalysisRuleColumnName",
"documentation":"<p>Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.</p>"
},
"minimum":{
"shape":"AggregationConstraintMinimumInteger",
"documentation":"<p>The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.</p>"
},
"type":{
"shape":"AggregationType",
"documentation":"<p>The type of aggregation the constraint allows. The only valid value is currently `COUNT_DISTINCT`.</p>"
}
},
"documentation":"<p>Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.</p>"
},
"AggregationConstraintMinimumInteger":{
"type":"integer",
"box":true,
"max":100000,
"min":2
},
"AggregationConstraints":{
"type":"list",
"member":{"shape":"AggregationConstraint"},
"min":1
},
"AggregationType":{
"type":"string",
"enum":["COUNT_DISTINCT"]
},
"AllowedColumnList":{
"type":"list",
"member":{"shape":"ColumnName"},
"max":225,
"min":1
},
"AnalysisFormat":{
"type":"string",
"enum":["SQL"]
},
"AnalysisMethod":{
"type":"string",
"enum":["DIRECT_QUERY"]
},
"AnalysisParameter":{
"type":"structure",
"required":[
"name",
"type"
],
"members":{
"name":{
"shape":"ParameterName",
"documentation":"<p>The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.</p>"
},
"type":{
"shape":"ParameterType",
"documentation":"<p>The type of parameter.</p>"
},
"defaultValue":{
"shape":"ParameterValue",
"documentation":"<p>Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.</p>"
}
},
"documentation":"<p>Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.</p>",
"sensitive":true
},
"AnalysisParameterList":{
"type":"list",
"member":{"shape":"AnalysisParameter"},
"max":10,
"min":0
},
"AnalysisRule":{
"type":"structure",
"required":[
"collaborationId",
"type",
"name",
"createTime",
"updateTime",
"policy"
],
"members":{
"collaborationId":{
"shape":"CollaborationIdentifier",
"documentation":"<p>The unique ID for the associated collaboration.</p>"
},
"type":{
"shape":"AnalysisRuleType",
"documentation":"<p>The type of analysis rule.</p>"
},
"name":{
"shape":"TableAlias",
"documentation":"<p>The name for the analysis rule.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time the analysis rule was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the analysis rule was last updated.</p>"
},
"policy":{
"shape":"AnalysisRulePolicy",
"documentation":"<p>A policy that describes the associated data usage limitations.</p>"
}
},
"documentation":"<p>A specification about how data from the configured table can be used in a query.</p>"
},
"AnalysisRuleAggregation":{
"type":"structure",
"required":[
"aggregateColumns",
"joinColumns",
"dimensionColumns",
"scalarFunctions",
"outputConstraints"
],
"members":{
"aggregateColumns":{
"shape":"AnalysisRuleAggregationAggregateColumnsList",
"documentation":"<p>The columns that query runners are allowed to use in aggregation queries.</p>"
},
"joinColumns":{
"shape":"AnalysisRuleColumnList",
"documentation":"<p>Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.</p>"
},
"joinRequired":{
"shape":"JoinRequiredOption",
"documentation":"<p>Control that requires member who runs query to do a join with their configured table and/or other configured table in query.</p>"
},
"allowedJoinOperators":{
"shape":"JoinOperatorsList",
"documentation":"<p>Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is <code>AND</code>.</p>"
},
"dimensionColumns":{
"shape":"AnalysisRuleColumnList",
"documentation":"<p>The columns that query runners are allowed to select, group by, or filter by.</p>"
},
"scalarFunctions":{
"shape":"ScalarFunctionsList",
"documentation":"<p>Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.</p>"
},
"outputConstraints":{
"shape":"AggregationConstraints",
"documentation":"<p>Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.</p>"
}
},
"documentation":"<p>A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.</p>"
},
"AnalysisRuleAggregationAggregateColumnsList":{
"type":"list",
"member":{"shape":"AggregateColumn"},
"min":1
},
"AnalysisRuleColumnList":{
"type":"list",
"member":{"shape":"AnalysisRuleColumnName"}
},
"AnalysisRuleColumnName":{
"type":"string",
"max":127,
"min":1,
"pattern":"[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?"
},
"AnalysisRuleCustom":{
"type":"structure",
"required":["allowedAnalyses"],
"members":{
"allowedAnalyses":{
"shape":"AnalysisRuleCustomAllowedAnalysesList",
"documentation":"<p>The analysis templates that are allowed by the custom analysis rule.</p>"
},
"allowedAnalysisProviders":{
"shape":"AnalysisRuleCustomAllowedAnalysisProvidersList",
"documentation":"<p>The Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when <code>allowedAnalyses</code> is <code>ANY_QUERY</code>.</p>"
},
"differentialPrivacy":{
"shape":"DifferentialPrivacyConfiguration",
"documentation":"<p>The differential privacy configuration.</p>"
}
},
"documentation":"<p>A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.</p>"
},
"AnalysisRuleCustomAllowedAnalysesList":{
"type":"list",
"member":{"shape":"AnalysisTemplateArnOrQueryWildcard"},
"min":0
},
"AnalysisRuleCustomAllowedAnalysisProvidersList":{
"type":"list",
"member":{"shape":"AccountId"},
"min":0
},
"AnalysisRuleList":{
"type":"structure",
"required":[
"joinColumns",
"listColumns"
],
"members":{
"joinColumns":{
"shape":"AnalysisRuleListJoinColumnsList",
"documentation":"<p>Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.</p>"
},
"allowedJoinOperators":{
"shape":"JoinOperatorsList",
"documentation":"<p>The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is <code>AND</code>.</p>"
},
"listColumns":{
"shape":"AnalysisRuleColumnList",
"documentation":"<p>Columns that can be listed in the output.</p>"
}
},
"documentation":"<p>A type of analysis rule that enables row-level analysis.</p>"
},
"AnalysisRuleListJoinColumnsList":{
"type":"list",
"member":{"shape":"AnalysisRuleColumnName"},
"min":1
},
"AnalysisRulePolicy":{
"type":"structure",
"members":{
"v1":{
"shape":"AnalysisRulePolicyV1",
"documentation":"<p>Controls on the query specifications that can be run on configured table.</p>"
}
},
"documentation":"<p>Controls on the query specifications that can be run on configured table.</p>",
"union":true
},
"AnalysisRulePolicyV1":{
"type":"structure",
"members":{
"list":{
"shape":"AnalysisRuleList",
"documentation":"<p>Analysis rule type that enables only list queries on a configured table.</p>"
},
"aggregation":{
"shape":"AnalysisRuleAggregation",
"documentation":"<p>Analysis rule type that enables only aggregation queries on a configured table.</p>"
},
"custom":{
"shape":"AnalysisRuleCustom",
"documentation":"<p>Analysis rule type that enables custom SQL queries on a configured table.</p>"
}
},
"documentation":"<p>Controls on the query specifications that can be run on configured table.</p>",
"union":true
},
"AnalysisRuleType":{
"type":"string",
"enum":[
"AGGREGATION",
"LIST",
"CUSTOM"
]
},
"AnalysisRuleTypeList":{
"type":"list",
"member":{"shape":"AnalysisRuleType"}
},
"AnalysisSchema":{
"type":"structure",
"members":{
"referencedTables":{
"shape":"QueryTables",
"documentation":"<p>The tables referenced in the analysis schema.</p>"
}
},
"documentation":"<p>A relation within an analysis.</p>"
},
"AnalysisSource":{
"type":"structure",
"members":{
"text":{
"shape":"AnalysisTemplateText",
"documentation":"<p>The query text.</p>"
}
},
"documentation":"<p>The structure that defines the body of the analysis template.</p>",
"sensitive":true,
"union":true
},
"AnalysisTemplate":{
"type":"structure",
"required":[
"id",
"arn",
"collaborationId",
"collaborationArn",
"membershipId",
"membershipArn",
"name",
"createTime",
"updateTime",
"schema",
"format",
"source"
],
"members":{
"id":{
"shape":"AnalysisTemplateIdentifier",
"documentation":"<p>The identifier for the analysis template.</p>"
},
"arn":{
"shape":"AnalysisTemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis template.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique ID for the associated collaboration of the analysis template.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the analysis template’s associated collaboration.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The identifier of a member who created the analysis template.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the member who created the analysis template.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>The description of the analysis template.</p>"
},
"name":{
"shape":"ResourceAlias",
"documentation":"<p>The name of the analysis template.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis template was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis template was last updated.</p>"
},
"schema":{
"shape":"AnalysisSchema",
"documentation":"<p>The entire schema object.</p>"
},
"format":{
"shape":"AnalysisFormat",
"documentation":"<p>The format of the analysis template.</p>"
},
"source":{
"shape":"AnalysisSource",
"documentation":"<p>The source of the analysis template.</p>"
},
"analysisParameters":{
"shape":"AnalysisParameterList",
"documentation":"<p>The parameters of the analysis template.</p>"
}
},
"documentation":"<p>The analysis template.</p>"
},
"AnalysisTemplateArn":{
"type":"string",
"max":200,
"min":0,
"pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+"
},
"AnalysisTemplateArnList":{
"type":"list",
"member":{"shape":"AnalysisTemplateArn"},
"max":10,
"min":1
},
"AnalysisTemplateArnOrQueryWildcard":{
"type":"string",
"max":200,
"min":0,
"pattern":"(ANY_QUERY|arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+)"
},
"AnalysisTemplateIdentifier":{
"type":"string",
"max":36,
"min":36,
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"AnalysisTemplateSummary":{
"type":"structure",
"required":[
"arn",
"createTime",
"id",
"name",
"updateTime",
"membershipArn",
"membershipId",
"collaborationArn",
"collaborationId"
],
"members":{
"arn":{
"shape":"AnalysisTemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis template.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis template summary was created.</p>"
},
"id":{
"shape":"AnalysisTemplateIdentifier",
"documentation":"<p>The identifier of the analysis template.</p>"
},
"name":{
"shape":"ResourceAlias",
"documentation":"<p>The name of the analysis template. </p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis template summary was last updated.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the member who created the analysis template.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The identifier for a membership resource.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the analysis template summary’s associated collaboration.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>The description of the analysis template.</p>"
}
},
"documentation":"<p>The metadata of the analysis template.</p>"
},
"AnalysisTemplateSummaryList":{
"type":"list",
"member":{"shape":"AnalysisTemplateSummary"}
},
"AnalysisTemplateText":{
"type":"string",
"max":90000,
"min":0
},
"BatchGetCollaborationAnalysisTemplateError":{
"type":"structure",
"required":[
"arn",
"code",
"message"
],
"members":{
"arn":{
"shape":"AnalysisTemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis template.</p>"
},
"code":{
"shape":"String",
"documentation":"<p>An error code for the error.</p>"
},
"message":{
"shape":"String",
"documentation":"<p>A description of why the call failed.</p>"
}
},
"documentation":"<p>Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.</p>"
},
"BatchGetCollaborationAnalysisTemplateErrorList":{
"type":"list",
"member":{"shape":"BatchGetCollaborationAnalysisTemplateError"},
"max":10,
"min":0
},
"BatchGetCollaborationAnalysisTemplateInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"analysisTemplateArns"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"analysisTemplateArns":{
"shape":"AnalysisTemplateArnList",
"documentation":"<p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>"
}
}
},
"BatchGetCollaborationAnalysisTemplateOutput":{
"type":"structure",
"required":[
"collaborationAnalysisTemplates",
"errors"
],
"members":{
"collaborationAnalysisTemplates":{
"shape":"CollaborationAnalysisTemplateList",
"documentation":"<p>The retrieved list of analysis templates within a collaboration.</p>"
},
"errors":{
"shape":"BatchGetCollaborationAnalysisTemplateErrorList",
"documentation":"<p>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.</p>"
}
}
},
"BatchGetSchemaError":{
"type":"structure",
"required":[
"name",
"code",
"message"
],
"members":{
"name":{
"shape":"TableAlias",
"documentation":"<p>An error name for the error.</p>"
},
"code":{
"shape":"String",
"documentation":"<p>An error code for the error. </p>"
},
"message":{
"shape":"String",
"documentation":"<p>An error message for the error.</p>"
}
},
"documentation":"<p>An error describing why a schema could not be fetched.</p>"
},
"BatchGetSchemaErrorList":{
"type":"list",
"member":{"shape":"BatchGetSchemaError"},
"max":25,
"min":0
},
"BatchGetSchemaInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"names"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"names":{
"shape":"TableAliasList",
"documentation":"<p>The names for the schema objects to retrieve.></p>"
}
}
},
"BatchGetSchemaOutput":{
"type":"structure",
"required":[
"schemas",
"errors"
],
"members":{
"schemas":{
"shape":"SchemaList",
"documentation":"<p>The retrieved list of schemas.</p>"
},
"errors":{
"shape":"BatchGetSchemaErrorList",
"documentation":"<p>Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.</p>"
}
}
},
"Boolean":{
"type":"boolean",
"box":true
},
"CleanroomsArn":{
"type":"string",
"max":100,
"min":0,
"pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:[\\d\\w/-]+"
},
"Collaboration":{
"type":"structure",
"required":[
"id",
"arn",
"name",
"creatorAccountId",
"creatorDisplayName",
"createTime",
"updateTime",
"memberStatus",
"queryLogStatus"
],
"members":{
"id":{
"shape":"UUID",
"documentation":"<p>The unique ID for the collaboration.</p>"
},
"arn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the collaboration.</p>"
},
"name":{
"shape":"CollaborationName",
"documentation":"<p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>"
},
"description":{
"shape":"CollaborationDescription",
"documentation":"<p>A description of the collaboration provided by the collaboration owner.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>"
},
"creatorDisplayName":{
"shape":"DisplayName",
"documentation":"<p>A display name of the collaboration creator.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time when the collaboration was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the collaboration metadata was last updated.</p>"
},
"memberStatus":{
"shape":"MemberStatus",
"documentation":"<p>The status of a member in a collaboration.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The unique ID for your membership within the collaboration.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The unique ARN for your membership within the collaboration.</p>"
},
"dataEncryptionMetadata":{
"shape":"DataEncryptionMetadata",
"documentation":"<p>The settings for client-side encryption for cryptographic computing.</p>"
},
"queryLogStatus":{
"shape":"CollaborationQueryLogStatus",
"documentation":"<p>An indicator as to whether query logging has been enabled or disabled for the collaboration.</p>"
}
},
"documentation":"<p>The multi-party data share environment. The collaboration contains metadata about its purpose and participants.</p>"
},
"CollaborationAnalysisTemplate":{
"type":"structure",
"required":[
"id",
"arn",
"collaborationId",
"collaborationArn",
"creatorAccountId",
"name",
"createTime",
"updateTime",
"schema",
"format",
"source"
],
"members":{
"id":{
"shape":"AnalysisTemplateIdentifier",
"documentation":"<p>The identifier of the analysis template.</p>"
},
"arn":{
"shape":"AnalysisTemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis template.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the analysis template’s associated collaboration.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>The description of the analysis template.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>"
},
"name":{
"shape":"ResourceAlias",
"documentation":"<p>The name of the analysis template.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis template within a collaboration was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis template in the collaboration was last updated.</p>"
},
"schema":{
"shape":"AnalysisSchema",
"documentation":"<p>The entire schema object.</p>"
},
"format":{
"shape":"AnalysisFormat",
"documentation":"<p>The format of the analysis template in the collaboration.</p>"
},
"source":{
"shape":"AnalysisSource",
"documentation":"<p>The source of the analysis template within a collaboration.</p>"
},
"analysisParameters":{
"shape":"AnalysisParameterList",
"documentation":"<p>The analysis parameters that have been specified in the analysis template.</p>"
}
},
"documentation":"<p>The analysis template within a collaboration.</p>"
},
"CollaborationAnalysisTemplateList":{
"type":"list",
"member":{"shape":"CollaborationAnalysisTemplate"},
"max":10,
"min":0
},
"CollaborationAnalysisTemplateSummary":{
"type":"structure",
"required":[
"arn",
"createTime",
"id",
"name",
"updateTime",
"collaborationArn",
"collaborationId",
"creatorAccountId"
],
"members":{
"arn":{
"shape":"AnalysisTemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis template.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the summary of the analysis template in a collaboration was created.</p>"
},
"id":{
"shape":"AnalysisTemplateIdentifier",
"documentation":"<p>The identifier of the analysis template.</p>"
},
"name":{
"shape":"ResourceAlias",
"documentation":"<p>The name of the analysis template.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the summary of the analysis template in the collaboration was last updated.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the analysis template’s associated collaboration.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>The description of the analysis template.</p>"
}
},
"documentation":"<p>The metadata of the analysis template within a collaboration.</p>"
},
"CollaborationAnalysisTemplateSummaryList":{
"type":"list",
"member":{"shape":"CollaborationAnalysisTemplateSummary"}
},
"CollaborationArn":{
"type":"string",
"max":100,
"min":0,
"pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:collaboration/[\\d\\w-]+"
},
"CollaborationConfiguredAudienceModelAssociation":{
"type":"structure",
"required":[
"id",
"arn",
"collaborationId",
"collaborationArn",
"configuredAudienceModelArn",
"name",
"creatorAccountId",
"createTime",
"updateTime"
],
"members":{
"id":{
"shape":"ConfiguredAudienceModelAssociationIdentifier",
"documentation":"<p>The identifier of the configured audience model association.</p>"
},
"arn":{
"shape":"ConfiguredAudienceModelAssociationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the configured audience model association.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the configured audience model's associated collaboration.</p>"
},
"configuredAudienceModelArn":{
"shape":"ConfiguredAudienceModelArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the configure audience model.</p>"
},
"name":{
"shape":"ConfiguredAudienceModelAssociationName",
"documentation":"<p>The name of the configured audience model association.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>The description of the configured audience model association.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The identifier used to reference members of the collaboration. Only supports AWS account ID.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the configured audience model association was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the configured audience model association was updated.</p>"
}
},
"documentation":"<p>The configured audience model association within a collaboration.</p>"
},
"CollaborationConfiguredAudienceModelAssociationSummary":{
"type":"structure",
"required":[
"arn",
"createTime",
"id",
"name",
"updateTime",
"collaborationArn",
"collaborationId",
"creatorAccountId"
],
"members":{
"arn":{
"shape":"ConfiguredAudienceModelAssociationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the configured audience model association.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the configured audience model association was created.</p>"
},
"id":{
"shape":"ConfiguredAudienceModelAssociationIdentifier",
"documentation":"<p>The identifier of the configured audience model association.</p>"
},
"name":{
"shape":"ConfiguredAudienceModelAssociationName",
"documentation":"<p>The name of the configured audience model association.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the configured audience model association was updated.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the configured audience model's associated collaboration.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The identifier used to reference members of the collaboration. Only supports AWS account ID.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>The description of the configured audience model association.</p>"
}
},
"documentation":"<p>A summary of the configured audience model association in the collaboration.</p>"
},
"CollaborationConfiguredAudienceModelAssociationSummaryList":{
"type":"list",
"member":{"shape":"CollaborationConfiguredAudienceModelAssociationSummary"}
},
"CollaborationDescription":{
"type":"string",
"max":255,
"min":1,
"pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*"
},
"CollaborationIdentifier":{
"type":"string",
"max":36,
"min":36,
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"CollaborationName":{
"type":"string",
"max":100,
"min":1,
"pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*"
},
"CollaborationPrivacyBudgetSummary":{
"type":"structure",
"required":[
"id",
"privacyBudgetTemplateId",
"privacyBudgetTemplateArn",
"collaborationId",
"collaborationArn",
"creatorAccountId",
"type",
"createTime",
"updateTime",
"budget"
],
"members":{
"id":{
"shape":"UUID",
"documentation":"<p>The unique identifier of the collaboration privacy budget.</p>"
},
"privacyBudgetTemplateId":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>The unique identifier of the collaboration privacy budget template.</p>"
},
"privacyBudgetTemplateArn":{
"shape":"PrivacyBudgetTemplateArn",
"documentation":"<p>The ARN of the collaboration privacy budget template.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique identifier of the collaboration that includes this privacy budget.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The ARN of the collaboration that includes this privacy budget.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The unique identifier of the account that created this privacy budget.</p>"
},
"type":{
"shape":"PrivacyBudgetType",
"documentation":"<p>The type of privacy budget template.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the privacy budget was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the privacy budget was updated.</p>"
},
"budget":{
"shape":"PrivacyBudget",
"documentation":"<p>The includes epsilon provided and utility in terms of aggregations.</p>"
}
},
"documentation":"<p>A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.</p>"
},
"CollaborationPrivacyBudgetSummaryList":{
"type":"list",
"member":{"shape":"CollaborationPrivacyBudgetSummary"}
},
"CollaborationPrivacyBudgetTemplate":{
"type":"structure",
"required":[
"id",
"arn",
"collaborationId",
"collaborationArn",
"creatorAccountId",
"createTime",
"updateTime",
"privacyBudgetType",
"autoRefresh",
"parameters"
],
"members":{
"id":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>The unique identifier of the collaboration privacy budget template.</p>"
},
"arn":{
"shape":"PrivacyBudgetTemplateArn",
"documentation":"<p>The ARN of the collaboration privacy budget template.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique identifier of the collaboration that includes this collaboration privacy budget template.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The ARN of the collaboration that includes this collaboration privacy budget template.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The unique identifier of the account that created this collaboration privacy budget template.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the collaboration privacy budget template was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the collaboration privacy budget template was updated.</p>"
},
"privacyBudgetType":{
"shape":"PrivacyBudgetType",
"documentation":"<p>The type of privacy budget template.</p>"
},
"autoRefresh":{
"shape":"PrivacyBudgetTemplateAutoRefresh",
"documentation":"<p>How often the privacy budget refreshes.</p> <important> <p>If you plan to regularly bring new data into the collaboration, use <code>CALENDAR_MONTH</code> 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 queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.</p> </important>"
},
"parameters":{
"shape":"PrivacyBudgetTemplateParametersOutput",
"documentation":"<p>Specifies the epsilon and noise parameters for the privacy budget template.</p>"
}
},
"documentation":"<p>An array that specifies the information for a collaboration's privacy budget template.</p>"
},
"CollaborationPrivacyBudgetTemplateSummary":{
"type":"structure",
"required":[
"id",
"arn",
"collaborationId",
"collaborationArn",
"creatorAccountId",
"privacyBudgetType",
"createTime",
"updateTime"
],
"members":{
"id":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>The unique identifier of the collaboration privacy budget template.</p>"
},
"arn":{
"shape":"PrivacyBudgetTemplateArn",
"documentation":"<p>The ARN of the collaboration privacy budget template.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique identifier of the collaboration that contains this collaboration privacy budget template.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The ARN of the collaboration that contains this collaboration privacy budget template.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The unique identifier of the account that created this collaboration privacy budget template.</p>"
},
"privacyBudgetType":{
"shape":"PrivacyBudgetType",
"documentation":"<p>The type of the privacy budget template.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the collaboration privacy budget template was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the collaboration privacy budget template was updated.</p>"
}
},
"documentation":"<p>A summary of the collaboration's privacy budget template. This summary includes information about who created the privacy budget template and what collaborations it belongs to.</p>"
},
"CollaborationPrivacyBudgetTemplateSummaryList":{
"type":"list",
"member":{"shape":"CollaborationPrivacyBudgetTemplateSummary"}
},
"CollaborationQueryLogStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"CollaborationSummary":{
"type":"structure",
"required":[
"id",
"arn",
"name",
"creatorAccountId",
"creatorDisplayName",
"createTime",
"updateTime",
"memberStatus"
],
"members":{
"id":{
"shape":"UUID",
"documentation":"<p>The identifier for the collaboration.</p>"
},
"arn":{
"shape":"CollaborationArn",
"documentation":"<p>The ARN of the collaboration.</p>"
},
"name":{
"shape":"CollaborationName",
"documentation":"<p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>"
},
"creatorDisplayName":{
"shape":"DisplayName",
"documentation":"<p>The display name of the collaboration creator.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time when the collaboration was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the collaboration metadata was last updated.</p>"
},
"memberStatus":{
"shape":"MemberStatus",
"documentation":"<p>The status of a member in a collaboration.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The identifier of a member in a collaboration.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The ARN of a member in a collaboration.</p>"
}
},
"documentation":"<p>The metadata of the collaboration.</p>"
},
"CollaborationSummaryList":{
"type":"list",
"member":{"shape":"CollaborationSummary"}
},
"Column":{
"type":"structure",
"required":[
"name",
"type"
],
"members":{
"name":{
"shape":"ColumnName",
"documentation":"<p>The name of the column.</p>"
},
"type":{
"shape":"ColumnTypeString",
"documentation":"<p>The type of the column.</p>"
}
},
"documentation":"<p>A column within a schema relation, derived from the underlying Glue table.</p>"
},
"ColumnList":{
"type":"list",
"member":{"shape":"Column"}
},
"ColumnName":{
"type":"string",
"max":128,
"min":0,
"pattern":"[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?"
},
"ColumnTypeString":{
"type":"string",
"max":255,
"min":0,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*"
},
"ConfiguredAudienceModelArn":{
"type":"string",
"max":2048,
"min":20,
"pattern":"arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+"
},
"ConfiguredAudienceModelAssociation":{
"type":"structure",
"required":[
"id",
"arn",
"configuredAudienceModelArn",
"membershipId",
"membershipArn",
"collaborationId",
"collaborationArn",
"name",
"manageResourcePolicies",
"createTime",
"updateTime"
],
"members":{
"id":{
"shape":"ConfiguredAudienceModelAssociationIdentifier",
"documentation":"<p>A unique identifier of the configured audience model association.</p>"
},
"arn":{
"shape":"ConfiguredAudienceModelAssociationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the configured audience model association.</p>"
},
"configuredAudienceModelArn":{
"shape":"ConfiguredAudienceModelArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>A unique identifier for the membership that contains this configured audience model association.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the membership that contains this configured audience model association.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>A unique identifier of the collaboration that contains this configured audience model association.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association.</p>"
},
"name":{
"shape":"ConfiguredAudienceModelAssociationName",
"documentation":"<p>The name of the configured audience model association.</p>"
},
"manageResourcePolicies":{
"shape":"Boolean",
"documentation":"<p>When <code>TRUE</code>, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When <code>FALSE</code>, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>The description of the configured audience model association.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the configured audience model association was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the configured audience model association was updated.</p>"
}
},
"documentation":"<p>Details about the configured audience model association.</p>"
},
"ConfiguredAudienceModelAssociationArn":{
"type":"string",
"max":256,
"min":0,
"pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/configuredaudiencemodelassociation/[\\d\\w-]+"
},
"ConfiguredAudienceModelAssociationIdentifier":{
"type":"string",
"max":36,
"min":36,
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"ConfiguredAudienceModelAssociationName":{
"type":"string",
"max":100,
"min":1,
"pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*"
},
"ConfiguredAudienceModelAssociationSummary":{
"type":"structure",
"required":[
"membershipId",
"membershipArn",
"collaborationArn",
"collaborationId",
"createTime",
"updateTime",
"id",
"arn",
"name",
"configuredAudienceModelArn"
],
"members":{
"membershipId":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier of the membership that contains the configured audience model association.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the membership that contains the configured audience model association.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the collaboration that contains the configured audience model association.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>A unique identifier of the collaboration that configured audience model is associated with.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the configured audience model association was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the configured audience model association was updated.</p>"
},
"id":{
"shape":"UUID",
"documentation":"<p>A unique identifier of the configured audience model association.</p>"
},
"arn":{
"shape":"ConfiguredAudienceModelAssociationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the configured audience model association.</p>"
},
"name":{
"shape":"ConfiguredAudienceModelAssociationName",
"documentation":"<p>The name of the configured audience model association.</p>"
},
"configuredAudienceModelArn":{
"shape":"ConfiguredAudienceModelArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>The description of the configured audience model association.</p>"
}
},
"documentation":"<p>A summary of the configured audience model association.</p>"
},
"ConfiguredAudienceModelAssociationSummaryList":{
"type":"list",
"member":{"shape":"ConfiguredAudienceModelAssociationSummary"}
},
"ConfiguredTable":{
"type":"structure",
"required":[
"id",
"arn",
"name",
"tableReference",
"createTime",
"updateTime",
"analysisRuleTypes",
"analysisMethod",
"allowedColumns"
],
"members":{
"id":{
"shape":"UUID",
"documentation":"<p>The unique ID for the configured table.</p>"
},
"arn":{
"shape":"ConfiguredTableArn",
"documentation":"<p>The unique ARN for the configured table.</p>"
},
"name":{
"shape":"DisplayName",
"documentation":"<p>A name for the configured table.</p>"
},
"description":{
"shape":"TableDescription",
"documentation":"<p>A description for the configured table.</p>"
},
"tableReference":{
"shape":"TableReference",
"documentation":"<p>The Glue table that this configured table represents.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table was last updated</p>"
},
"analysisRuleTypes":{
"shape":"ConfiguredTableAnalysisRuleTypeList",
"documentation":"<p>The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.</p>"
},
"analysisMethod":{
"shape":"AnalysisMethod",
"documentation":"<p>The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.</p>"
},
"allowedColumns":{
"shape":"AllowedColumnList",
"documentation":"<p>The columns within the underlying Glue table that can be utilized within collaborations.</p>"
}
},
"documentation":"<p>A table that has been configured for use in a collaboration.</p>"
},
"ConfiguredTableAnalysisRule":{
"type":"structure",
"required":[
"configuredTableId",
"configuredTableArn",
"policy",
"type",
"createTime",
"updateTime"
],
"members":{
"configuredTableId":{
"shape":"UUID",
"documentation":"<p>The unique ID for the configured table.</p>"
},
"configuredTableArn":{
"shape":"ConfiguredTableArn",
"documentation":"<p>The unique ARN for the configured table.</p>"
},
"policy":{
"shape":"ConfiguredTableAnalysisRulePolicy",
"documentation":"<p>The policy that controls SQL query rules.</p>"
},
"type":{
"shape":"ConfiguredTableAnalysisRuleType",
"documentation":"<p>The type of configured table analysis rule.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table analysis rule was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table analysis rule was last updated.</p>"
}
},
"documentation":"<p>A configured table analysis rule, which limits how data for this table can be used.</p>"
},
"ConfiguredTableAnalysisRulePolicy":{
"type":"structure",
"members":{
"v1":{
"shape":"ConfiguredTableAnalysisRulePolicyV1",
"documentation":"<p>Controls on the query specifications that can be run on a configured table.</p>"
}
},
"documentation":"<p>Controls on the query specifications that can be run on a configured table.</p>",
"union":true
},
"ConfiguredTableAnalysisRulePolicyV1":{
"type":"structure",
"members":{
"list":{
"shape":"AnalysisRuleList",
"documentation":"<p>Analysis rule type that enables only list queries on a configured table.</p>"
},
"aggregation":{
"shape":"AnalysisRuleAggregation",
"documentation":"<p>Analysis rule type that enables only aggregation queries on a configured table.</p>"
},
"custom":{"shape":"AnalysisRuleCustom"}
},
"documentation":"<p>Controls on the query specifications that can be run on a configured table.</p>",
"union":true
},
"ConfiguredTableAnalysisRuleType":{
"type":"string",
"enum":[
"AGGREGATION",
"LIST",
"CUSTOM"
]
},
"ConfiguredTableAnalysisRuleTypeList":{
"type":"list",
"member":{"shape":"ConfiguredTableAnalysisRuleType"}
},
"ConfiguredTableArn":{
"type":"string",
"max":100,
"min":0,
"pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtable/[\\d\\w-]+"
},
"ConfiguredTableAssociation":{
"type":"structure",
"required":[
"arn",
"id",
"configuredTableId",
"configuredTableArn",
"membershipId",
"membershipArn",
"roleArn",
"name",
"createTime",
"updateTime"
],
"members":{
"arn":{
"shape":"ConfiguredTableAssociationArn",
"documentation":"<p>The unique ARN for the configured table association.</p>"
},
"id":{
"shape":"UUID",
"documentation":"<p>The unique ID for the configured table association.</p>"
},
"configuredTableId":{
"shape":"UUID",
"documentation":"<p>The unique ID for the configured table that the association refers to.</p>"
},
"configuredTableArn":{
"shape":"ConfiguredTableArn",
"documentation":"<p>The unique ARN for the configured table that the association refers to.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The unique ID for the membership this configured table association belongs to.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The unique ARN for the membership this configured table association belongs to.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The service will assume this role to access catalog metadata and query the table.</p>"
},
"name":{
"shape":"TableAlias",
"documentation":"<p>The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.</p>"
},
"description":{
"shape":"TableDescription",
"documentation":"<p>A description of the configured table association.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table association was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table association was last updated.</p>"
}
},
"documentation":"<p>A configured table association links a configured table to a collaboration.</p>"
},
"ConfiguredTableAssociationArn":{
"type":"string",
"max":100,
"min":0,
"pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtableassociation/[\\d\\w-]+/[\\d\\w-]+"
},
"ConfiguredTableAssociationIdentifier":{
"type":"string",
"max":36,
"min":36,
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"ConfiguredTableAssociationSummary":{
"type":"structure",
"required":[
"configuredTableId",
"membershipId",
"membershipArn",
"name",
"createTime",
"updateTime",
"id",
"arn"
],
"members":{
"configuredTableId":{
"shape":"UUID",
"documentation":"<p>The unique configured table ID that this configured table association refers to.</p>"
},
"membershipId":{
"shape":"MembershipIdentifier",
"documentation":"<p>The unique ID for the membership that the configured table association belongs to.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The unique ARN for the membership that the configured table association belongs to.</p>"
},
"name":{
"shape":"TableAlias",
"documentation":"<p>The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table association was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table association was last updated.</p>"
},
"id":{
"shape":"UUID",
"documentation":"<p>The unique ID for the configured table association.</p>"
},
"arn":{
"shape":"ConfiguredTableAssociationArn",
"documentation":"<p>The unique ARN for the configured table association.</p>"
}
},
"documentation":"<p>The configured table association summary for the objects listed by the request.</p>"
},
"ConfiguredTableAssociationSummaryList":{
"type":"list",
"member":{"shape":"ConfiguredTableAssociationSummary"}
},
"ConfiguredTableIdentifier":{
"type":"string",
"max":36,
"min":36,
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"ConfiguredTableSummary":{
"type":"structure",
"required":[
"id",
"arn",
"name",
"createTime",
"updateTime",
"analysisRuleTypes",
"analysisMethod"
],
"members":{
"id":{
"shape":"ConfiguredTableIdentifier",
"documentation":"<p>The unique ID of the configured table.</p>"
},
"arn":{
"shape":"ConfiguredTableArn",
"documentation":"<p>The unique ARN of the configured table.</p>"
},
"name":{
"shape":"DisplayName",
"documentation":"<p>The name of the configured table.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the configured table was last updated.</p>"
},
"analysisRuleTypes":{
"shape":"ConfiguredTableAnalysisRuleTypeList",
"documentation":"<p>The types of analysis rules associated with this configured table.</p>"
},
"analysisMethod":{
"shape":"AnalysisMethod",
"documentation":"<p>The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.</p>"
}
},
"documentation":"<p>The configured table summary for the objects listed by the request.</p>"
},
"ConfiguredTableSummaryList":{
"type":"list",
"member":{
"shape":"ConfiguredTableSummary",
"documentation":"<p>The member of the configured table summary list.</p>"
}
},
"ConflictException":{
"type":"structure",
"members":{
"message":{"shape":"String"},
"resourceId":{
"shape":"String",
"documentation":"<p>The ID of the conflicting resource.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of the conflicting resource.</p>"
},
"reason":{
"shape":"ConflictExceptionReason",
"documentation":"<p>A reason code for the exception.</p>"
}
},
"documentation":"<p>Updating or deleting a resource can cause an inconsistent state.</p>",
"error":{
"httpStatusCode":409,
"senderFault":true
},
"exception":true
},
"ConflictExceptionReason":{
"type":"string",
"enum":[
"ALREADY_EXISTS",
"SUBRESOURCES_EXIST",
"INVALID_STATE"
]
},
"CreateAnalysisTemplateInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"name",
"format",
"source"
],
"members":{
"description":{
"shape":"ResourceDescription",
"documentation":"<p>The description of the analysis template.</p>"
},
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a membership resource.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"name":{
"shape":"TableAlias",
"documentation":"<p>The name of the analysis template.</p>"
},
"format":{
"shape":"AnalysisFormat",
"documentation":"<p>The format of the analysis template.</p>"
},
"source":{
"shape":"AnalysisSource",
"documentation":"<p>The information in the analysis template. Currently supports <code>text</code>, the query text for the analysis template.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>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.</p>"
},
"analysisParameters":{
"shape":"AnalysisParameterList",
"documentation":"<p>The parameters of the analysis template.</p>"
}
}
},
"CreateAnalysisTemplateOutput":{
"type":"structure",
"required":["analysisTemplate"],
"members":{
"analysisTemplate":{
"shape":"AnalysisTemplate",
"documentation":"<p>The analysis template.</p>"
}
}
},
"CreateCollaborationInput":{
"type":"structure",
"required":[
"members",
"name",
"description",
"creatorMemberAbilities",
"creatorDisplayName",
"queryLogStatus"
],
"members":{
"members":{
"shape":"MemberList",
"documentation":"<p>A list of initial members, not including the creator. This list is immutable.</p>"
},
"name":{
"shape":"CollaborationName",
"documentation":"<p>The display name for a collaboration.</p>"
},
"description":{
"shape":"CollaborationDescription",
"documentation":"<p>A description of the collaboration provided by the collaboration owner.</p>"
},
"creatorMemberAbilities":{
"shape":"MemberAbilities",
"documentation":"<p>The abilities granted to the collaboration creator.</p>"
},
"creatorDisplayName":{
"shape":"DisplayName",
"documentation":"<p>The display name of the collaboration creator.</p>"
},
"dataEncryptionMetadata":{
"shape":"DataEncryptionMetadata",
"documentation":"<p>The settings for client-side encryption with Cryptographic Computing for Clean Rooms.</p>"
},
"queryLogStatus":{
"shape":"CollaborationQueryLogStatus",
"documentation":"<p>An indicator as to whether query logging has been enabled or disabled for the collaboration.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>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.</p>"
},
"creatorPaymentConfiguration":{
"shape":"PaymentConfiguration",
"documentation":"<p>The collaboration creator's payment responsibilities set by the collaboration creator. </p> <p>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.</p>"
}
}
},
"CreateCollaborationOutput":{
"type":"structure",
"required":["collaboration"],
"members":{
"collaboration":{
"shape":"Collaboration",
"documentation":"<p>The entire created collaboration object.</p>"
}
}
},
"CreateConfiguredAudienceModelAssociationInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"configuredAudienceModelArn",
"configuredAudienceModelAssociationName",
"manageResourcePolicies"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"configuredAudienceModelArn":{
"shape":"ConfiguredAudienceModelArn",
"documentation":"<p>A unique identifier for the configured audience model that you want to associate.</p>"
},
"configuredAudienceModelAssociationName":{
"shape":"ConfiguredAudienceModelAssociationName",
"documentation":"<p>The name of the configured audience model association.</p>"
},
"manageResourcePolicies":{
"shape":"Boolean",
"documentation":"<p>When <code>TRUE</code>, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When <code>FALSE</code>, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.</p> <p>Setting this to <code>TRUE</code> requires you to have permissions to create, update, and delete the resource policy for the <code>cleanrooms-ml</code> resource when you call the <a>DeleteConfiguredAudienceModelAssociation</a> resource. In addition, if you are the collaboration creator and specify <code>TRUE</code>, you must have the same permissions when you call the <a>DeleteMember</a> and <a>DeleteCollaboration</a> APIs.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>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.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>A description of the configured audience model association.</p>"
}
}
},
"CreateConfiguredAudienceModelAssociationOutput":{
"type":"structure",
"required":["configuredAudienceModelAssociation"],
"members":{
"configuredAudienceModelAssociation":{
"shape":"ConfiguredAudienceModelAssociation",
"documentation":"<p>Information about the configured audience model association.</p>"
}
}
},
"CreateConfiguredTableAnalysisRuleInput":{
"type":"structure",
"required":[
"configuredTableIdentifier",
"analysisRuleType",
"analysisRulePolicy"
],
"members":{
"configuredTableIdentifier":{
"shape":"ConfiguredTableIdentifier",
"documentation":"<p>The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID. </p>",
"location":"uri",
"locationName":"configuredTableIdentifier"
},
"analysisRuleType":{
"shape":"ConfiguredTableAnalysisRuleType",
"documentation":"<p>The type of analysis rule.</p>"
},
"analysisRulePolicy":{
"shape":"ConfiguredTableAnalysisRulePolicy",
"documentation":"<p>The entire created configured table analysis rule object.</p>"
}
}
},
"CreateConfiguredTableAnalysisRuleOutput":{
"type":"structure",
"required":["analysisRule"],
"members":{
"analysisRule":{
"shape":"ConfiguredTableAnalysisRule",
"documentation":"<p>The entire created analysis rule.</p>"
}
}
},
"CreateConfiguredTableAssociationInput":{
"type":"structure",
"required":[
"name",
"membershipIdentifier",
"configuredTableIdentifier",
"roleArn"
],
"members":{
"name":{
"shape":"TableAlias",
"documentation":"<p>The name of the configured table association. This name is used to query the underlying configured table.</p>"
},
"description":{
"shape":"TableDescription",
"documentation":"<p>A description for the configured table association.</p>"
},
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"configuredTableIdentifier":{
"shape":"ConfiguredTableIdentifier",
"documentation":"<p>A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The service will assume this role to access catalog metadata and query the table.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>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.</p>"
}
}
},
"CreateConfiguredTableAssociationOutput":{
"type":"structure",
"required":["configuredTableAssociation"],
"members":{
"configuredTableAssociation":{
"shape":"ConfiguredTableAssociation",
"documentation":"<p>The entire configured table association object.</p>"
}
}
},
"CreateConfiguredTableInput":{
"type":"structure",
"required":[
"name",
"tableReference",
"allowedColumns",
"analysisMethod"
],
"members":{
"name":{
"shape":"DisplayName",
"documentation":"<p>The name of the configured table.</p>"
},
"description":{
"shape":"TableDescription",
"documentation":"<p>A description for the configured table.</p>"
},
"tableReference":{
"shape":"TableReference",
"documentation":"<p>A reference to the Glue table being configured.</p>"
},
"allowedColumns":{
"shape":"AllowedColumnList",
"documentation":"<p>The columns of the underlying table that can be used by collaborations or analysis rules.</p>"
},
"analysisMethod":{
"shape":"AnalysisMethod",
"documentation":"<p>The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>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.</p>"
}
}
},
"CreateConfiguredTableOutput":{
"type":"structure",
"required":["configuredTable"],
"members":{
"configuredTable":{
"shape":"ConfiguredTable",
"documentation":"<p>The created configured table.</p>"
}
}
},
"CreateMembershipInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"queryLogStatus"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>The unique ID for the associated collaboration.</p>"
},
"queryLogStatus":{
"shape":"MembershipQueryLogStatus",
"documentation":"<p>An indicator as to whether query logging has been enabled or disabled for the membership.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>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.</p>"
},
"defaultResultConfiguration":{
"shape":"MembershipProtectedQueryResultConfiguration",
"documentation":"<p>The default protected query result configuration as specified by the member who can receive results.</p>"
},
"paymentConfiguration":{
"shape":"MembershipPaymentConfiguration",
"documentation":"<p>The payment responsibilities accepted by the collaboration member.</p> <p>Not required if the collaboration member has the member ability to run queries. </p> <p>Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator. </p>"
}
}
},
"CreateMembershipOutput":{
"type":"structure",
"required":["membership"],
"members":{
"membership":{
"shape":"Membership",
"documentation":"<p>The membership that was created.</p>"
}
}
},
"CreatePrivacyBudgetTemplateInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"autoRefresh",
"privacyBudgetType",
"parameters"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"autoRefresh":{
"shape":"PrivacyBudgetTemplateAutoRefresh",
"documentation":"<p>How often the privacy budget refreshes.</p> <important> <p>If you plan to regularly bring new data into the collaboration, you can use <code>CALENDAR_MONTH</code> 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.</p> </important>"
},
"privacyBudgetType":{
"shape":"PrivacyBudgetType",
"documentation":"<p>Specifies the type of the privacy budget template.</p>"
},
"parameters":{
"shape":"PrivacyBudgetTemplateParametersInput",
"documentation":"<p>Specifies your parameters for the privacy budget template.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>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.</p>"
}
}
},
"CreatePrivacyBudgetTemplateOutput":{
"type":"structure",
"required":["privacyBudgetTemplate"],
"members":{
"privacyBudgetTemplate":{
"shape":"PrivacyBudgetTemplate",
"documentation":"<p>A summary of the elements in the privacy budget template.</p>"
}
}
},
"DataEncryptionMetadata":{
"type":"structure",
"required":[
"allowCleartext",
"allowDuplicates",
"allowJoinsOnColumnsWithDifferentNames",
"preserveNulls"
],
"members":{
"allowCleartext":{
"shape":"Boolean",
"documentation":"<p>Indicates whether encrypted tables can contain cleartext data (<code>TRUE</code>) or are to cryptographically process every column (<code>FALSE</code>).</p>"
},
"allowDuplicates":{
"shape":"Boolean",
"documentation":"<p>Indicates whether Fingerprint columns can contain duplicate entries (<code>TRUE</code>) or are to contain only non-repeated values (<code>FALSE</code>).</p>"
},
"allowJoinsOnColumnsWithDifferentNames":{
"shape":"Boolean",
"documentation":"<p>Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (<code>TRUE</code>) or can only be joined on Fingerprint columns of the same name (<code>FALSE</code>).</p>"
},
"preserveNulls":{
"shape":"Boolean",
"documentation":"<p>Indicates whether NULL values are to be copied as NULL to encrypted tables (<code>TRUE</code>) or cryptographically processed (<code>FALSE</code>).</p>"
}
},
"documentation":"<p>The settings for client-side encryption for cryptographic computing.</p>"
},
"DeleteAnalysisTemplateInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"analysisTemplateIdentifier"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a membership resource.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"analysisTemplateIdentifier":{
"shape":"AnalysisTemplateIdentifier",
"documentation":"<p>The identifier for the analysis template resource.</p>",
"location":"uri",
"locationName":"analysisTemplateIdentifier"
}
}
},
"DeleteAnalysisTemplateOutput":{
"type":"structure",
"members":{
}
},
"DeleteCollaborationInput":{
"type":"structure",
"required":["collaborationIdentifier"],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>The identifier for the collaboration.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
}
}
},
"DeleteCollaborationOutput":{
"type":"structure",
"members":{
}
},
"DeleteConfiguredAudienceModelAssociationInput":{
"type":"structure",
"required":[
"configuredAudienceModelAssociationIdentifier",
"membershipIdentifier"
],
"members":{
"configuredAudienceModelAssociationIdentifier":{
"shape":"ConfiguredAudienceModelAssociationIdentifier",
"documentation":"<p>A unique identifier of the configured audience model association that you want to delete.</p>",
"location":"uri",
"locationName":"configuredAudienceModelAssociationIdentifier"
},
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier of the membership that contains the audience model association that you want to delete.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
}
}
},
"DeleteConfiguredAudienceModelAssociationOutput":{
"type":"structure",
"members":{
}
},
"DeleteConfiguredTableAnalysisRuleInput":{
"type":"structure",
"required":[
"configuredTableIdentifier",
"analysisRuleType"
],
"members":{
"configuredTableIdentifier":{
"shape":"ConfiguredTableIdentifier",
"documentation":"<p>The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.</p>",
"location":"uri",
"locationName":"configuredTableIdentifier"
},
"analysisRuleType":{
"shape":"ConfiguredTableAnalysisRuleType",
"documentation":"<p>The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.</p>",
"location":"uri",
"locationName":"analysisRuleType"
}
}
},
"DeleteConfiguredTableAnalysisRuleOutput":{
"type":"structure",
"members":{
},
"documentation":"<p>An empty response that indicates a successful delete.</p>"
},
"DeleteConfiguredTableAssociationInput":{
"type":"structure",
"required":[
"configuredTableAssociationIdentifier",
"membershipIdentifier"
],
"members":{
"configuredTableAssociationIdentifier":{
"shape":"ConfiguredTableAssociationIdentifier",
"documentation":"<p>The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.</p>",
"location":"uri",
"locationName":"configuredTableAssociationIdentifier"
},
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
}
}
},
"DeleteConfiguredTableAssociationOutput":{
"type":"structure",
"members":{
}
},
"DeleteConfiguredTableInput":{
"type":"structure",
"required":["configuredTableIdentifier"],
"members":{
"configuredTableIdentifier":{
"shape":"ConfiguredTableIdentifier",
"documentation":"<p>The unique ID for the configured table to delete.</p>",
"location":"uri",
"locationName":"configuredTableIdentifier"
}
}
},
"DeleteConfiguredTableOutput":{
"type":"structure",
"members":{
},
"documentation":"<p>The empty output for a successful deletion.</p>"
},
"DeleteMemberInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"accountId"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>The unique identifier for the associated collaboration.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"accountId":{
"shape":"AccountId",
"documentation":"<p>The account ID of the member to remove.</p>",
"location":"uri",
"locationName":"accountId"
}
}
},
"DeleteMemberOutput":{
"type":"structure",
"members":{
}
},
"DeleteMembershipInput":{
"type":"structure",
"required":["membershipIdentifier"],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a membership resource.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
}
}
},
"DeleteMembershipOutput":{
"type":"structure",
"members":{
}
},
"DeletePrivacyBudgetTemplateInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"privacyBudgetTemplateIdentifier"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"privacyBudgetTemplateIdentifier":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>A unique identifier for your privacy budget template. </p>",
"location":"uri",
"locationName":"privacyBudgetTemplateIdentifier"
}
}
},
"DeletePrivacyBudgetTemplateOutput":{
"type":"structure",
"members":{
}
},
"DifferentialPrivacyAggregationExpression":{
"type":"string",
"min":1
},
"DifferentialPrivacyAggregationType":{
"type":"string",
"enum":[
"AVG",
"COUNT",
"COUNT_DISTINCT",
"SUM",
"STDDEV"
]
},
"DifferentialPrivacyColumn":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.</p>"
}
},
"documentation":"<p>Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.</p>"
},
"DifferentialPrivacyColumnList":{
"type":"list",
"member":{"shape":"DifferentialPrivacyColumn"},
"max":1,
"min":1
},
"DifferentialPrivacyConfiguration":{
"type":"structure",
"required":["columns"],
"members":{
"columns":{
"shape":"DifferentialPrivacyColumnList",
"documentation":"<p>The name of the column (such as user_id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.</p>"
}
},
"documentation":"<p>Specifies the unique identifier for your users.</p>"
},
"DifferentialPrivacyParameters":{
"type":"structure",
"required":["sensitivityParameters"],
"members":{
"sensitivityParameters":{
"shape":"DifferentialPrivacySensitivityParametersList",
"documentation":"<p>Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.</p>"
}
},
"documentation":"<p>An array that contains the sensitivity parameters.</p>"
},
"DifferentialPrivacyPreviewAggregation":{
"type":"structure",
"required":[
"type",
"maxCount"
],
"members":{
"type":{
"shape":"DifferentialPrivacyAggregationType",
"documentation":"<p>The type of aggregation function.</p>"
},
"maxCount":{
"shape":"DifferentialPrivacyPreviewAggregationMaxCountInteger",
"documentation":"<p>The maximum number of aggregations that the member who can query can run given the epsilon and noise parameters.</p>"
}
},
"documentation":"<p>Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.</p>"
},
"DifferentialPrivacyPreviewAggregationList":{
"type":"list",
"member":{"shape":"DifferentialPrivacyPreviewAggregation"}
},
"DifferentialPrivacyPreviewAggregationMaxCountInteger":{
"type":"integer",
"box":true,
"min":0
},
"DifferentialPrivacyPreviewParametersInput":{
"type":"structure",
"required":[
"epsilon",
"usersNoisePerQuery"
],
"members":{
"epsilon":{
"shape":"Epsilon",
"documentation":"<p>The epsilon value that you want to preview.</p>"
},
"usersNoisePerQuery":{
"shape":"UsersNoisePerQuery",
"documentation":"<p>Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.</p>"
}
},
"documentation":"<p>The epsilon and noise parameters that you want to preview.</p>"
},
"DifferentialPrivacyPrivacyBudget":{
"type":"structure",
"required":[
"aggregations",
"epsilon"
],
"members":{
"aggregations":{
"shape":"DifferentialPrivacyPrivacyBudgetAggregationList",
"documentation":"<p>This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.</p>"
},
"epsilon":{
"shape":"Epsilon",
"documentation":"<p>The epsilon value that you configured.</p>"
}
},
"documentation":"<p>Specifies the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations available.</p>"
},
"DifferentialPrivacyPrivacyBudgetAggregation":{
"type":"structure",
"required":[
"type",
"maxCount",
"remainingCount"
],
"members":{
"type":{
"shape":"DifferentialPrivacyAggregationType",
"documentation":"<p>The different types of aggregation functions that you can perform.</p>"
},
"maxCount":{
"shape":"DifferentialPrivacyPrivacyBudgetAggregationMaxCountInteger",
"documentation":"<p>The maximum number of aggregation functions that you can perform with the given privacy budget.</p>"
},
"remainingCount":{
"shape":"DifferentialPrivacyPrivacyBudgetAggregationRemainingCountInteger",
"documentation":"<p>The remaining number of aggregation functions that can be run with the available privacy budget.</p>"
}
},
"documentation":"<p>Information about the total number of aggregations, as well as the remaining aggregations.</p>"
},
"DifferentialPrivacyPrivacyBudgetAggregationList":{
"type":"list",
"member":{"shape":"DifferentialPrivacyPrivacyBudgetAggregation"}
},
"DifferentialPrivacyPrivacyBudgetAggregationMaxCountInteger":{
"type":"integer",
"box":true,
"min":0
},
"DifferentialPrivacyPrivacyBudgetAggregationRemainingCountInteger":{
"type":"integer",
"box":true,
"min":0
},
"DifferentialPrivacyPrivacyImpact":{
"type":"structure",
"required":["aggregations"],
"members":{
"aggregations":{
"shape":"DifferentialPrivacyPreviewAggregationList",
"documentation":"<p>The number of aggregation functions that you can perform.</p>"
}
},
"documentation":"<p>Information about the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.</p>"
},
"DifferentialPrivacySensitivityParameters":{
"type":"structure",
"required":[
"aggregationType",
"aggregationExpression",
"userContributionLimit"
],
"members":{
"aggregationType":{
"shape":"DifferentialPrivacyAggregationType",
"documentation":"<p>The type of aggregation function that was run.</p>"
},
"aggregationExpression":{
"shape":"DifferentialPrivacyAggregationExpression",
"documentation":"<p>The aggregation expression that was run.</p>"
},
"userContributionLimit":{
"shape":"DifferentialPrivacySensitivityParametersUserContributionLimitInteger",
"documentation":"<p>The maximum number of rows contributed by a user in a SQL query.</p>"
},
"minColumnValue":{
"shape":"Float",
"documentation":"<p>The lower bound of the aggregation expression.</p>"
},
"maxColumnValue":{
"shape":"Float",
"documentation":"<p>The upper bound of the aggregation expression.</p>"
}
},
"documentation":"<p>Provides the sensitivity parameters.</p>"
},
"DifferentialPrivacySensitivityParametersList":{
"type":"list",
"member":{"shape":"DifferentialPrivacySensitivityParameters"}
},
"DifferentialPrivacySensitivityParametersUserContributionLimitInteger":{
"type":"integer",
"box":true,
"min":0
},
"DifferentialPrivacyTemplateParametersInput":{
"type":"structure",
"required":[
"epsilon",
"usersNoisePerQuery"
],
"members":{
"epsilon":{
"shape":"Epsilon",
"documentation":"<p>The epsilon value that you want to use.</p>"
},
"usersNoisePerQuery":{
"shape":"UsersNoisePerQuery",
"documentation":"<p>Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.</p>"
}
},
"documentation":"<p>The epsilon and noise parameter values that you want to use for the differential privacy template.</p>"
},
"DifferentialPrivacyTemplateParametersOutput":{
"type":"structure",
"required":[
"epsilon",
"usersNoisePerQuery"
],
"members":{
"epsilon":{
"shape":"Epsilon",
"documentation":"<p>The epsilon value that you specified.</p>"
},
"usersNoisePerQuery":{
"shape":"UsersNoisePerQuery",
"documentation":"<p>Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.</p>"
}
},
"documentation":"<p>The epsilon and noise parameter values that were used for the differential privacy template.</p>"
},
"DifferentialPrivacyTemplateUpdateParameters":{
"type":"structure",
"members":{
"epsilon":{
"shape":"Epsilon",
"documentation":"<p>The updated epsilon value that you want to use.</p>"
},
"usersNoisePerQuery":{
"shape":"UsersNoisePerQuery",
"documentation":"<p>The updated value of noise added per query. It is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.</p>"
}
},
"documentation":"<p>The epsilon and noise parameter values that you want to update in the differential privacy template.</p>"
},
"DisplayName":{
"type":"string",
"max":100,
"min":1,
"pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*"
},
"Double":{
"type":"double",
"box":true
},
"Epsilon":{
"type":"integer",
"box":true,
"max":20,
"min":1
},
"FilterableMemberStatus":{
"type":"string",
"enum":[
"INVITED",
"ACTIVE"
]
},
"Float":{
"type":"float",
"box":true
},
"GetAnalysisTemplateInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"analysisTemplateIdentifier"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a membership resource.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"analysisTemplateIdentifier":{
"shape":"AnalysisTemplateIdentifier",
"documentation":"<p>The identifier for the analysis template resource.</p>",
"location":"uri",
"locationName":"analysisTemplateIdentifier"
}
}
},
"GetAnalysisTemplateOutput":{
"type":"structure",
"required":["analysisTemplate"],
"members":{
"analysisTemplate":{
"shape":"AnalysisTemplate",
"documentation":"<p>The analysis template.</p>"
}
}
},
"GetCollaborationAnalysisTemplateInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"analysisTemplateArn"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"analysisTemplateArn":{
"shape":"AnalysisTemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>",
"location":"uri",
"locationName":"analysisTemplateArn"
}
}
},
"GetCollaborationAnalysisTemplateOutput":{
"type":"structure",
"required":["collaborationAnalysisTemplate"],
"members":{
"collaborationAnalysisTemplate":{
"shape":"CollaborationAnalysisTemplate",
"documentation":"<p>The analysis template within a collaboration.</p>"
}
}
},
"GetCollaborationConfiguredAudienceModelAssociationInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"configuredAudienceModelAssociationIdentifier"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"configuredAudienceModelAssociationIdentifier":{
"shape":"ConfiguredAudienceModelAssociationIdentifier",
"documentation":"<p>A unique identifier for the configured audience model association that you want to retrieve.</p>",
"location":"uri",
"locationName":"configuredAudienceModelAssociationIdentifier"
}
}
},
"GetCollaborationConfiguredAudienceModelAssociationOutput":{
"type":"structure",
"required":["collaborationConfiguredAudienceModelAssociation"],
"members":{
"collaborationConfiguredAudienceModelAssociation":{
"shape":"CollaborationConfiguredAudienceModelAssociation",
"documentation":"<p>The metadata of the configured audience model association.</p>"
}
}
},
"GetCollaborationInput":{
"type":"structure",
"required":["collaborationIdentifier"],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>The identifier for the collaboration.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
}
}
},
"GetCollaborationOutput":{
"type":"structure",
"required":["collaboration"],
"members":{
"collaboration":{
"shape":"Collaboration",
"documentation":"<p>The entire collaboration for this identifier.</p>"
}
}
},
"GetCollaborationPrivacyBudgetTemplateInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"privacyBudgetTemplateIdentifier"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for one of your collaborations.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"privacyBudgetTemplateIdentifier":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>A unique identifier for one of your privacy budget templates.</p>",
"location":"uri",
"locationName":"privacyBudgetTemplateIdentifier"
}
}
},
"GetCollaborationPrivacyBudgetTemplateOutput":{
"type":"structure",
"required":["collaborationPrivacyBudgetTemplate"],
"members":{
"collaborationPrivacyBudgetTemplate":{
"shape":"CollaborationPrivacyBudgetTemplate",
"documentation":"<p>Returns the details of the privacy budget template that you requested.</p>"
}
}
},
"GetConfiguredAudienceModelAssociationInput":{
"type":"structure",
"required":[
"configuredAudienceModelAssociationIdentifier",
"membershipIdentifier"
],
"members":{
"configuredAudienceModelAssociationIdentifier":{
"shape":"ConfiguredAudienceModelAssociationIdentifier",
"documentation":"<p>A unique identifier for the configured audience model association that you want to retrieve.</p>",
"location":"uri",
"locationName":"configuredAudienceModelAssociationIdentifier"
},
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier for the membership that contains the configured audience model association that you want to retrieve.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
}
}
},
"GetConfiguredAudienceModelAssociationOutput":{
"type":"structure",
"required":["configuredAudienceModelAssociation"],
"members":{
"configuredAudienceModelAssociation":{
"shape":"ConfiguredAudienceModelAssociation",
"documentation":"<p>Information about the configured audience model association that you requested.</p>"
}
}
},
"GetConfiguredTableAnalysisRuleInput":{
"type":"structure",
"required":[
"configuredTableIdentifier",
"analysisRuleType"
],
"members":{
"configuredTableIdentifier":{
"shape":"ConfiguredTableIdentifier",
"documentation":"<p>The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.</p>",
"location":"uri",
"locationName":"configuredTableIdentifier"
},
"analysisRuleType":{
"shape":"ConfiguredTableAnalysisRuleType",
"documentation":"<p>The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.</p>",
"location":"uri",
"locationName":"analysisRuleType"
}
}
},
"GetConfiguredTableAnalysisRuleOutput":{
"type":"structure",
"required":["analysisRule"],
"members":{
"analysisRule":{
"shape":"ConfiguredTableAnalysisRule",
"documentation":"<p>The entire analysis rule output.</p>"
}
}
},
"GetConfiguredTableAssociationInput":{
"type":"structure",
"required":[
"configuredTableAssociationIdentifier",
"membershipIdentifier"
],
"members":{
"configuredTableAssociationIdentifier":{
"shape":"ConfiguredTableAssociationIdentifier",
"documentation":"<p>The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.</p>",
"location":"uri",
"locationName":"configuredTableAssociationIdentifier"
},
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
}
}
},
"GetConfiguredTableAssociationOutput":{
"type":"structure",
"required":["configuredTableAssociation"],
"members":{
"configuredTableAssociation":{
"shape":"ConfiguredTableAssociation",
"documentation":"<p>The entire configured table association object.</p>"
}
}
},
"GetConfiguredTableInput":{
"type":"structure",
"required":["configuredTableIdentifier"],
"members":{
"configuredTableIdentifier":{
"shape":"ConfiguredTableIdentifier",
"documentation":"<p>The unique ID for the configured table to retrieve.</p>",
"location":"uri",
"locationName":"configuredTableIdentifier"
}
}
},
"GetConfiguredTableOutput":{
"type":"structure",
"required":["configuredTable"],
"members":{
"configuredTable":{
"shape":"ConfiguredTable",
"documentation":"<p>The retrieved configured table.</p>"
}
}
},
"GetMembershipInput":{
"type":"structure",
"required":["membershipIdentifier"],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a membership resource.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
}
}
},
"GetMembershipOutput":{
"type":"structure",
"required":["membership"],
"members":{
"membership":{
"shape":"Membership",
"documentation":"<p>The membership retrieved for the provided identifier.</p>"
}
}
},
"GetPrivacyBudgetTemplateInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"privacyBudgetTemplateIdentifier"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"privacyBudgetTemplateIdentifier":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>A unique identifier for your privacy budget template.</p>",
"location":"uri",
"locationName":"privacyBudgetTemplateIdentifier"
}
}
},
"GetPrivacyBudgetTemplateOutput":{
"type":"structure",
"required":["privacyBudgetTemplate"],
"members":{
"privacyBudgetTemplate":{
"shape":"PrivacyBudgetTemplate",
"documentation":"<p>Returns the details of the privacy budget template that you requested.</p>"
}
}
},
"GetProtectedQueryInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"protectedQueryIdentifier"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a membership in a protected query instance.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"protectedQueryIdentifier":{
"shape":"ProtectedQueryIdentifier",
"documentation":"<p>The identifier for a protected query instance.</p>",
"location":"uri",
"locationName":"protectedQueryIdentifier"
}
}
},
"GetProtectedQueryOutput":{
"type":"structure",
"required":["protectedQuery"],
"members":{
"protectedQuery":{
"shape":"ProtectedQuery",
"documentation":"<p>The query processing metadata.</p>"
}
}
},
"GetSchemaAnalysisRuleInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"name",
"type"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"name":{
"shape":"TableAlias",
"documentation":"<p>The name of the schema to retrieve the analysis rule for.</p>",
"location":"uri",
"locationName":"name"
},
"type":{
"shape":"AnalysisRuleType",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"type"
}
}
},
"GetSchemaAnalysisRuleOutput":{
"type":"structure",
"required":["analysisRule"],
"members":{
"analysisRule":{
"shape":"AnalysisRule",
"documentation":"<p>A specification about how data from the configured table can be used.</p>"
}
}
},
"GetSchemaInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"name"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"name":{
"shape":"TableAlias",
"documentation":"<p>The name of the relation to retrieve the schema for.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"GetSchemaOutput":{
"type":"structure",
"required":["schema"],
"members":{
"schema":{
"shape":"Schema",
"documentation":"<p>The entire schema object.</p>"
}
}
},
"GlueDatabaseName":{
"type":"string",
"max":128,
"min":0,
"pattern":"[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?"
},
"GlueTableName":{
"type":"string",
"max":128,
"min":0,
"pattern":"[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?"
},
"GlueTableReference":{
"type":"structure",
"required":[
"tableName",
"databaseName"
],
"members":{
"tableName":{
"shape":"GlueTableName",
"documentation":"<p>The name of the Glue table.</p>"
},
"databaseName":{
"shape":"GlueDatabaseName",
"documentation":"<p>The name of the database the Glue table belongs to.</p>"
}
},
"documentation":"<p>A reference to a table within an Glue data catalog.</p>"
},
"InternalServerException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>Unexpected error during processing of request.</p>",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"JoinOperator":{
"type":"string",
"enum":[
"OR",
"AND"
]
},
"JoinOperatorsList":{
"type":"list",
"member":{"shape":"JoinOperator"},
"max":2,
"min":0
},
"JoinRequiredOption":{
"type":"string",
"enum":["QUERY_RUNNER"]
},
"KeyPrefix":{
"type":"string",
"max":512,
"min":0,
"pattern":"[\\w!.=*/-]*"
},
"ListAnalysisTemplatesInput":{
"type":"structure",
"required":["membershipIdentifier"],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a membership resource.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of the results that is returned per call.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListAnalysisTemplatesOutput":{
"type":"structure",
"required":["analysisTemplateSummaries"],
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
},
"analysisTemplateSummaries":{
"shape":"AnalysisTemplateSummaryList",
"documentation":"<p>Lists analysis template metadata.</p>"
}
}
},
"ListCollaborationAnalysisTemplatesInput":{
"type":"structure",
"required":["collaborationIdentifier"],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of the results that is returned per call.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListCollaborationAnalysisTemplatesOutput":{
"type":"structure",
"required":["collaborationAnalysisTemplateSummaries"],
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
},
"collaborationAnalysisTemplateSummaries":{
"shape":"CollaborationAnalysisTemplateSummaryList",
"documentation":"<p>The metadata of the analysis template within a collaboration.</p>"
}
}
},
"ListCollaborationConfiguredAudienceModelAssociationsInput":{
"type":"structure",
"required":["collaborationIdentifier"],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of the results that is returned per call.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListCollaborationConfiguredAudienceModelAssociationsOutput":{
"type":"structure",
"required":["collaborationConfiguredAudienceModelAssociationSummaries"],
"members":{
"collaborationConfiguredAudienceModelAssociationSummaries":{
"shape":"CollaborationConfiguredAudienceModelAssociationSummaryList",
"documentation":"<p>The metadata of the configured audience model association within a collaboration.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
}
}
},
"ListCollaborationPrivacyBudgetTemplatesInput":{
"type":"structure",
"required":["collaborationIdentifier"],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for one of your collaborations.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListCollaborationPrivacyBudgetTemplatesOutput":{
"type":"structure",
"required":["collaborationPrivacyBudgetTemplateSummaries"],
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
},
"collaborationPrivacyBudgetTemplateSummaries":{
"shape":"CollaborationPrivacyBudgetTemplateSummaryList",
"documentation":"<p>An array that summarizes the collaboration privacy budget templates. The summary includes collaboration information, creation information, the privacy budget type.</p>"
}
}
},
"ListCollaborationPrivacyBudgetsInput":{
"type":"structure",
"required":[
"collaborationIdentifier",
"privacyBudgetType"
],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for one of your collaborations.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"privacyBudgetType":{
"shape":"PrivacyBudgetType",
"documentation":"<p>Specifies the type of the privacy budget.</p>",
"location":"querystring",
"locationName":"privacyBudgetType"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListCollaborationPrivacyBudgetsOutput":{
"type":"structure",
"required":["collaborationPrivacyBudgetSummaries"],
"members":{
"collaborationPrivacyBudgetSummaries":{
"shape":"CollaborationPrivacyBudgetSummaryList",
"documentation":"<p>Summaries of the collaboration privacy budgets.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
}
}
},
"ListCollaborationsInput":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"memberStatus":{
"shape":"FilterableMemberStatus",
"documentation":"<p>The caller's status in a collaboration.</p>",
"location":"querystring",
"locationName":"memberStatus"
}
}
},
"ListCollaborationsOutput":{
"type":"structure",
"required":["collaborationList"],
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
},
"collaborationList":{
"shape":"CollaborationSummaryList",
"documentation":"<p>The list of collaborations.</p>"
}
}
},
"ListConfiguredAudienceModelAssociationsInput":{
"type":"structure",
"required":["membershipIdentifier"],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier for a membership that contains the configured audience model associations that you want to retrieve.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListConfiguredAudienceModelAssociationsOutput":{
"type":"structure",
"required":["configuredAudienceModelAssociationSummaries"],
"members":{
"configuredAudienceModelAssociationSummaries":{
"shape":"ConfiguredAudienceModelAssociationSummaryList",
"documentation":"<p>Summaries of the configured audience model associations that you requested.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value provided to access the next page of results.</p>"
}
}
},
"ListConfiguredTableAssociationsInput":{
"type":"structure",
"required":["membershipIdentifier"],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of the results that is returned per call.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListConfiguredTableAssociationsOutput":{
"type":"structure",
"required":["configuredTableAssociationSummaries"],
"members":{
"configuredTableAssociationSummaries":{
"shape":"ConfiguredTableAssociationSummaryList",
"documentation":"<p>The retrieved list of configured table associations.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
}
}
},
"ListConfiguredTablesInput":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of the results that is returned per call.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListConfiguredTablesOutput":{
"type":"structure",
"required":["configuredTableSummaries"],
"members":{
"configuredTableSummaries":{
"shape":"ConfiguredTableSummaryList",
"documentation":"<p>The configured tables listed by the request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
}
}
},
"ListMembersInput":{
"type":"structure",
"required":["collaborationIdentifier"],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>The identifier of the collaboration in which the members are listed.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of the results that is returned per call.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListMembersOutput":{
"type":"structure",
"required":["memberSummaries"],
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
},
"memberSummaries":{
"shape":"MemberSummaryList",
"documentation":"<p>The list of members returned by the ListMembers operation.</p>"
}
}
},
"ListMembershipsInput":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of the results that is returned per call.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"status":{
"shape":"MembershipStatus",
"documentation":"<p>A filter which will return only memberships in the specified status.</p>",
"location":"querystring",
"locationName":"status"
}
}
},
"ListMembershipsOutput":{
"type":"structure",
"required":["membershipSummaries"],
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
},
"membershipSummaries":{
"shape":"MembershipSummaryList",
"documentation":"<p>The list of memberships returned from the ListMemberships operation.</p>"
}
}
},
"ListPrivacyBudgetTemplatesInput":{
"type":"structure",
"required":["membershipIdentifier"],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListPrivacyBudgetTemplatesOutput":{
"type":"structure",
"required":["privacyBudgetTemplateSummaries"],
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
},
"privacyBudgetTemplateSummaries":{
"shape":"PrivacyBudgetTemplateSummaryList",
"documentation":"<p>An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.</p>"
}
}
},
"ListPrivacyBudgetsInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"privacyBudgetType"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"privacyBudgetType":{
"shape":"PrivacyBudgetType",
"documentation":"<p>The privacy budget type.</p>",
"location":"querystring",
"locationName":"privacyBudgetType"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListPrivacyBudgetsOutput":{
"type":"structure",
"required":["privacyBudgetSummaries"],
"members":{
"privacyBudgetSummaries":{
"shape":"PrivacyBudgetSummaryList",
"documentation":"<p>An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
}
}
},
"ListProtectedQueriesInput":{
"type":"structure",
"required":["membershipIdentifier"],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for the membership in the collaboration.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"status":{
"shape":"ProtectedQueryStatus",
"documentation":"<p>A filter on the status of the protected query.</p>",
"location":"querystring",
"locationName":"status"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met. </p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListProtectedQueriesOutput":{
"type":"structure",
"required":["protectedQueries"],
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
},
"protectedQueries":{
"shape":"ProtectedQuerySummaryList",
"documentation":"<p>A list of protected queries.</p>"
}
}
},
"ListSchemasInput":{
"type":"structure",
"required":["collaborationIdentifier"],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"schemaType":{
"shape":"SchemaType",
"documentation":"<p>If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.</p>",
"location":"querystring",
"locationName":"schemaType"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of the results that is returned per call.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListSchemasOutput":{
"type":"structure",
"required":["schemaSummaries"],
"members":{
"schemaSummaries":{
"shape":"SchemaSummaryList",
"documentation":"<p>The retrieved list of schemas.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The token value retrieved from a previous call to access the next page of results.</p>"
}
}
},
"ListTagsForResourceInput":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"CleanroomsArn",
"documentation":"<p>The Amazon Resource Name (ARN) associated with the resource you want to list tags on.</p>",
"location":"uri",
"locationName":"resourceArn"
}
}
},
"ListTagsForResourceOutput":{
"type":"structure",
"required":["tags"],
"members":{
"tags":{
"shape":"TagMap",
"documentation":"<p>A map of objects specifying each key name and value.</p>"
}
}
},
"Long":{
"type":"long",
"box":true
},
"MaxResults":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"MemberAbilities":{
"type":"list",
"member":{"shape":"MemberAbility"}
},
"MemberAbility":{
"type":"string",
"enum":[
"CAN_QUERY",
"CAN_RECEIVE_RESULTS"
]
},
"MemberList":{
"type":"list",
"member":{"shape":"MemberSpecification"},
"max":9,
"min":0
},
"MemberSpecification":{
"type":"structure",
"required":[
"accountId",
"memberAbilities",
"displayName"
],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>"
},
"memberAbilities":{
"shape":"MemberAbilities",
"documentation":"<p>The abilities granted to the collaboration member.</p>"
},
"displayName":{
"shape":"DisplayName",
"documentation":"<p>The member's display name.</p>"
},
"paymentConfiguration":{
"shape":"PaymentConfiguration",
"documentation":"<p>The collaboration member's payment responsibilities set by the collaboration creator. </p> <p>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.</p>"
}
},
"documentation":"<p>Basic metadata used to construct a new member.</p>"
},
"MemberStatus":{
"type":"string",
"enum":[
"INVITED",
"ACTIVE",
"LEFT",
"REMOVED"
]
},
"MemberSummary":{
"type":"structure",
"required":[
"accountId",
"status",
"displayName",
"abilities",
"createTime",
"updateTime",
"paymentConfiguration"
],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>"
},
"status":{
"shape":"MemberStatus",
"documentation":"<p>The status of the member. </p>"
},
"displayName":{
"shape":"DisplayName",
"documentation":"<p>The member's display name.</p>"
},
"abilities":{
"shape":"MemberAbilities",
"documentation":"<p>The abilities granted to the collaboration member.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time when the member was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the member metadata was last updated.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The unique ID for the member's associated membership, if present.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The unique ARN for the member's associated membership, if present.</p>"
},
"paymentConfiguration":{
"shape":"PaymentConfiguration",
"documentation":"<p>The collaboration member's payment responsibilities set by the collaboration creator. </p>"
}
},
"documentation":"<p>The member object listed by the request.</p>"
},
"MemberSummaryList":{
"type":"list",
"member":{"shape":"MemberSummary"}
},
"Membership":{
"type":"structure",
"required":[
"id",
"arn",
"collaborationArn",
"collaborationId",
"collaborationCreatorAccountId",
"collaborationCreatorDisplayName",
"collaborationName",
"createTime",
"updateTime",
"status",
"memberAbilities",
"queryLogStatus",
"paymentConfiguration"
],
"members":{
"id":{
"shape":"UUID",
"documentation":"<p>The unique ID of the membership.</p>"
},
"arn":{
"shape":"MembershipArn",
"documentation":"<p>The unique ARN for the membership.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the membership's associated collaboration.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique ID for the membership's collaboration.</p>"
},
"collaborationCreatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>"
},
"collaborationCreatorDisplayName":{
"shape":"DisplayName",
"documentation":"<p>The display name of the collaboration creator.</p>"
},
"collaborationName":{
"shape":"CollaborationName",
"documentation":"<p>The name of the membership's collaboration.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time when the membership was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the membership metadata was last updated.</p>"
},
"status":{
"shape":"MembershipStatus",
"documentation":"<p>The status of the membership.</p>"
},
"memberAbilities":{
"shape":"MemberAbilities",
"documentation":"<p>The abilities granted to the collaboration member.</p>"
},
"queryLogStatus":{
"shape":"MembershipQueryLogStatus",
"documentation":"<p>An indicator as to whether query logging has been enabled or disabled for the membership.</p>"
},
"defaultResultConfiguration":{
"shape":"MembershipProtectedQueryResultConfiguration",
"documentation":"<p>The default protected query result configuration as specified by the member who can receive results.</p>"
},
"paymentConfiguration":{
"shape":"MembershipPaymentConfiguration",
"documentation":"<p>The payment responsibilities accepted by the collaboration member.</p>"
}
},
"documentation":"<p>The membership object.</p>"
},
"MembershipArn":{
"type":"string",
"max":100,
"min":0,
"pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+"
},
"MembershipIdentifier":{
"type":"string",
"max":36,
"min":36,
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"MembershipPaymentConfiguration":{
"type":"structure",
"required":["queryCompute"],
"members":{
"queryCompute":{
"shape":"MembershipQueryComputePaymentConfig",
"documentation":"<p>The payment responsibilities accepted by the collaboration member for query compute costs.</p>"
}
},
"documentation":"<p>An object representing the payment responsibilities accepted by the collaboration member.</p>"
},
"MembershipProtectedQueryOutputConfiguration":{
"type":"structure",
"members":{
"s3":{"shape":"ProtectedQueryS3OutputConfiguration"}
},
"documentation":"<p>Contains configurations for protected query results.</p>",
"union":true
},
"MembershipProtectedQueryResultConfiguration":{
"type":"structure",
"required":["outputConfiguration"],
"members":{
"outputConfiguration":{
"shape":"MembershipProtectedQueryOutputConfiguration",
"documentation":"<p>Configuration for protected query results.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.</p>"
}
},
"documentation":"<p>Contains configurations for protected query results.</p>"
},
"MembershipQueryComputePaymentConfig":{
"type":"structure",
"required":["isResponsible"],
"members":{
"isResponsible":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the collaboration member has accepted to pay for query compute costs (<code>TRUE</code>) or has not accepted to pay for query compute costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query compute costs. </p> </li> </ul>"
}
},
"documentation":"<p>An object representing the payment responsibilities accepted by the collaboration member for query compute costs.</p>"
},
"MembershipQueryLogStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"MembershipStatus":{
"type":"string",
"enum":[
"ACTIVE",
"REMOVED",
"COLLABORATION_DELETED"
]
},
"MembershipSummary":{
"type":"structure",
"required":[
"id",
"arn",
"collaborationArn",
"collaborationId",
"collaborationCreatorAccountId",
"collaborationCreatorDisplayName",
"collaborationName",
"createTime",
"updateTime",
"status",
"memberAbilities",
"paymentConfiguration"
],
"members":{
"id":{
"shape":"UUID",
"documentation":"<p>The unique ID for the membership's collaboration.</p>"
},
"arn":{
"shape":"MembershipArn",
"documentation":"<p>The unique ARN for the membership.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the membership's associated collaboration.</p>"
},
"collaborationId":{
"shape":"CollaborationIdentifier",
"documentation":"<p>The unique ID for the membership's collaboration.</p>"
},
"collaborationCreatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.</p>"
},
"collaborationCreatorDisplayName":{
"shape":"DisplayName",
"documentation":"<p>The display name of the collaboration creator.</p>"
},
"collaborationName":{
"shape":"CollaborationName",
"documentation":"<p>The name for the membership's collaboration.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time when the membership was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the membership metadata was last updated.</p>"
},
"status":{
"shape":"MembershipStatus",
"documentation":"<p>The status of the membership.</p>"
},
"memberAbilities":{
"shape":"MemberAbilities",
"documentation":"<p>The abilities granted to the collaboration member.</p>"
},
"paymentConfiguration":{
"shape":"MembershipPaymentConfiguration",
"documentation":"<p>The payment responsibilities accepted by the collaboration member.</p>"
}
},
"documentation":"<p>The membership object listed by the request.</p>"
},
"MembershipSummaryList":{
"type":"list",
"member":{"shape":"MembershipSummary"}
},
"PaginationToken":{
"type":"string",
"max":10240,
"min":0
},
"ParameterMap":{
"type":"map",
"key":{"shape":"ParameterName"},
"value":{"shape":"ParameterValue"}
},
"ParameterName":{
"type":"string",
"max":100,
"min":1,
"pattern":"[0-9a-zA-Z_]+"
},
"ParameterType":{
"type":"string",
"enum":[
"SMALLINT",
"INTEGER",
"BIGINT",
"DECIMAL",
"REAL",
"DOUBLE_PRECISION",
"BOOLEAN",
"CHAR",
"VARCHAR",
"DATE",
"TIMESTAMP",
"TIMESTAMPTZ",
"TIME",
"TIMETZ",
"VARBYTE"
]
},
"ParameterValue":{
"type":"string",
"max":250,
"min":0
},
"PaymentConfiguration":{
"type":"structure",
"required":["queryCompute"],
"members":{
"queryCompute":{
"shape":"QueryComputePaymentConfig",
"documentation":"<p>The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.</p>"
}
},
"documentation":"<p>An object representing the collaboration member's payment responsibilities set by the collaboration creator.</p>"
},
"PreviewPrivacyImpactInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"parameters"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier for one of your memberships for a collaboration. Accepts a membership ID.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"parameters":{
"shape":"PreviewPrivacyImpactParametersInput",
"documentation":"<p>Specifies the desired epsilon and noise parameters to preview.</p>"
}
}
},
"PreviewPrivacyImpactOutput":{
"type":"structure",
"required":["privacyImpact"],
"members":{
"privacyImpact":{
"shape":"PrivacyImpact",
"documentation":"<p>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.</p>"
}
}
},
"PreviewPrivacyImpactParametersInput":{
"type":"structure",
"members":{
"differentialPrivacy":{
"shape":"DifferentialPrivacyPreviewParametersInput",
"documentation":"<p>An array that specifies the epsilon and noise parameters.</p>"
}
},
"documentation":"<p>Specifies the updated epsilon and noise parameters to preview. The preview allows you to see how the maximum number of each type of aggregation function would change with the new parameters.</p>",
"union":true
},
"PrivacyBudget":{
"type":"structure",
"members":{
"differentialPrivacy":{
"shape":"DifferentialPrivacyPrivacyBudget",
"documentation":"<p>An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.</p>"
}
},
"documentation":"<p>The epsilon parameter value and number of each aggregation function that you can perform.</p>",
"union":true
},
"PrivacyBudgetSummary":{
"type":"structure",
"required":[
"id",
"privacyBudgetTemplateId",
"privacyBudgetTemplateArn",
"membershipId",
"membershipArn",
"collaborationId",
"collaborationArn",
"type",
"createTime",
"updateTime",
"budget"
],
"members":{
"id":{
"shape":"UUID",
"documentation":"<p>The unique identifier of the privacy budget.</p>"
},
"privacyBudgetTemplateId":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>The unique identifier of the privacy budget template.</p>"
},
"privacyBudgetTemplateArn":{
"shape":"PrivacyBudgetTemplateArn",
"documentation":"<p>The ARN of the privacy budget template.</p>"
},
"membershipId":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a membership resource.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the member who created the privacy budget summary.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique identifier of the collaboration that contains this privacy budget.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The ARN of the collaboration that contains this privacy budget.</p>"
},
"type":{
"shape":"PrivacyBudgetType",
"documentation":"<p>Specifies the type of the privacy budget.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the privacy budget was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the privacy budget was updated.</p>"
},
"budget":{
"shape":"PrivacyBudget",
"documentation":"<p>The provided privacy budget.</p>"
}
},
"documentation":"<p>An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.</p>"
},
"PrivacyBudgetSummaryList":{
"type":"list",
"member":{"shape":"PrivacyBudgetSummary"}
},
"PrivacyBudgetTemplate":{
"type":"structure",
"required":[
"id",
"arn",
"membershipId",
"membershipArn",
"collaborationId",
"collaborationArn",
"createTime",
"updateTime",
"privacyBudgetType",
"autoRefresh",
"parameters"
],
"members":{
"id":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>The unique identifier of the privacy budget template.</p>"
},
"arn":{
"shape":"PrivacyBudgetTemplateArn",
"documentation":"<p>The ARN of the privacy budget template.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The identifier for a membership resource.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the member who created the privacy budget template.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique ID of the collaboration that contains this privacy budget template.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The ARN of the collaboration that contains this privacy budget template.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the privacy budget template was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the privacy budget template was updated.</p>"
},
"privacyBudgetType":{
"shape":"PrivacyBudgetType",
"documentation":"<p>Specifies the type of the privacy budget template.</p>"
},
"autoRefresh":{
"shape":"PrivacyBudgetTemplateAutoRefresh",
"documentation":"<p>How often the privacy budget refreshes.</p> <important> <p>If you plan to regularly bring new data into the collaboration, use <code>CALENDAR_MONTH</code> 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 queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.</p> </important>"
},
"parameters":{
"shape":"PrivacyBudgetTemplateParametersOutput",
"documentation":"<p>Specifies the epislon and noise parameters for the privacy budget template.</p>"
}
},
"documentation":"<p>An object that defines the privacy budget template.</p>"
},
"PrivacyBudgetTemplateArn":{
"type":"string",
"max":100,
"min":0,
"pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:privacybudgettemplate/[\\d\\w-]+"
},
"PrivacyBudgetTemplateAutoRefresh":{
"type":"string",
"enum":[
"CALENDAR_MONTH",
"NONE"
]
},
"PrivacyBudgetTemplateIdentifier":{
"type":"string",
"max":36,
"min":36,
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"PrivacyBudgetTemplateParametersInput":{
"type":"structure",
"members":{
"differentialPrivacy":{
"shape":"DifferentialPrivacyTemplateParametersInput",
"documentation":"<p>An object that specifies the epsilon and noise parameters.</p>"
}
},
"documentation":"<p>The epsilon and noise parameters that you want to use for the privacy budget template.</p>",
"union":true
},
"PrivacyBudgetTemplateParametersOutput":{
"type":"structure",
"members":{
"differentialPrivacy":{
"shape":"DifferentialPrivacyTemplateParametersOutput",
"documentation":"<p>The epsilon and noise parameters.</p>"
}
},
"documentation":"<p>The epsilon and noise parameters that were used in the privacy budget template.</p>",
"union":true
},
"PrivacyBudgetTemplateSummary":{
"type":"structure",
"required":[
"id",
"arn",
"membershipId",
"membershipArn",
"collaborationId",
"collaborationArn",
"privacyBudgetType",
"createTime",
"updateTime"
],
"members":{
"id":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>The unique identifier of the privacy budget template.</p>"
},
"arn":{
"shape":"PrivacyBudgetTemplateArn",
"documentation":"<p>The ARN of the privacy budget template.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The identifier for a membership resource.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the member who created the privacy budget template.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique ID of the collaboration that contains this privacy budget template.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The ARN of the collaboration that contains this privacy budget template.</p>"
},
"privacyBudgetType":{
"shape":"PrivacyBudgetType",
"documentation":"<p>The type of the privacy budget template.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the privacy budget template was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The most recent time at which the privacy budget template was updated.</p>"
}
},
"documentation":"<p>A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.</p>"
},
"PrivacyBudgetTemplateSummaryList":{
"type":"list",
"member":{"shape":"PrivacyBudgetTemplateSummary"}
},
"PrivacyBudgetTemplateUpdateParameters":{
"type":"structure",
"members":{
"differentialPrivacy":{
"shape":"DifferentialPrivacyTemplateUpdateParameters",
"documentation":"<p>An object that specifies the new values for the epsilon and noise parameters.</p>"
}
},
"documentation":"<p>The epsilon and noise parameters that you want to update in the privacy budget template.</p>",
"union":true
},
"PrivacyBudgetType":{
"type":"string",
"enum":["DIFFERENTIAL_PRIVACY"]
},
"PrivacyImpact":{
"type":"structure",
"members":{
"differentialPrivacy":{
"shape":"DifferentialPrivacyPrivacyImpact",
"documentation":"<p>An object that lists the number and type of aggregation functions you can perform.</p>"
}
},
"documentation":"<p>Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.</p>",
"union":true
},
"ProtectedQuery":{
"type":"structure",
"required":[
"id",
"membershipId",
"membershipArn",
"createTime",
"status"
],
"members":{
"id":{
"shape":"UUID",
"documentation":"<p>The identifier for a protected query instance.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The identifier for the membership.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The ARN of the membership.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the protected query was created.</p>"
},
"sqlParameters":{
"shape":"ProtectedQuerySQLParameters",
"documentation":"<p>The protected query SQL parameters.</p>"
},
"status":{
"shape":"ProtectedQueryStatus",
"documentation":"<p>The status of the query.</p>"
},
"resultConfiguration":{
"shape":"ProtectedQueryResultConfiguration",
"documentation":"<p>Contains any details needed to write the query results.</p>"
},
"statistics":{
"shape":"ProtectedQueryStatistics",
"documentation":"<p>Statistics about protected query execution.</p>"
},
"result":{
"shape":"ProtectedQueryResult",
"documentation":"<p>The result of the protected query.</p>"
},
"error":{
"shape":"ProtectedQueryError",
"documentation":"<p>An error thrown by the protected query.</p>"
},
"differentialPrivacy":{
"shape":"DifferentialPrivacyParameters",
"documentation":"<p>The sensitivity parameters of the differential privacy results of the protected query.</p>"
}
},
"documentation":"<p>The parameters for an Clean Rooms protected query.</p>"
},
"ProtectedQueryError":{
"type":"structure",
"required":[
"message",
"code"
],
"members":{
"message":{
"shape":"String",
"documentation":"<p>A description of why the query failed.</p>"
},
"code":{
"shape":"String",
"documentation":"<p>An error code for the error.</p>"
}
},
"documentation":"<p>Details of errors thrown by the protected query.</p>"
},
"ProtectedQueryIdentifier":{
"type":"string",
"max":36,
"min":36,
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"ProtectedQueryMemberOutputList":{
"type":"list",
"member":{"shape":"ProtectedQuerySingleMemberOutput"}
},
"ProtectedQueryOutput":{
"type":"structure",
"members":{
"s3":{
"shape":"ProtectedQueryS3Output",
"documentation":"<p>If present, the output for a protected query with an `S3` output type.</p>"
},
"memberList":{
"shape":"ProtectedQueryMemberOutputList",
"documentation":"<p>The list of member Amazon Web Services account(s) that received the results of the query. </p>"
}
},
"documentation":"<p>Contains details about the protected query output.</p>",
"union":true
},
"ProtectedQueryOutputConfiguration":{
"type":"structure",
"members":{
"s3":{
"shape":"ProtectedQueryS3OutputConfiguration",
"documentation":"<p>Required configuration for a protected query with an `S3` output type.</p>"
}
},
"documentation":"<p>Contains configuration details for protected query output.</p>",
"union":true
},
"ProtectedQueryResult":{
"type":"structure",
"required":["output"],
"members":{
"output":{
"shape":"ProtectedQueryOutput",
"documentation":"<p>The output of the protected query.</p>"
}
},
"documentation":"<p>Details about the query results.</p>"
},
"ProtectedQueryResultConfiguration":{
"type":"structure",
"required":["outputConfiguration"],
"members":{
"outputConfiguration":{
"shape":"ProtectedQueryOutputConfiguration",
"documentation":"<p>Configuration for protected query results.</p>"
}
},
"documentation":"<p>Contains configurations for protected query results.</p>"
},
"ProtectedQueryS3Output":{
"type":"structure",
"required":["location"],
"members":{
"location":{
"shape":"String",
"documentation":"<p>The S3 location of the result.</p>"
}
},
"documentation":"<p>Contains output information for protected queries with an S3 output type.</p>"
},
"ProtectedQueryS3OutputConfiguration":{
"type":"structure",
"required":[
"resultFormat",
"bucket"
],
"members":{
"resultFormat":{
"shape":"ResultFormat",
"documentation":"<p>Intended file format of the result.</p>"
},
"bucket":{
"shape":"ProtectedQueryS3OutputConfigurationBucketString",
"documentation":"<p>The S3 bucket to unload the protected query results.</p>"
},
"keyPrefix":{
"shape":"KeyPrefix",
"documentation":"<p>The S3 prefix to unload the protected query results.</p>"
}
},
"documentation":"<p>Contains the configuration to write the query results to S3.</p>"
},
"ProtectedQueryS3OutputConfigurationBucketString":{
"type":"string",
"max":63,
"min":3,
"pattern":".*(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$).*"
},
"ProtectedQuerySQLParameters":{
"type":"structure",
"members":{
"queryString":{
"shape":"ProtectedQuerySQLParametersQueryStringString",
"documentation":"<p>The query string to be submitted.</p>"
},
"analysisTemplateArn":{
"shape":"AnalysisTemplateArn",
"documentation":"<p>The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.</p>"
},
"parameters":{
"shape":"ParameterMap",
"documentation":"<p>The protected query SQL parameters.</p>"
}
},
"documentation":"<p>The parameters for the SQL type Protected Query.</p>",
"sensitive":true
},
"ProtectedQuerySQLParametersQueryStringString":{
"type":"string",
"max":90000,
"min":0
},
"ProtectedQuerySingleMemberOutput":{
"type":"structure",
"required":["accountId"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.</p>"
}
},
"documentation":"<p>Details about the member who received the query result.</p>"
},
"ProtectedQueryStatistics":{
"type":"structure",
"members":{
"totalDurationInMillis":{
"shape":"Long",
"documentation":"<p>The duration of the Protected Query, from creation until query completion.</p>"
}
},
"documentation":"<p>Contains statistics about the execution of the protected query.</p>"
},
"ProtectedQueryStatus":{
"type":"string",
"enum":[
"SUBMITTED",
"STARTED",
"CANCELLED",
"CANCELLING",
"FAILED",
"SUCCESS",
"TIMED_OUT"
]
},
"ProtectedQuerySummary":{
"type":"structure",
"required":[
"id",
"membershipId",
"membershipArn",
"createTime",
"status"
],
"members":{
"id":{
"shape":"UUID",
"documentation":"<p>The unique ID of the protected query.</p>"
},
"membershipId":{
"shape":"UUID",
"documentation":"<p>The unique ID for the membership that initiated the protected query.</p>"
},
"membershipArn":{
"shape":"MembershipArn",
"documentation":"<p>The unique ARN for the membership that initiated the protected query.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time the protected query was created.</p>"
},
"status":{
"shape":"ProtectedQueryStatus",
"documentation":"<p>The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.</p>"
}
},
"documentation":"<p>The protected query summary for the objects listed by the request.</p>"
},
"ProtectedQuerySummaryList":{
"type":"list",
"member":{"shape":"ProtectedQuerySummary"}
},
"ProtectedQueryType":{
"type":"string",
"enum":["SQL"]
},
"QueryComputePaymentConfig":{
"type":"structure",
"required":["isResponsible"],
"members":{
"isResponsible":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (<code>TRUE</code>) or has not configured the collaboration member to pay for query compute costs (<code>FALSE</code>).</p> <p>Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a <code>TRUE</code> value for more than one member in the collaboration. </p> <p>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. An error is returned if the collaboration creator sets a <code>FALSE</code> value for the member who can query.</p>"
}
},
"documentation":"<p>An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.</p>"
},
"QueryTables":{
"type":"list",
"member":{"shape":"TableAlias"}
},
"ResourceAlias":{
"type":"string",
"max":128,
"min":0,
"pattern":"[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?"
},
"ResourceDescription":{
"type":"string",
"max":255,
"min":0,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*"
},
"ResourceNotFoundException":{
"type":"structure",
"required":[
"message",
"resourceId",
"resourceType"
],
"members":{
"message":{"shape":"String"},
"resourceId":{
"shape":"String",
"documentation":"<p>The Id of the missing resource.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of the missing resource.</p>"
}
},
"documentation":"<p>Request references a resource which does not exist.</p>",
"error":{
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"ResourceType":{
"type":"string",
"enum":[
"CONFIGURED_TABLE",
"COLLABORATION",
"MEMBERSHIP",
"CONFIGURED_TABLE_ASSOCIATION"
]
},
"ResultFormat":{
"type":"string",
"enum":[
"CSV",
"PARQUET"
]
},
"RoleArn":{
"type":"string",
"max":512,
"min":32,
"pattern":"arn:aws:iam::[\\w]+:role/[\\w+=./@-]+"
},
"ScalarFunctions":{
"type":"string",
"enum":[
"TRUNC",
"ABS",
"CEILING",
"FLOOR",
"LN",
"LOG",
"ROUND",
"SQRT",
"CAST",
"LOWER",
"RTRIM",
"UPPER",
"COALESCE"
]
},
"ScalarFunctionsList":{
"type":"list",
"member":{"shape":"ScalarFunctions"}
},
"Schema":{
"type":"structure",
"required":[
"columns",
"partitionKeys",
"analysisRuleTypes",
"creatorAccountId",
"name",
"collaborationId",
"collaborationArn",
"description",
"createTime",
"updateTime",
"type"
],
"members":{
"columns":{
"shape":"ColumnList",
"documentation":"<p>The columns for the relation this schema represents.</p>"
},
"partitionKeys":{
"shape":"ColumnList",
"documentation":"<p>The partition keys for the dataset underlying this schema.</p>"
},
"analysisRuleTypes":{
"shape":"AnalysisRuleTypeList",
"documentation":"<p>The analysis rule types associated with the schema. Currently, only one entry is present.</p>"
},
"analysisMethod":{
"shape":"AnalysisMethod",
"documentation":"<p>The analysis method for the schema. The only valid value is currently DIRECT_QUERY.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The unique account ID for the Amazon Web Services account that owns the schema.</p>"
},
"name":{
"shape":"TableAlias",
"documentation":"<p>A name for the schema. The schema relation is referred to by this name when queried by a protected query.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique ID for the collaboration that the schema belongs to.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the collaboration that the schema belongs to.</p>"
},
"description":{
"shape":"TableDescription",
"documentation":"<p>A description for the schema.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time the schema was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the schema was last updated.</p>"
},
"type":{
"shape":"SchemaType",
"documentation":"<p>The type of schema. The only valid value is currently `TABLE`.</p>"
}
},
"documentation":"<p>A schema is a relation within a collaboration.</p>"
},
"SchemaList":{
"type":"list",
"member":{"shape":"Schema"},
"max":25,
"min":0
},
"SchemaSummary":{
"type":"structure",
"required":[
"name",
"type",
"creatorAccountId",
"createTime",
"updateTime",
"collaborationId",
"collaborationArn",
"analysisRuleTypes"
],
"members":{
"name":{
"shape":"TableAlias",
"documentation":"<p>The name for the schema object.</p>"
},
"type":{
"shape":"SchemaType",
"documentation":"<p>The type of schema object. The only valid schema type is currently `TABLE`.</p>"
},
"creatorAccountId":{
"shape":"AccountId",
"documentation":"<p>The unique account ID for the Amazon Web Services account that owns the schema.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>The time the schema object was created.</p>"
},
"updateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the schema object was last updated.</p>"
},
"collaborationId":{
"shape":"UUID",
"documentation":"<p>The unique ID for the collaboration that the schema belongs to.</p>"
},
"collaborationArn":{
"shape":"CollaborationArn",
"documentation":"<p>The unique ARN for the collaboration that the schema belongs to.</p>"
},
"analysisRuleTypes":{
"shape":"AnalysisRuleTypeList",
"documentation":"<p>The types of analysis rules that are associated with this schema object.</p>"
},
"analysisMethod":{
"shape":"AnalysisMethod",
"documentation":"<p>The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.</p>"
}
},
"documentation":"<p>The schema summary for the objects listed by the request.</p>"
},
"SchemaSummaryList":{
"type":"list",
"member":{"shape":"SchemaSummary"}
},
"SchemaType":{
"type":"string",
"enum":["TABLE"]
},
"ServiceQuotaExceededException":{
"type":"structure",
"required":[
"message",
"quotaName",
"quotaValue"
],
"members":{
"message":{"shape":"String"},
"quotaName":{
"shape":"String",
"documentation":"<p>The name of the quota.</p>"
},
"quotaValue":{
"shape":"Double",
"documentation":"<p>The value of the quota.</p>"
}
},
"documentation":"<p>Request denied because service quota has been exceeded.</p>",
"error":{
"httpStatusCode":402,
"senderFault":true
},
"exception":true
},
"StartProtectedQueryInput":{
"type":"structure",
"required":[
"type",
"membershipIdentifier",
"sqlParameters"
],
"members":{
"type":{
"shape":"ProtectedQueryType",
"documentation":"<p>The type of the protected query to be started.</p>"
},
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier for the membership to run this query against. Currently accepts a membership ID.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"sqlParameters":{
"shape":"ProtectedQuerySQLParameters",
"documentation":"<p>The protected SQL query parameters.</p>"
},
"resultConfiguration":{
"shape":"ProtectedQueryResultConfiguration",
"documentation":"<p>The details needed to write the query results.</p>"
}
}
},
"StartProtectedQueryOutput":{
"type":"structure",
"required":["protectedQuery"],
"members":{
"protectedQuery":{
"shape":"ProtectedQuery",
"documentation":"<p>The protected query.</p>"
}
}
},
"String":{"type":"string"},
"TableAlias":{
"type":"string",
"max":128,
"min":0,
"pattern":"[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?"
},
"TableAliasList":{
"type":"list",
"member":{"shape":"TableAlias"},
"max":25,
"min":1
},
"TableDescription":{
"type":"string",
"max":255,
"min":0,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*"
},
"TableReference":{
"type":"structure",
"members":{
"glue":{
"shape":"GlueTableReference",
"documentation":"<p>If present, a reference to the Glue table referred to by this table reference.</p>"
}
},
"documentation":"<p>A pointer to the dataset that underlies this table. Currently, this can only be an Glue table.</p>",
"union":true
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeys":{
"type":"list",
"member":{"shape":"TagKey"}
},
"TagMap":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"documentation":"<p>Map of tags assigned to a resource</p>",
"max":200,
"min":0
},
"TagResourceInput":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members":{
"resourceArn":{
"shape":"CleanroomsArn",
"documentation":"<p>The Amazon Resource Name (ARN) associated with the resource you want to tag.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map of objects specifying each key name and value.</p>"
}
}
},
"TagResourceOutput":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"TargetProtectedQueryStatus":{
"type":"string",
"enum":["CANCELLED"]
},
"ThrottlingException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>Request was denied due to request throttling.</p>",
"error":{
"httpStatusCode":429,
"senderFault":true
},
"exception":true
},
"Timestamp":{"type":"timestamp"},
"UUID":{
"type":"string",
"max":36,
"min":36,
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"UntagResourceInput":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members":{
"resourceArn":{
"shape":"CleanroomsArn",
"documentation":"<p>The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tagKeys":{
"shape":"TagKeys",
"documentation":"<p>A list of key names of tags to be removed.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UntagResourceOutput":{
"type":"structure",
"members":{
}
},
"UpdateAnalysisTemplateInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"analysisTemplateIdentifier"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a membership resource.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"analysisTemplateIdentifier":{
"shape":"AnalysisTemplateIdentifier",
"documentation":"<p>The identifier for the analysis template resource.</p>",
"location":"uri",
"locationName":"analysisTemplateIdentifier"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>A new description for the analysis template.</p>"
}
}
},
"UpdateAnalysisTemplateOutput":{
"type":"structure",
"required":["analysisTemplate"],
"members":{
"analysisTemplate":{
"shape":"AnalysisTemplate",
"documentation":"<p>The analysis template.</p>"
}
}
},
"UpdateCollaborationInput":{
"type":"structure",
"required":["collaborationIdentifier"],
"members":{
"collaborationIdentifier":{
"shape":"CollaborationIdentifier",
"documentation":"<p>The identifier for the collaboration.</p>",
"location":"uri",
"locationName":"collaborationIdentifier"
},
"name":{
"shape":"CollaborationName",
"documentation":"<p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>"
},
"description":{
"shape":"CollaborationDescription",
"documentation":"<p>A description of the collaboration.</p>"
}
}
},
"UpdateCollaborationOutput":{
"type":"structure",
"required":["collaboration"],
"members":{
"collaboration":{
"shape":"Collaboration",
"documentation":"<p>The entire collaboration that has been updated.</p>"
}
}
},
"UpdateConfiguredAudienceModelAssociationInput":{
"type":"structure",
"required":[
"configuredAudienceModelAssociationIdentifier",
"membershipIdentifier"
],
"members":{
"configuredAudienceModelAssociationIdentifier":{
"shape":"ConfiguredAudienceModelAssociationIdentifier",
"documentation":"<p>A unique identifier for the configured audience model association that you want to update.</p>",
"location":"uri",
"locationName":"configuredAudienceModelAssociationIdentifier"
},
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>A unique identifier of the membership that contains the configured audience model association that you want to update.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>A new description for the configured audience model association.</p>"
},
"name":{
"shape":"ConfiguredAudienceModelAssociationName",
"documentation":"<p>A new name for the configured audience model association.</p>"
}
}
},
"UpdateConfiguredAudienceModelAssociationOutput":{
"type":"structure",
"required":["configuredAudienceModelAssociation"],
"members":{
"configuredAudienceModelAssociation":{
"shape":"ConfiguredAudienceModelAssociation",
"documentation":"<p>Details about the configured audience model association that you updated.</p>"
}
}
},
"UpdateConfiguredTableAnalysisRuleInput":{
"type":"structure",
"required":[
"configuredTableIdentifier",
"analysisRuleType",
"analysisRulePolicy"
],
"members":{
"configuredTableIdentifier":{
"shape":"ConfiguredTableIdentifier",
"documentation":"<p>The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.</p>",
"location":"uri",
"locationName":"configuredTableIdentifier"
},
"analysisRuleType":{
"shape":"ConfiguredTableAnalysisRuleType",
"documentation":"<p>The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.</p>",
"location":"uri",
"locationName":"analysisRuleType"
},
"analysisRulePolicy":{
"shape":"ConfiguredTableAnalysisRulePolicy",
"documentation":"<p>The new analysis rule policy for the configured table analysis rule.</p>"
}
}
},
"UpdateConfiguredTableAnalysisRuleOutput":{
"type":"structure",
"required":["analysisRule"],
"members":{
"analysisRule":{
"shape":"ConfiguredTableAnalysisRule",
"documentation":"<p>The entire updated analysis rule.</p>"
}
}
},
"UpdateConfiguredTableAssociationInput":{
"type":"structure",
"required":[
"configuredTableAssociationIdentifier",
"membershipIdentifier"
],
"members":{
"configuredTableAssociationIdentifier":{
"shape":"ConfiguredTableAssociationIdentifier",
"documentation":"<p>The unique identifier for the configured table association to update. Currently accepts the configured table association ID.</p>",
"location":"uri",
"locationName":"configuredTableAssociationIdentifier"
},
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The unique ID for the membership that the configured table association belongs to.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"description":{
"shape":"TableDescription",
"documentation":"<p>A new description for the configured table association.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The service will assume this role to access catalog metadata and query the table.</p>"
}
}
},
"UpdateConfiguredTableAssociationOutput":{
"type":"structure",
"required":["configuredTableAssociation"],
"members":{
"configuredTableAssociation":{
"shape":"ConfiguredTableAssociation",
"documentation":"<p>The entire updated configured table association.</p>"
}
}
},
"UpdateConfiguredTableInput":{
"type":"structure",
"required":["configuredTableIdentifier"],
"members":{
"configuredTableIdentifier":{
"shape":"ConfiguredTableIdentifier",
"documentation":"<p>The identifier for the configured table to update. Currently accepts the configured table ID.</p>",
"location":"uri",
"locationName":"configuredTableIdentifier"
},
"name":{
"shape":"DisplayName",
"documentation":"<p>A new name for the configured table.</p>"
},
"description":{
"shape":"TableDescription",
"documentation":"<p>A new description for the configured table.</p>"
}
}
},
"UpdateConfiguredTableOutput":{
"type":"structure",
"required":["configuredTable"],
"members":{
"configuredTable":{
"shape":"ConfiguredTable",
"documentation":"<p>The updated configured table.</p>"
}
}
},
"UpdateMembershipInput":{
"type":"structure",
"required":["membershipIdentifier"],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The unique identifier of the membership.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"queryLogStatus":{
"shape":"MembershipQueryLogStatus",
"documentation":"<p>An indicator as to whether query logging has been enabled or disabled for the membership.</p>"
},
"defaultResultConfiguration":{
"shape":"MembershipProtectedQueryResultConfiguration",
"documentation":"<p>The default protected query result configuration as specified by the member who can receive results.</p>"
}
}
},
"UpdateMembershipOutput":{
"type":"structure",
"required":["membership"],
"members":{
"membership":{"shape":"Membership"}
}
},
"UpdatePrivacyBudgetTemplateInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"privacyBudgetTemplateIdentifier",
"privacyBudgetType"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"privacyBudgetTemplateIdentifier":{
"shape":"PrivacyBudgetTemplateIdentifier",
"documentation":"<p>A unique identifier for your privacy budget template that you want to update.</p>",
"location":"uri",
"locationName":"privacyBudgetTemplateIdentifier"
},
"privacyBudgetType":{
"shape":"PrivacyBudgetType",
"documentation":"<p>Specifies the type of the privacy budget template.</p>"
},
"parameters":{
"shape":"PrivacyBudgetTemplateUpdateParameters",
"documentation":"<p>Specifies the epsilon and noise parameters for the privacy budget template.</p>"
}
}
},
"UpdatePrivacyBudgetTemplateOutput":{
"type":"structure",
"required":["privacyBudgetTemplate"],
"members":{
"privacyBudgetTemplate":{
"shape":"PrivacyBudgetTemplate",
"documentation":"<p>Summary of the privacy budget template.</p>"
}
}
},
"UpdateProtectedQueryInput":{
"type":"structure",
"required":[
"membershipIdentifier",
"protectedQueryIdentifier",
"targetStatus"
],
"members":{
"membershipIdentifier":{
"shape":"MembershipIdentifier",
"documentation":"<p>The identifier for a member of a protected query instance.</p>",
"location":"uri",
"locationName":"membershipIdentifier"
},
"protectedQueryIdentifier":{
"shape":"ProtectedQueryIdentifier",
"documentation":"<p>The identifier for a protected query instance.</p>",
"location":"uri",
"locationName":"protectedQueryIdentifier"
},
"targetStatus":{
"shape":"TargetProtectedQueryStatus",
"documentation":"<p>The target status of a query. Used to update the execution status of a currently running query.</p>"
}
}
},
"UpdateProtectedQueryOutput":{
"type":"structure",
"required":["protectedQuery"],
"members":{
"protectedQuery":{
"shape":"ProtectedQuery",
"documentation":"<p>The protected query output.</p>"
}
}
},
"UsersNoisePerQuery":{
"type":"integer",
"box":true,
"max":100,
"min":10
},
"ValidationException":{
"type":"structure",
"members":{
"message":{"shape":"String"},
"reason":{
"shape":"ValidationExceptionReason",
"documentation":"<p>A reason code for the exception.</p>"
},
"fieldList":{
"shape":"ValidationExceptionFieldList",
"documentation":"<p>Validation errors for specific input parameters.</p>"
}
},
"documentation":"<p>The input fails to satisfy the specified constraints.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ValidationExceptionField":{
"type":"structure",
"required":[
"name",
"message"
],
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the input parameter.</p>"
},
"message":{
"shape":"String",
"documentation":"<p>A message for the input validation error.</p>"
}
},
"documentation":"<p>Describes validation errors for specific input parameters.</p>"
},
"ValidationExceptionFieldList":{
"type":"list",
"member":{"shape":"ValidationExceptionField"}
},
"ValidationExceptionReason":{
"type":"string",
"enum":[
"FIELD_VALIDATION_FAILED",
"INVALID_CONFIGURATION",
"INVALID_QUERY",
"IAM_SYNCHRONIZATION_DELAY"
]
}
},
"documentation":"<p>Welcome to the <i>Clean Rooms API Reference</i>.</p> <p>Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data together in a secure collaboration workspace. In the collaboration, members who can query and receive results can get insights into the collective datasets without either party getting access to the other party's raw data.</p> <p>To learn more about Clean Rooms concepts, procedures, and best practices, see the <a href=\"https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html\">Clean Rooms User Guide</a>.</p> <p>To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the <a href=\"https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html\">Clean Rooms SQL Reference</a>.</p>"
}