diff --git a/codegen/sdk-codegen/aws-models/application-auto-scaling.json b/codegen/sdk-codegen/aws-models/application-auto-scaling.json index 10389491008..bcb5579c88b 100644 --- a/codegen/sdk-codegen/aws-models/application-auto-scaling.json +++ b/codegen/sdk-codegen/aws-models/application-auto-scaling.json @@ -147,7 +147,7 @@ "name": "application-autoscaling" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

With Application Auto Scaling, you can configure automatic scaling for the following\n resources:

\n \n

To learn more about Application Auto Scaling, see the Application Auto Scaling User\n Guide.

\n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

\n ", + "smithy.api#documentation": "

With Application Auto Scaling, you can configure automatic scaling for the following\n resources:

\n \n

To learn more about Application Auto Scaling, see the Application Auto Scaling User\n Guide.

\n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

\n ", "smithy.api#title": "Application Auto Scaling", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -191,7 +191,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -234,7 +233,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -247,7 +247,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -261,7 +260,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -284,7 +282,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -319,7 +316,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -330,14 +326,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -351,14 +349,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -367,18 +363,17 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ - "aws-us-gov", { "fn": "getAttr", "argv": [ @@ -387,7 +382,8 @@ }, "name" ] - } + }, + "aws-us-gov" ] } ], @@ -407,14 +403,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -428,7 +426,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -448,7 +445,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -459,14 +455,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -477,9 +475,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1216,7 +1216,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

\n

Deleting a step scaling policy deletes the underlying alarm action, but does not delete\n the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated\n action.

\n

For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the\n Application Auto Scaling User Guide.

", + "smithy.api#documentation": "

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

\n

Deleting a step scaling policy deletes the underlying alarm action, but does not delete\n the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated\n action.

\n

For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the\n Application Auto Scaling User Guide.

", "smithy.api#examples": [ { "title": "To delete a scaling policy", @@ -1252,14 +1252,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } } @@ -1334,14 +1334,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } } @@ -1408,14 +1408,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } } @@ -1503,13 +1503,13 @@ "ResourceIds": { "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n " + "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n " } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

\n " + "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -1621,13 +1621,13 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n " + "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n " } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -1766,13 +1766,13 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n " + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n " } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -1902,13 +1902,13 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n " + "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n " } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -2352,6 +2352,12 @@ "traits": { "smithy.api#enumValue": "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage" } + }, + "SageMakerInferenceComponentInvocationsPerCopy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SageMakerInferenceComponentInvocationsPerCopy" + } } } }, @@ -2462,7 +2468,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a predefined metric for a target tracking scaling policy to use with\n Application Auto Scaling.

\n

Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a\n desired metric already exists by looking up its namespace and dimension using the CloudWatch\n metrics dashboard in the console, follow the procedure in Building dashboards\n with CloudWatch in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

Represents a predefined metric for a target tracking scaling policy to use with\n Application Auto Scaling.

\n

Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a\n desired metric already exists by looking up its namespace and dimension using the CloudWatch\n metrics dashboard in the console, follow the procedure in Monitor your\n resources using CloudWatch in the Application Auto Scaling User Guide.

" } }, "com.amazonaws.applicationautoscaling#PutScalingPolicy": { @@ -2551,21 +2557,21 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, "PolicyType": { "target": "com.amazonaws.applicationautoscaling#PolicyType", "traits": { - "smithy.api#documentation": "

The scaling policy type. This parameter is required if you are creating a scaling\n policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

\n

For more information, see Target\n tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

The scaling policy type. This parameter is required if you are creating a scaling\n policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR.

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

\n

For more information, see Target\n tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

" } }, "StepScalingPolicyConfiguration": { @@ -2684,14 +2690,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -2780,14 +2786,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -3030,6 +3036,12 @@ "traits": { "smithy.api#enumValue": "sagemaker:variant:DesiredProvisionedConcurrency" } + }, + "SageMakerInferenceComponentDesiredCopyCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sagemaker:inference-component:DesiredCopyCount" + } } } }, @@ -3046,14 +3058,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -3154,14 +3166,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -3299,14 +3311,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -3390,14 +3402,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n " + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n " } }, "StartTime": { @@ -3592,7 +3604,7 @@ "Cooldown": { "target": "com.amazonaws.applicationautoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scaling activity to take effect. If\n not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scaling activity to take effect. If\n not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

" } }, "MetricAggregationType": { @@ -3938,13 +3950,13 @@ "ScaleOutCooldown": { "target": "com.amazonaws.applicationautoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.\n For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.\n For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

" } }, "ScaleInCooldown": { "target": "com.amazonaws.applicationautoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale-in activity completes before another\n scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scale-in activity completes before another\n scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

" } }, "DisableScaleIn": { diff --git a/codegen/sdk-codegen/aws-models/cleanrooms.json b/codegen/sdk-codegen/aws-models/cleanrooms.json index 64f22baae13..582e9497e69 100644 --- a/codegen/sdk-codegen/aws-models/cleanrooms.json +++ b/codegen/sdk-codegen/aws-models/cleanrooms.json @@ -22,6 +22,9 @@ { "target": "com.amazonaws.cleanrooms#CollaborationResource" }, + { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationResource" + }, { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationResource" }, @@ -30,6 +33,9 @@ }, { "target": "com.amazonaws.cleanrooms#MembershipResource" + }, + { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateResource" } ], "traits": { @@ -1128,10 +1134,16 @@ "min": 0 } } + }, + "differentialPrivacy": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyConfiguration", + "traits": { + "smithy.api#documentation": "

The differential privacy configuration.

" + } } }, "traits": { - "smithy.api#documentation": "

A type of analysis rule that enables the table owner to approve custom SQL queries on\n their configured tables.

" + "smithy.api#documentation": "

A type of analysis rule that enables the table owner to approve custom SQL queries on\n their configured tables. It supports differential privacy.

" } }, "com.amazonaws.cleanrooms#AnalysisRuleList": { @@ -2067,1508 +2079,3319 @@ "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:collaboration/[\\d\\w-]+$" } }, - "com.amazonaws.cleanrooms#CollaborationDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$" - } - }, - "com.amazonaws.cleanrooms#CollaborationIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" - } - }, - "com.amazonaws.cleanrooms#CollaborationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" - } - }, - "com.amazonaws.cleanrooms#CollaborationQueryLogStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ENABLED", - "value": "ENABLED" - }, - { - "name": "DISABLED", - "value": "DISABLED" - } - ] - } - }, - "com.amazonaws.cleanrooms#CollaborationResource": { - "type": "resource", - "identifiers": { - "CollaborationId": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier" - } - }, - "create": { - "target": "com.amazonaws.cleanrooms#CreateCollaboration" - }, - "read": { - "target": "com.amazonaws.cleanrooms#GetCollaboration" - }, - "update": { - "target": "com.amazonaws.cleanrooms#UpdateCollaboration" - }, - "delete": { - "target": "com.amazonaws.cleanrooms#DeleteCollaboration" - }, - "list": { - "target": "com.amazonaws.cleanrooms#ListCollaborations" - }, - "operations": [ - { - "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate" - }, - { - "target": "com.amazonaws.cleanrooms#BatchGetSchema" - }, - { - "target": "com.amazonaws.cleanrooms#DeleteMember" - }, - { - "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate" - }, - { - "target": "com.amazonaws.cleanrooms#GetSchema" - }, - { - "target": "com.amazonaws.cleanrooms#GetSchemaAnalysisRule" - }, - { - "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplates" - }, - { - "target": "com.amazonaws.cleanrooms#ListMembers" - }, - { - "target": "com.amazonaws.cleanrooms#ListSchemas" - } - ], - "traits": { - "aws.api#arn": { - "template": "collaboration/{CollaborationId}" - }, - "aws.iam#disableConditionKeyInference": {}, - "aws.iam#iamResource": { - "name": "collaboration" - }, - "smithy.api#documentation": "Represents a collaboration between AWS accounts that allows for secure data collaboration" - } - }, - "com.amazonaws.cleanrooms#CollaborationSummary": { + "com.amazonaws.cleanrooms#CollaborationConfiguredAudienceModelAssociation": { "type": "structure", "members": { "id": { - "target": "com.amazonaws.cleanrooms#UUID", + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the collaboration.

", + "smithy.api#documentation": "

The identifier of the configured audience model association.

", "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" + "smithy.api#resourceIdentifier": "ConfiguredAudienceModelAssociationId" } }, "arn": { - "target": "com.amazonaws.cleanrooms#CollaborationArn", + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationArn", "traits": { - "smithy.api#documentation": "

The ARN of the collaboration.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model association.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.cleanrooms#CollaborationName", + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not\n unique.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.

", "smithy.api#required": {} } }, - "creatorAccountId": { - "target": "com.amazonaws.cleanrooms#AccountId", + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", + "smithy.api#documentation": "

The unique ARN for the configured audience model's associated collaboration.

", "smithy.api#required": {} } }, - "creatorDisplayName": { - "target": "com.amazonaws.cleanrooms#DisplayName", + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelArn", "traits": { - "smithy.api#documentation": "

The display name of the collaboration creator.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configure audience model.

", "smithy.api#required": {} } }, - "createTime": { - "target": "smithy.api#Timestamp", + "name": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationName", "traits": { - "smithy.api#documentation": "

The time when the collaboration was created.

", + "smithy.api#documentation": "

The name of the configured audience model association.

", "smithy.api#required": {} } }, - "updateTime": { - "target": "smithy.api#Timestamp", + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", "traits": { - "smithy.api#documentation": "

The time the collaboration metadata was last updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the configured audience model association.

" } }, - "memberStatus": { - "target": "com.amazonaws.cleanrooms#MemberStatus", + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The status of a member in a collaboration.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Only supports AWS account ID.

", "smithy.api#required": {} } }, - "membershipId": { - "target": "com.amazonaws.cleanrooms#UUID", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The identifier of a member in a collaboration.

" + "smithy.api#documentation": "

The time at which the configured audience model association was created.

", + "smithy.api#required": {} } }, - "membershipArn": { - "target": "com.amazonaws.cleanrooms#MembershipArn", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of a member in a collaboration.

" + "smithy.api#documentation": "

The most recent time at which the configured audience model association was updated.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The metadata of the collaboration.

" - } - }, - "com.amazonaws.cleanrooms#CollaborationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#CollaborationSummary" + "smithy.api#documentation": "

The configured audience model association within a collaboration.

" } }, - "com.amazonaws.cleanrooms#Column": { + "com.amazonaws.cleanrooms#CollaborationConfiguredAudienceModelAssociationSummary": { "type": "structure", "members": { + "arn": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model association.

", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the configured audience model association was created.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the configured audience model association.

", + "smithy.api#required": {} + } + }, "name": { - "target": "com.amazonaws.cleanrooms#ColumnName", + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationName", "traits": { - "smithy.api#documentation": "

The name of the column.

", + "smithy.api#documentation": "

The name of the configured audience model association.

", "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.cleanrooms#ColumnTypeString", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The type of the column.

", + "smithy.api#documentation": "

The most recent time at which the configured audience model association was updated.

", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the configured audience model's associated collaboration.

", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.

", + "smithy.api#required": {} + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Only supports AWS account ID.

", "smithy.api#required": {} } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the configured audience model association.

" + } } }, "traits": { - "smithy.api#documentation": "

A column within a schema relation, derived from the underlying Glue\n table.

" + "smithy.api#documentation": "

A summary of the configured audience model association in the collaboration.

" } }, - "com.amazonaws.cleanrooms#ColumnList": { + "com.amazonaws.cleanrooms#CollaborationConfiguredAudienceModelAssociationSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.cleanrooms#Column" + "target": "com.amazonaws.cleanrooms#CollaborationConfiguredAudienceModelAssociationSummary" } }, - "com.amazonaws.cleanrooms#ColumnName": { + "com.amazonaws.cleanrooms#CollaborationDescription": { "type": "string", "traits": { "smithy.api#length": { - "max": 128 + "min": 1, + "max": 255 }, - "smithy.api#pattern": "^[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?$" + "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$" } }, - "com.amazonaws.cleanrooms#ColumnTypeString": { + "com.amazonaws.cleanrooms#CollaborationIdentifier": { "type": "string", "traits": { "smithy.api#length": { - "max": 255 + "min": 36, + "max": 36 }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, - "com.amazonaws.cleanrooms#ConfiguredTable": { + "com.amazonaws.cleanrooms#CollaborationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + } + }, + "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "ConfiguredTableId" + "smithy.api#documentation": "

The unique identifier of the collaboration privacy budget.

", + "smithy.api#required": {} } }, - "arn": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableArn", + "privacyBudgetTemplateId": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", "traits": { - "smithy.api#documentation": "

The unique ARN for the configured table.

", + "smithy.api#documentation": "

The unique identifier of the collaboration privacy budget template.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.cleanrooms#DisplayName", + "privacyBudgetTemplateArn": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateArn", "traits": { - "smithy.api#documentation": "

A name for the configured table.

", + "smithy.api#documentation": "

The ARN of the collaboration privacy budget template.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.cleanrooms#TableDescription", + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A description for the configured table.

" + "smithy.api#documentation": "

The unique identifier of the collaboration that includes this privacy budget.

", + "smithy.api#required": {} } }, - "tableReference": { - "target": "com.amazonaws.cleanrooms#TableReference", + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The Glue table that this configured table represents.

", + "smithy.api#documentation": "

The ARN of the collaboration that includes this privacy budget.

", "smithy.api#required": {} } }, - "createTime": { - "target": "smithy.api#Timestamp", + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The time the configured table was created.

", + "smithy.api#documentation": "

The unique identifier of the account that created this privacy budget.

", "smithy.api#required": {} } }, - "updateTime": { - "target": "smithy.api#Timestamp", + "type": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", "traits": { - "smithy.api#documentation": "

The time the configured table was last updated

", + "smithy.api#documentation": "

The type of privacy budget template.

", "smithy.api#required": {} } }, - "analysisRuleTypes": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The types of analysis rules associated with this configured table. Currently, only one\n analysis rule may be associated with a configured table.

", + "smithy.api#documentation": "

The time at which the privacy budget was created.

", "smithy.api#required": {} } }, - "analysisMethod": { - "target": "com.amazonaws.cleanrooms#AnalysisMethod", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The analysis method for the configured table. The only valid value is currently\n `DIRECT_QUERY`.

", + "smithy.api#documentation": "

The most recent time at which the privacy budget was updated.

", "smithy.api#required": {} } }, - "allowedColumns": { - "target": "com.amazonaws.cleanrooms#AllowedColumnList", + "budget": { + "target": "com.amazonaws.cleanrooms#PrivacyBudget", "traits": { - "smithy.api#documentation": "

The columns within the underlying Glue table that can be utilized within\n collaborations.

", + "smithy.api#documentation": "

The includes epsilon provided and utility in terms of aggregations.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A table that has been configured for use in a collaboration.

" + "smithy.api#documentation": "

A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.

" } }, - "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRule": { + "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetSummary" + } + }, + "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetTemplate": { "type": "structure", "members": { - "configuredTableId": { - "target": "com.amazonaws.cleanrooms#UUID", + "id": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "ConfiguredTableId" + "smithy.api#documentation": "

The unique identifier of the collaboration privacy budget template.

", + "smithy.api#required": {} } }, - "configuredTableArn": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableArn", + "arn": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateArn", "traits": { - "smithy.api#documentation": "

The unique ARN for the configured table.

", + "smithy.api#documentation": "

The ARN of the collaboration privacy budget template.

", "smithy.api#required": {} } }, - "policy": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy", + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The policy that controls SQL query rules.

", + "smithy.api#documentation": "

The unique identifier of the collaboration that includes this collaboration privacy budget template.

", "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The type of configured table analysis rule.

", + "smithy.api#documentation": "

The ARN of the collaboration that includes this collaboration privacy budget template.

", "smithy.api#required": {} } }, - "createTime": { - "target": "smithy.api#Timestamp", + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The time the configured table analysis rule was created.

", + "smithy.api#documentation": "

The unique identifier of the account that created this collaboration privacy budget template.

", "smithy.api#required": {} } }, - "updateTime": { + "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time the configured table analysis rule was last updated.

", + "smithy.api#documentation": "

The time at which the collaboration privacy budget template was created.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

A configured table analysis rule, which limits how data for this table can be\n used.

" - } - }, - "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy": { - "type": "union", - "members": { - "v1": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicyV1", - "traits": { - "smithy.api#documentation": "

Controls on the query specifications that can be run on a configured table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls on the query specifications that can be run on a configured table.

" - } - }, - "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicyV1": { - "type": "union", - "members": { - "list": { - "target": "com.amazonaws.cleanrooms#AnalysisRuleList", - "traits": { - "smithy.api#documentation": "

Analysis rule type that enables only list queries on a configured table.

" - } }, - "aggregation": { - "target": "com.amazonaws.cleanrooms#AnalysisRuleAggregation", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

Analysis rule type that enables only aggregation queries on a configured table.

" + "smithy.api#documentation": "

The most recent time at which the collaboration privacy budget template was updated.

", + "smithy.api#required": {} } }, - "custom": { - "target": "com.amazonaws.cleanrooms#AnalysisRuleCustom" - } - }, - "traits": { - "smithy.api#documentation": "

Controls on the query specifications that can be run on a configured table.

" - } - }, - "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType": { - "type": "enum", - "members": { - "AGGREGATION": { - "target": "smithy.api#Unit", + "privacyBudgetType": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", "traits": { - "smithy.api#enumValue": "AGGREGATION" + "smithy.api#documentation": "

The type of privacy budget template.

", + "smithy.api#required": {} } }, - "LIST": { - "target": "smithy.api#Unit", + "autoRefresh": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateAutoRefresh", "traits": { - "smithy.api#enumValue": "LIST" + "smithy.api#documentation": "

How often the privacy budget refreshes.

\n \n

If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

\n ", + "smithy.api#required": {} } }, - "CUSTOM": { - "target": "smithy.api#Unit", + "parameters": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateParametersOutput", "traits": { - "smithy.api#enumValue": "CUSTOM" + "smithy.api#documentation": "

Specifies the epsilon and noise parameters for the privacy budget template.

", + "smithy.api#required": {} } } - } - }, - "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType" - } - }, - "com.amazonaws.cleanrooms#ConfiguredTableArn": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "max": 100 - }, - "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtable/[\\d\\w-]+$" + "smithy.api#documentation": "

An array that specifies the information for a collaboration's privacy budget template.

" } }, - "com.amazonaws.cleanrooms#ConfiguredTableAssociation": { + "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetTemplateSummary": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn", - "traits": { - "smithy.api#documentation": "

The unique ARN for the configured table association.

", - "smithy.api#required": {} - } - }, "id": { - "target": "com.amazonaws.cleanrooms#UUID", - "traits": { - "smithy.api#documentation": "

The unique ID for the configured table association.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" - } - }, - "configuredTableId": { - "target": "com.amazonaws.cleanrooms#UUID", + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table that the association refers to.

", + "smithy.api#documentation": "

The unique identifier of the collaboration privacy budget template.

", "smithy.api#required": {} } }, - "configuredTableArn": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableArn", + "arn": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateArn", "traits": { - "smithy.api#documentation": "

The unique ARN for the configured table that the association refers to.

", + "smithy.api#documentation": "

The ARN of the collaboration privacy budget template.

", "smithy.api#required": {} } }, - "membershipId": { + "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The unique ID for the membership this configured table association belongs to.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" - } - }, - "membershipArn": { - "target": "com.amazonaws.cleanrooms#MembershipArn", - "traits": { - "smithy.api#documentation": "

The unique ARN for the membership this configured table association belongs to.

", + "smithy.api#documentation": "

The unique identifier of the collaboration that contains this collaboration privacy budget template.

", "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.cleanrooms#RoleArn", + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The service will assume this role to access catalog metadata and query the table.

", + "smithy.api#documentation": "

The ARN of the collaboration that contains this collaboration privacy budget template.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.cleanrooms#TableAlias", + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The name of the configured table association, in lowercase. The table is identified by\n this name when running protected queries against the underlying data.

", + "smithy.api#documentation": "

The unique identifier of the account that created this collaboration privacy budget template.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.cleanrooms#TableDescription", + "privacyBudgetType": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", "traits": { - "smithy.api#documentation": "

A description of the configured table association.

" + "smithy.api#documentation": "

The type of the privacy budget template.

", + "smithy.api#required": {} } }, "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time the configured table association was created.

", + "smithy.api#documentation": "

The time at which the collaboration privacy budget template was created.

", "smithy.api#required": {} } }, "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time the configured table association was last updated.

", + "smithy.api#documentation": "

The most recent time at which the collaboration privacy budget template was updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A configured table association links a configured table to a collaboration.

" + "smithy.api#documentation": "

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.

" } }, - "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 100 - }, - "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtableassociation/[\\d\\w-]+/[\\d\\w-]+$" + "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetTemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetTemplateSummary" } }, - "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier": { + "com.amazonaws.cleanrooms#CollaborationQueryLogStatus": { "type": "string", "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + "smithy.api#enum": [ + { + "name": "ENABLED", + "value": "ENABLED" + }, + { + "name": "DISABLED", + "value": "DISABLED" + } + ] } }, - "com.amazonaws.cleanrooms#ConfiguredTableAssociationResource": { + "com.amazonaws.cleanrooms#CollaborationResource": { "type": "resource", "identifiers": { - "MembershipId": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier" - }, - "ConfiguredTableAssociationId": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier" + "CollaborationId": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier" } }, "create": { - "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociation" + "target": "com.amazonaws.cleanrooms#CreateCollaboration" }, "read": { - "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociation" + "target": "com.amazonaws.cleanrooms#GetCollaboration" }, "update": { - "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociation" + "target": "com.amazonaws.cleanrooms#UpdateCollaboration" }, "delete": { - "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociation" + "target": "com.amazonaws.cleanrooms#DeleteCollaboration" }, "list": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociations" + "target": "com.amazonaws.cleanrooms#ListCollaborations" }, - "traits": { - "aws.api#arn": { - "template": "membership/{MembershipId}/configuredtableassociation/{ConfiguredTableAssociationId}" - }, - "aws.iam#disableConditionKeyInference": {}, - "aws.iam#iamResource": { - "name": "configuredtableassociation" + "operations": [ + { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate" }, - "smithy.api#documentation": "Represents a table that can be queried within a collaboration" - } - }, - "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummary": { - "type": "structure", - "members": { - "configuredTableId": { - "target": "com.amazonaws.cleanrooms#UUID", - "traits": { - "smithy.api#documentation": "

The unique configured table ID that this configured table association refers to.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.cleanrooms#BatchGetSchema" }, - "membershipId": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + { + "target": "com.amazonaws.cleanrooms#DeleteMember" + }, + { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate" + }, + { + "target": "com.amazonaws.cleanrooms#GetCollaborationConfiguredAudienceModelAssociation" + }, + { + "target": "com.amazonaws.cleanrooms#GetCollaborationPrivacyBudgetTemplate" + }, + { + "target": "com.amazonaws.cleanrooms#GetSchema" + }, + { + "target": "com.amazonaws.cleanrooms#GetSchemaAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplates" + }, + { + "target": "com.amazonaws.cleanrooms#ListCollaborationConfiguredAudienceModelAssociations" + }, + { + "target": "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgets" + }, + { + "target": "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetTemplates" + }, + { + "target": "com.amazonaws.cleanrooms#ListMembers" + }, + { + "target": "com.amazonaws.cleanrooms#ListSchemas" + } + ], + "traits": { + "aws.api#arn": { + "template": "collaboration/{CollaborationId}" + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "collaboration" + }, + "smithy.api#documentation": "Represents a collaboration between AWS accounts that allows for secure data collaboration" + } + }, + "com.amazonaws.cleanrooms#CollaborationSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The unique ID for the membership that the configured table association belongs\n to.

", + "smithy.api#documentation": "

The identifier for the collaboration.

", "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" + "smithy.api#resourceIdentifier": "CollaborationId" } }, - "membershipArn": { - "target": "com.amazonaws.cleanrooms#MembershipArn", + "arn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The unique ARN for the membership that the configured table association belongs\n to.

", + "smithy.api#documentation": "

The ARN of the collaboration.

", "smithy.api#required": {} } }, "name": { - "target": "com.amazonaws.cleanrooms#TableAlias", + "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "

The name of the configured table association. The table is identified by this name when\n running Protected Queries against the underlying data.

", + "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not\n unique.

", + "smithy.api#required": {} + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", + "smithy.api#required": {} + } + }, + "creatorDisplayName": { + "target": "com.amazonaws.cleanrooms#DisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the collaboration creator.

", "smithy.api#required": {} } }, "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time the configured table association was created.

", + "smithy.api#documentation": "

The time when the collaboration was created.

", "smithy.api#required": {} } }, "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time the configured table association was last updated.

", + "smithy.api#documentation": "

The time the collaboration metadata was last updated.

", "smithy.api#required": {} } }, - "id": { + "memberStatus": { + "target": "com.amazonaws.cleanrooms#MemberStatus", + "traits": { + "smithy.api#documentation": "

The status of a member in a collaboration.

", + "smithy.api#required": {} + } + }, + "membershipId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table association.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + "smithy.api#documentation": "

The identifier of a member in a collaboration.

" } }, - "arn": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn", + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "

The unique ARN for the configured table association.

", + "smithy.api#documentation": "

The ARN of a member in a collaboration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata of the collaboration.

" + } + }, + "com.amazonaws.cleanrooms#CollaborationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationSummary" + } + }, + "com.amazonaws.cleanrooms#Column": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanrooms#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cleanrooms#ColumnTypeString", + "traits": { + "smithy.api#documentation": "

The type of the column.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The configured table association summary for the objects listed by the request.

" + "smithy.api#documentation": "

A column within a schema relation, derived from the underlying Glue\n table.

" } }, - "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummaryList": { + "com.amazonaws.cleanrooms#ColumnList": { "type": "list", "member": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummary" + "target": "com.amazonaws.cleanrooms#Column" } }, - "com.amazonaws.cleanrooms#ConfiguredTableIdentifier": { + "com.amazonaws.cleanrooms#ColumnName": { "type": "string", "traits": { "smithy.api#length": { - "min": 36, - "max": 36 + "max": 128 }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + "smithy.api#pattern": "^[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?$" } }, - "com.amazonaws.cleanrooms#ConfiguredTableResource": { - "type": "resource", - "identifiers": { - "ConfiguredTableId": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier" - } - }, - "create": { - "target": "com.amazonaws.cleanrooms#CreateConfiguredTable" - }, - "read": { - "target": "com.amazonaws.cleanrooms#GetConfiguredTable" - }, - "update": { - "target": "com.amazonaws.cleanrooms#UpdateConfiguredTable" - }, - "delete": { - "target": "com.amazonaws.cleanrooms#DeleteConfiguredTable" - }, - "list": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTables" - }, - "operations": [ - { - "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRule" - }, - { - "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRule" - }, - { - "target": "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRule" - }, - { - "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAnalysisRule" - } - ], + "com.amazonaws.cleanrooms#ColumnTypeString": { + "type": "string", "traits": { - "aws.api#arn": { - "template": "configuredtable/{ConfiguredTableId}" + "smithy.api#length": { + "max": 255 }, - "aws.iam#disableConditionKeyInference": {}, - "aws.iam#iamResource": { - "name": "configuredtable" + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + } + }, + "com.amazonaws.cleanrooms#ConfiguredAudienceModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 }, - "smithy.api#documentation": "Represents a table that can be associated with collaborations" + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+$" } }, - "com.amazonaws.cleanrooms#ConfiguredTableSummary": { + "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociation": { "type": "structure", "members": { "id": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID of the configured table.

", + "smithy.api#documentation": "

A unique identifier of the configured audience model association.

", "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "ConfiguredTableId" + "smithy.api#resourceIdentifier": "ConfiguredAudienceModelAssociationId" } }, "arn": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableArn", + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationArn", "traits": { - "smithy.api#documentation": "

The unique ARN of the configured table.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model association.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.cleanrooms#DisplayName", + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelArn", "traits": { - "smithy.api#documentation": "

The name of the configured table.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.

", "smithy.api#required": {} } }, - "createTime": { - "target": "smithy.api#Timestamp", + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The time the configured table was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique identifier for the membership that contains this configured audience model association.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" } }, - "updateTime": { - "target": "smithy.api#Timestamp", + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "

The time the configured table was last updated.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the membership that contains this configured audience model association.

", "smithy.api#required": {} } }, - "analysisRuleTypes": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList", + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The types of analysis rules associated with this configured table.

", + "smithy.api#documentation": "

A unique identifier of the collaboration that contains this configured audience model association.

", "smithy.api#required": {} } }, - "analysisMethod": { - "target": "com.amazonaws.cleanrooms#AnalysisMethod", + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently\n `DIRECT_QUERY`.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

The configured table summary for the objects listed by the request.

" - } - }, - "com.amazonaws.cleanrooms#ConfiguredTableSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableSummary", - "traits": { - "smithy.api#documentation": "

The member of the configured table summary list.

" - } - } - }, - "com.amazonaws.cleanrooms#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" }, - "resourceId": { - "target": "smithy.api#String", + "name": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationName", "traits": { - "smithy.api#documentation": "

The ID of the conflicting resource.

" + "smithy.api#documentation": "

The name of the configured audience model association.

", + "smithy.api#required": {} } }, - "resourceType": { - "target": "com.amazonaws.cleanrooms#ResourceType", + "manageResourcePolicies": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The type of the conflicting resource.

" + "smithy.api#documentation": "

When TRUE, 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 FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.

", + "smithy.api#required": {} } }, - "reason": { - "target": "com.amazonaws.cleanrooms#ConflictExceptionReason", + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", "traits": { - "smithy.api#documentation": "

A reason code for the exception.

" + "smithy.api#documentation": "

The description of the configured audience model association.

" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the configured audience model association was created.

", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the configured audience model association was updated.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 + "smithy.api#documentation": "

Details about the configured audience model association.

" } }, - "com.amazonaws.cleanrooms#ConflictExceptionReason": { + "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationArn": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "ALREADY_EXISTS", - "name": "ALREADY_EXISTS" - }, - { - "value": "SUBRESOURCES_EXIST", - "name": "SUBRESOURCES_EXIST" - }, - { - "value": "INVALID_STATE", - "name": "INVALID_STATE" - } - ] + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/configuredaudiencemodelassociation/[\\d\\w-]+$" } }, - "com.amazonaws.cleanrooms#CreateAnalysisTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplateInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplateOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" - }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 }, - { - "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" + "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + } + }, + "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationResource": { + "type": "resource", + "identifiers": { + "MembershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier" }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" + "ConfiguredAudienceModelAssociationId": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationIdentifier" } - ], + }, + "create": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredAudienceModelAssociation" + }, + "read": { + "target": "com.amazonaws.cleanrooms#GetConfiguredAudienceModelAssociation" + }, + "update": { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredAudienceModelAssociation" + }, + "delete": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredAudienceModelAssociation" + }, + "list": { + "target": "com.amazonaws.cleanrooms#ListConfiguredAudienceModelAssociations" + }, "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to create a new analysis template", - "smithy.api#documentation": "

Creates a new analysis template.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/memberships/{membershipIdentifier}/analysistemplates" - } + "aws.api#arn": { + "template": "membership/{MembershipId}/configuredaudiencemodelassociation/{ConfiguredAudienceModelAssociationId}" + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "configuredaudiencemodelassociation" + }, + "smithy.api#documentation": "Represents a configured audience that has been associated with the collaboration" } }, - "com.amazonaws.cleanrooms#CreateAnalysisTemplateInput": { + "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationSummary": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.cleanrooms#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the analysis template.

" - } - }, - "membershipIdentifier": { + "membershipId": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for a membership resource.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

A unique identifier of the membership that contains the configured audience model association.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" } }, - "name": { - "target": "com.amazonaws.cleanrooms#TableAlias", + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "

The name of the analysis template.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the membership that contains the configured audience model association.

", "smithy.api#required": {} } }, - "format": { - "target": "com.amazonaws.cleanrooms#AnalysisFormat", + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The format of the analysis template.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the collaboration that contains the configured audience model association.

", "smithy.api#required": {} } }, - "source": { - "target": "com.amazonaws.cleanrooms#AnalysisSource", + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The information in the analysis template. Currently supports text, the\n query text for the analysis template.

", + "smithy.api#documentation": "

A unique identifier of the collaboration that configured audience model is associated with.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.cleanrooms#TagMap", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + "smithy.api#documentation": "

The time at which the configured audience model association was created.

", + "smithy.api#required": {} } }, - "analysisParameters": { - "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The parameters of the analysis template.

" + "smithy.api#documentation": "

The most recent time at which the configured audience model association was updated.

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.cleanrooms#CreateAnalysisTemplateOutput": { - "type": "structure", - "members": { - "analysisTemplate": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + }, + "id": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The analysis template.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique identifier of the configured audience model association.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredAudienceModelAssociationId" } - } - } - }, - "com.amazonaws.cleanrooms#CreateCollaboration": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#CreateCollaborationInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#CreateCollaborationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" + "arn": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model association.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + "name": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationName", + "traits": { + "smithy.api#documentation": "

The name of the configured audience model association.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the configured audience model association.

" + } } - ], + }, "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to create a new collaboration, a shared data collaboration environment", - "smithy.api#documentation": "

Creates a new collaboration.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/collaborations" - } + "smithy.api#documentation": "

A summary of the configured audience model association.

" } }, - "com.amazonaws.cleanrooms#CreateCollaborationInput": { + "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationSummary" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTable": { "type": "structure", "members": { - "members": { - "target": "com.amazonaws.cleanrooms#MemberList", + "id": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A list of initial members, not including the creator. This list is immutable.

", + "smithy.api#documentation": "

The unique ID for the configured table.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the configured table.

", "smithy.api#required": {} } }, "name": { - "target": "com.amazonaws.cleanrooms#CollaborationName", + "target": "com.amazonaws.cleanrooms#DisplayName", "traits": { - "smithy.api#documentation": "

The display name for a collaboration.

", + "smithy.api#documentation": "

A name for the configured table.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.cleanrooms#CollaborationDescription", + "target": "com.amazonaws.cleanrooms#TableDescription", "traits": { - "smithy.api#documentation": "

A description of the collaboration provided by the collaboration owner.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the configured table.

" } }, - "creatorMemberAbilities": { - "target": "com.amazonaws.cleanrooms#MemberAbilities", + "tableReference": { + "target": "com.amazonaws.cleanrooms#TableReference", "traits": { - "smithy.api#documentation": "

The abilities granted to the collaboration creator.

", + "smithy.api#documentation": "

The Glue table that this configured table represents.

", "smithy.api#required": {} } }, - "creatorDisplayName": { - "target": "com.amazonaws.cleanrooms#DisplayName", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The display name of the collaboration creator.

", + "smithy.api#documentation": "

The time the configured table was created.

", "smithy.api#required": {} } }, - "dataEncryptionMetadata": { - "target": "com.amazonaws.cleanrooms#DataEncryptionMetadata", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The settings for client-side encryption with Cryptographic Computing for Clean\n Rooms.

" + "smithy.api#documentation": "

The time the configured table was last updated

", + "smithy.api#required": {} } }, - "queryLogStatus": { - "target": "com.amazonaws.cleanrooms#CollaborationQueryLogStatus", - "traits": { - "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

", + "analysisRuleTypes": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList", + "traits": { + "smithy.api#documentation": "

The types of analysis rules associated with this configured table. Currently, only one\n analysis rule may be associated with a configured table.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.cleanrooms#TagMap", + "analysisMethod": { + "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + "smithy.api#documentation": "

The analysis method for the configured table. The only valid value is currently\n `DIRECT_QUERY`.

", + "smithy.api#required": {} } }, - "creatorPaymentConfiguration": { - "target": "com.amazonaws.cleanrooms#PaymentConfiguration", - "traits": { - "smithy.api#documentation": "

The collaboration\n creator's payment responsibilities set by the collaboration creator.

\n

If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.

" - } - } - } - }, - "com.amazonaws.cleanrooms#CreateCollaborationOutput": { - "type": "structure", - "members": { - "collaboration": { - "target": "com.amazonaws.cleanrooms#Collaboration", + "allowedColumns": { + "target": "com.amazonaws.cleanrooms#AllowedColumnList", "traits": { - "smithy.api#documentation": "

The entire created collaboration object.

", + "smithy.api#documentation": "

The columns within the underlying Glue table that can be utilized within\n collaborations.

", "smithy.api#required": {} } } - } - }, - "com.amazonaws.cleanrooms#CreateConfiguredTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#CreateConfiguredTableInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#CreateConfiguredTableOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" - }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" - }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to create a new configured table", - "smithy.api#documentation": "

Creates a new configured table resource.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/configuredTables" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRule": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRuleInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRuleOutput" }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" - }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" - }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" - } - ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to create analysis rules for configured tables", - "smithy.api#documentation": "

Creates a new analysis rule for a configured table. Currently, only one analysis rule\n can be created for a given configured table.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/configuredTables/{configuredTableIdentifier}/analysisRule" - }, - "smithy.api#idempotent": {} + "smithy.api#documentation": "

A table that has been configured for use in a collaboration.

" } }, - "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRuleInput": { + "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRule": { "type": "structure", "members": { - "configuredTableIdentifier": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "configuredTableId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the configured table to create the analysis rule for. Currently\n accepts the configured table ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The unique ID for the configured table.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" } }, - "analysisRuleType": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", + "configuredTableArn": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableArn", "traits": { - "smithy.api#documentation": "

The type of analysis rule.

", + "smithy.api#documentation": "

The unique ARN for the configured table.

", "smithy.api#required": {} } }, - "analysisRulePolicy": { + "policy": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy", "traits": { - "smithy.api#documentation": "

The entire created configured table analysis rule object.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRuleOutput": { - "type": "structure", - "members": { - "analysisRule": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRule", - "traits": { - "smithy.api#documentation": "

The entire created analysis rule.

", + "smithy.api#documentation": "

The policy that controls SQL query rules.

", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.cleanrooms#CreateConfiguredTableAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" - }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to link a configured table with a collaboration by creating a new association", - "aws.iam#requiredActions": [ - "iam:PassRole" - ], - "smithy.api#documentation": "

Creates a configured table association. A configured table association links a\n configured table with a collaboration.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations" - } - } - }, - "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationInput": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cleanrooms#TableAlias", + "type": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The name of the configured table association. This name is used to query the underlying\n configured table.

", + "smithy.api#documentation": "

The type of configured table analysis rule.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.cleanrooms#TableDescription", - "traits": { - "smithy.api#documentation": "

A description for the configured table association.

" - } - }, - "membershipIdentifier": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier", - "traits": { - "smithy.api#documentation": "

A unique identifier for one of your memberships for a collaboration. The configured\n table is associated to the collaboration that this membership belongs to. Currently accepts\n a membership ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" - } - }, - "configuredTableIdentifier": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

A unique identifier for the configured table to be associated to. Currently accepts a\n configured table ID.

", + "smithy.api#documentation": "

The time the configured table analysis rule was created.

", "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.cleanrooms#RoleArn", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The service will assume this role to access catalog metadata and query the table.

", + "smithy.api#documentation": "

The time the configured table analysis rule was last updated.

", "smithy.api#required": {} } - }, - "tags": { - "target": "com.amazonaws.cleanrooms#TagMap", - "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" - } } + }, + "traits": { + "smithy.api#documentation": "

A configured table analysis rule, which limits how data for this table can be\n used.

" } }, - "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationOutput": { - "type": "structure", + "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy": { + "type": "union", "members": { - "configuredTableAssociation": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociation", + "v1": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicyV1", "traits": { - "smithy.api#documentation": "

The entire configured table association object.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Controls on the query specifications that can be run on a configured table.

" } } + }, + "traits": { + "smithy.api#documentation": "

Controls on the query specifications that can be run on a configured table.

" } }, - "com.amazonaws.cleanrooms#CreateConfiguredTableInput": { - "type": "structure", + "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicyV1": { + "type": "union", "members": { - "name": { - "target": "com.amazonaws.cleanrooms#DisplayName", + "list": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleList", "traits": { - "smithy.api#documentation": "

The name of the configured table.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Analysis rule type that enables only list queries on a configured table.

" } }, - "description": { - "target": "com.amazonaws.cleanrooms#TableDescription", - "traits": { - "smithy.api#documentation": "

A description for the configured table.

" - } - }, - "tableReference": { - "target": "com.amazonaws.cleanrooms#TableReference", + "aggregation": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleAggregation", "traits": { - "smithy.api#documentation": "

A reference to the Glue table being configured.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Analysis rule type that enables only aggregation queries on a configured table.

" } }, - "allowedColumns": { - "target": "com.amazonaws.cleanrooms#AllowedColumnList", + "custom": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleCustom" + } + }, + "traits": { + "smithy.api#documentation": "

Controls on the query specifications that can be run on a configured table.

" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType": { + "type": "enum", + "members": { + "AGGREGATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The columns of the underlying table that can be used by collaborations or analysis\n rules.

", - "smithy.api#required": {} + "smithy.api#enumValue": "AGGREGATION" } }, - "analysisMethod": { - "target": "com.amazonaws.cleanrooms#AnalysisMethod", + "LIST": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently\n `DIRECT_QUERY`.

", - "smithy.api#required": {} + "smithy.api#enumValue": "LIST" } }, - "tags": { - "target": "com.amazonaws.cleanrooms#TagMap", + "CUSTOM": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + "smithy.api#enumValue": "CUSTOM" } } } }, - "com.amazonaws.cleanrooms#CreateConfiguredTableOutput": { - "type": "structure", - "members": { - "configuredTable": { - "target": "com.amazonaws.cleanrooms#ConfiguredTable", - "traits": { - "smithy.api#documentation": "

The created configured table.

", - "smithy.api#required": {} - } - } + "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType" } }, - "com.amazonaws.cleanrooms#CreateMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#CreateMembershipInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#CreateMembershipOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" - }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" - }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" - } - ], + "com.amazonaws.cleanrooms#ConfiguredTableArn": { + "type": "string", "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to join collaborations by creating a membership", - "smithy.api#documentation": "

Creates a membership for a specific collaboration identifier and joins the\n collaboration.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/memberships" - } + "smithy.api#length": { + "max": 100 + }, + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtable/[\\d\\w-]+$" } }, - "com.amazonaws.cleanrooms#CreateMembershipInput": { + "com.amazonaws.cleanrooms#ConfiguredTableAssociation": { "type": "structure", "members": { - "collaborationIdentifier": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "arn": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn", "traits": { - "smithy.api#documentation": "

The unique ID for the associated collaboration.

", + "smithy.api#documentation": "

The unique ARN for the configured table association.

", "smithy.api#required": {} } }, - "queryLogStatus": { - "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", + "id": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n membership.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unique ID for the configured table association.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" } }, - "tags": { - "target": "com.amazonaws.cleanrooms#TagMap", + "configuredTableId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + "smithy.api#documentation": "

The unique ID for the configured table that the association refers to.

", + "smithy.api#required": {} } }, - "defaultResultConfiguration": { - "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", + "configuredTableArn": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableArn", "traits": { - "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" + "smithy.api#documentation": "

The unique ARN for the configured table that the association refers to.

", + "smithy.api#required": {} } }, - "paymentConfiguration": { - "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member.

\n

Not required if the collaboration member has the member ability to run queries.

\n

Required if the collaboration member doesn't have the member ability to run queries but\n is configured as a payer by the collaboration creator.

" + "smithy.api#documentation": "

The unique ID for the membership this configured table association belongs to.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" } - } - } - }, - "com.amazonaws.cleanrooms#CreateMembershipOutput": { - "type": "structure", - "members": { - "membership": { - "target": "com.amazonaws.cleanrooms#Membership", + }, + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "

The membership that was created.

", + "smithy.api#documentation": "

The unique ARN for the membership this configured table association belongs to.

", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.cleanrooms#DataEncryptionMetadata": { - "type": "structure", - "members": { - "allowCleartext": { - "target": "smithy.api#Boolean", + }, + "roleArn": { + "target": "com.amazonaws.cleanrooms#RoleArn", "traits": { - "smithy.api#documentation": "

Indicates whether encrypted tables can contain cleartext data\n (TRUE)\n or are to cryptographically process every column\n (FALSE).

", + "smithy.api#documentation": "

The service will assume this role to access catalog metadata and query the table.

", "smithy.api#required": {} } }, - "allowDuplicates": { - "target": "smithy.api#Boolean", + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "

Indicates whether Fingerprint columns can contain duplicate entries\n (TRUE)\n or are to contain only non-repeated values\n (FALSE).

", + "smithy.api#documentation": "

The name of the configured table association, in lowercase. The table is identified by\n this name when running protected queries against the underlying data.

", "smithy.api#required": {} } }, - "allowJoinsOnColumnsWithDifferentNames": { - "target": "smithy.api#Boolean", + "description": { + "target": "com.amazonaws.cleanrooms#TableDescription", "traits": { - "smithy.api#documentation": "

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with\n a different name\n (TRUE)\n or can only be joined on Fingerprint columns of the same name\n (FALSE).

", + "smithy.api#documentation": "

A description of the configured table association.

" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the configured table association was created.

", "smithy.api#required": {} } }, - "preserveNulls": { - "target": "smithy.api#Boolean", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates whether NULL values are to be copied as NULL to encrypted tables\n (TRUE)\n or cryptographically processed\n (FALSE).

", + "smithy.api#documentation": "

The time the configured table association was last updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The settings for client-side encryption for cryptographic computing.

" + "smithy.api#documentation": "

A configured table association links a configured table to a collaboration.

" } }, - "com.amazonaws.cleanrooms#DeleteAnalysisTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplateInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplateOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" - }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" + "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 100 }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" - } - ], + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtableassociation/[\\d\\w-]+/[\\d\\w-]+$" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier": { + "type": "string", "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to remove an analysis template from a collaboration", - "smithy.api#documentation": "

Deletes an analysis template.

", - "smithy.api#http": { - "code": 204, - "method": "DELETE", - "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + "smithy.api#length": { + "min": 36, + "max": 36 }, - "smithy.api#idempotent": {} + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, - "com.amazonaws.cleanrooms#DeleteAnalysisTemplateInput": { - "type": "structure", - "members": { - "membershipIdentifier": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier", - "traits": { - "smithy.api#documentation": "

The identifier for a membership resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" - } + "com.amazonaws.cleanrooms#ConfiguredTableAssociationResource": { + "type": "resource", + "identifiers": { + "MembershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier" }, - "analysisTemplateIdentifier": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "ConfiguredTableAssociationId": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier" + } + }, + "create": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociation" + }, + "read": { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociation" + }, + "update": { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAssociation" + }, + "delete": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociation" + }, + "list": { + "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociations" + }, + "traits": { + "aws.api#arn": { + "template": "membership/{MembershipId}/configuredtableassociation/{ConfiguredTableAssociationId}" + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "configuredtableassociation" + }, + "smithy.api#documentation": "Represents a table that can be queried within a collaboration" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummary": { + "type": "structure", + "members": { + "configuredTableId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The unique configured table ID that this configured table association refers to.

", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The unique ID for the membership that the configured table association belongs\n to.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the membership that the configured table association belongs\n to.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", + "traits": { + "smithy.api#documentation": "

The name of the configured table association. The table is identified by this name when\n running Protected Queries against the underlying data.

", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the configured table association was created.

", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the configured table association was last updated.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID for the configured table association.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the configured table association.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configured table association summary for the objects listed by the request.

" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummary" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableResource": { + "type": "resource", + "identifiers": { + "ConfiguredTableId": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier" + } + }, + "create": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTable" + }, + "read": { + "target": "com.amazonaws.cleanrooms#GetConfiguredTable" + }, + "update": { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredTable" + }, + "delete": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTable" + }, + "list": { + "target": "com.amazonaws.cleanrooms#ListConfiguredTables" + }, + "operations": [ + { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRule" + }, + { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredTableAnalysisRule" + } + ], + "traits": { + "aws.api#arn": { + "template": "configuredtable/{ConfiguredTableId}" + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "configuredtable" + }, + "smithy.api#documentation": "Represents a table that can be associated with collaborations" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "traits": { + "smithy.api#documentation": "

The unique ID of the configured table.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableArn", + "traits": { + "smithy.api#documentation": "

The unique ARN of the configured table.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#DisplayName", + "traits": { + "smithy.api#documentation": "

The name of the configured table.

", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the configured table was created.

", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the configured table was last updated.

", + "smithy.api#required": {} + } + }, + "analysisRuleTypes": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList", + "traits": { + "smithy.api#documentation": "

The types of analysis rules associated with this configured table.

", + "smithy.api#required": {} + } + }, + "analysisMethod": { + "target": "com.amazonaws.cleanrooms#AnalysisMethod", + "traits": { + "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently\n `DIRECT_QUERY`.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configured table summary for the objects listed by the request.

" + } + }, + "com.amazonaws.cleanrooms#ConfiguredTableSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableSummary", + "traits": { + "smithy.api#documentation": "

The member of the configured table summary list.

" + } + } + }, + "com.amazonaws.cleanrooms#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the conflicting resource.

" + } + }, + "resourceType": { + "target": "com.amazonaws.cleanrooms#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of the conflicting resource.

" + } + }, + "reason": { + "target": "com.amazonaws.cleanrooms#ConflictExceptionReason", + "traits": { + "smithy.api#documentation": "

A reason code for the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cleanrooms#ConflictExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALREADY_EXISTS", + "name": "ALREADY_EXISTS" + }, + { + "value": "SUBRESOURCES_EXIST", + "name": "SUBRESOURCES_EXIST" + }, + { + "value": "INVALID_STATE", + "name": "INVALID_STATE" + } + ] + } + }, + "com.amazonaws.cleanrooms#CreateAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a new analysis template", + "smithy.api#documentation": "

Creates a new analysis template.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/analysistemplates" + } + } + }, + "com.amazonaws.cleanrooms#CreateAnalysisTemplateInput": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the analysis template.

" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", + "traits": { + "smithy.api#documentation": "

The name of the analysis template.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.cleanrooms#AnalysisFormat", + "traits": { + "smithy.api#documentation": "

The format of the analysis template.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.cleanrooms#AnalysisSource", + "traits": { + "smithy.api#documentation": "

The information in the analysis template. Currently supports text, the\n query text for the analysis template.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + } + }, + "analysisParameters": { + "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "traits": { + "smithy.api#documentation": "

The parameters of the analysis template.

" + } + } + } + }, + "com.amazonaws.cleanrooms#CreateAnalysisTemplateOutput": { + "type": "structure", + "members": { + "analysisTemplate": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + "traits": { + "smithy.api#documentation": "

The analysis template.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#CreateCollaboration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateCollaborationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateCollaborationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a new collaboration, a shared data collaboration environment", + "smithy.api#documentation": "

Creates a new collaboration.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/collaborations" + } + } + }, + "com.amazonaws.cleanrooms#CreateCollaborationInput": { + "type": "structure", + "members": { + "members": { + "target": "com.amazonaws.cleanrooms#MemberList", + "traits": { + "smithy.api#documentation": "

A list of initial members, not including the creator. This list is immutable.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#CollaborationName", + "traits": { + "smithy.api#documentation": "

The display name for a collaboration.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#CollaborationDescription", + "traits": { + "smithy.api#documentation": "

A description of the collaboration provided by the collaboration owner.

", + "smithy.api#required": {} + } + }, + "creatorMemberAbilities": { + "target": "com.amazonaws.cleanrooms#MemberAbilities", + "traits": { + "smithy.api#documentation": "

The abilities granted to the collaboration creator.

", + "smithy.api#required": {} + } + }, + "creatorDisplayName": { + "target": "com.amazonaws.cleanrooms#DisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the collaboration creator.

", + "smithy.api#required": {} + } + }, + "dataEncryptionMetadata": { + "target": "com.amazonaws.cleanrooms#DataEncryptionMetadata", + "traits": { + "smithy.api#documentation": "

The settings for client-side encryption with Cryptographic Computing for Clean\n Rooms.

" + } + }, + "queryLogStatus": { + "target": "com.amazonaws.cleanrooms#CollaborationQueryLogStatus", + "traits": { + "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + } + }, + "creatorPaymentConfiguration": { + "target": "com.amazonaws.cleanrooms#PaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The collaboration\n creator's payment responsibilities set by the collaboration creator.

\n

If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.

" + } + } + } + }, + "com.amazonaws.cleanrooms#CreateCollaborationOutput": { + "type": "structure", + "members": { + "collaboration": { + "target": "com.amazonaws.cleanrooms#Collaboration", + "traits": { + "smithy.api#documentation": "

The entire created collaboration object.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredAudienceModelAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredAudienceModelAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredAudienceModelAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to link a configured audience model with a collaboration by creating a new association", + "smithy.api#documentation": "

Provides the details necessary to create a configured audience model association.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/configuredaudiencemodelassociations" + } + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredAudienceModelAssociationInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for one of your memberships for a collaboration. The configured\n audience model is associated to the collaboration that this membership belongs to. Accepts\n a membership ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the configured audience model that you want to associate.

", + "smithy.api#required": {} + } + }, + "configuredAudienceModelAssociationName": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationName", + "traits": { + "smithy.api#documentation": "

The name of the configured audience model association.

", + "smithy.api#required": {} + } + }, + "manageResourcePolicies": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

When TRUE, 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 FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.

\n

Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and specify TRUE, you must have the same permissions when you call the DeleteMember and DeleteCollaboration APIs.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

A description of the configured audience model association.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredAudienceModelAssociationOutput": { + "type": "structure", + "members": { + "configuredAudienceModelAssociation": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociation", + "traits": { + "smithy.api#documentation": "

Information about the configured audience model association.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a new configured table", + "smithy.api#documentation": "

Creates a new configured table resource.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configuredTables" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRuleInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create analysis rules for configured tables", + "smithy.api#documentation": "

Creates a new analysis rule for a configured table. Currently, only one analysis rule\n can be created for a given configured table.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configuredTables/{configuredTableIdentifier}/analysisRule" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRuleInput": { + "type": "structure", + "members": { + "configuredTableIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for the configured table to create the analysis rule for. Currently\n accepts the configured table ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableId" + } + }, + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", + "traits": { + "smithy.api#documentation": "

The type of analysis rule.

", + "smithy.api#required": {} + } + }, + "analysisRulePolicy": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy", + "traits": { + "smithy.api#documentation": "

The entire created configured table analysis rule object.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAnalysisRuleOutput": { + "type": "structure", + "members": { + "analysisRule": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRule", + "traits": { + "smithy.api#documentation": "

The entire created analysis rule.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to link a configured table with a collaboration by creating a new association", + "aws.iam#requiredActions": [ + "iam:PassRole" + ], + "smithy.api#documentation": "

Creates a configured table association. A configured table association links a\n configured table with a collaboration.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations" + } + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", + "traits": { + "smithy.api#documentation": "

The name of the configured table association. This name is used to query the underlying\n configured table.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#TableDescription", + "traits": { + "smithy.api#documentation": "

A description for the configured table association.

" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for one of your memberships for a collaboration. The configured\n table is associated to the collaboration that this membership belongs to. Currently accepts\n a membership ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "configuredTableIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the configured table to be associated to. Currently accepts a\n configured table ID.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanrooms#RoleArn", + "traits": { + "smithy.api#documentation": "

The service will assume this role to access catalog metadata and query the table.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + } + } + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableAssociationOutput": { + "type": "structure", + "members": { + "configuredTableAssociation": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociation", + "traits": { + "smithy.api#documentation": "

The entire configured table association object.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanrooms#DisplayName", + "traits": { + "smithy.api#documentation": "

The name of the configured table.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#TableDescription", + "traits": { + "smithy.api#documentation": "

A description for the configured table.

" + } + }, + "tableReference": { + "target": "com.amazonaws.cleanrooms#TableReference", + "traits": { + "smithy.api#documentation": "

A reference to the Glue table being configured.

", + "smithy.api#required": {} + } + }, + "allowedColumns": { + "target": "com.amazonaws.cleanrooms#AllowedColumnList", + "traits": { + "smithy.api#documentation": "

The columns of the underlying table that can be used by collaborations or analysis\n rules.

", + "smithy.api#required": {} + } + }, + "analysisMethod": { + "target": "com.amazonaws.cleanrooms#AnalysisMethod", + "traits": { + "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently\n `DIRECT_QUERY`.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + } + } + } + }, + "com.amazonaws.cleanrooms#CreateConfiguredTableOutput": { + "type": "structure", + "members": { + "configuredTable": { + "target": "com.amazonaws.cleanrooms#ConfiguredTable", + "traits": { + "smithy.api#documentation": "

The created configured table.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#CreateMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateMembershipInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateMembershipOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to join collaborations by creating a membership", + "smithy.api#documentation": "

Creates a membership for a specific collaboration identifier and joins the\n collaboration.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships" + } + } + }, + "com.amazonaws.cleanrooms#CreateMembershipInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

The unique ID for the associated collaboration.

", + "smithy.api#required": {} + } + }, + "queryLogStatus": { + "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", + "traits": { + "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n membership.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + } + }, + "defaultResultConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", + "traits": { + "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" + } + }, + "paymentConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member.

\n

Not required if the collaboration member has the member ability to run queries.

\n

Required if the collaboration member doesn't have the member ability to run queries but\n is configured as a payer by the collaboration creator.

" + } + } + } + }, + "com.amazonaws.cleanrooms#CreateMembershipOutput": { + "type": "structure", + "members": { + "membership": { + "target": "com.amazonaws.cleanrooms#Membership", + "traits": { + "smithy.api#documentation": "

The membership that was created.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#CreatePrivacyBudgetTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreatePrivacyBudgetTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreatePrivacyBudgetTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a new privacy budget template", + "smithy.api#documentation": "

Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/privacybudgettemplates" + } + } + }, + "com.amazonaws.cleanrooms#CreatePrivacyBudgetTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "membershipIdentifier" + } + }, + "autoRefresh": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateAutoRefresh", + "traits": { + "smithy.api#documentation": "

How often the privacy budget refreshes.

\n \n

If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

\n ", + "smithy.api#required": {} + } + }, + "privacyBudgetType": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", + "traits": { + "smithy.api#documentation": "

Specifies the type of the privacy budget template.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateParametersInput", + "traits": { + "smithy.api#documentation": "

Specifies your parameters for the privacy budget template.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#CreatePrivacyBudgetTemplateOutput": { + "type": "structure", + "members": { + "privacyBudgetTemplate": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplate", + "traits": { + "smithy.api#documentation": "

A summary of the elements in the privacy budget template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#DataEncryptionMetadata": { + "type": "structure", + "members": { + "allowCleartext": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether encrypted tables can contain cleartext data\n (TRUE)\n or are to cryptographically process every column\n (FALSE).

", + "smithy.api#required": {} + } + }, + "allowDuplicates": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether Fingerprint columns can contain duplicate entries\n (TRUE)\n or are to contain only non-repeated values\n (FALSE).

", + "smithy.api#required": {} + } + }, + "allowJoinsOnColumnsWithDifferentNames": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with\n a different name\n (TRUE)\n or can only be joined on Fingerprint columns of the same name\n (FALSE).

", + "smithy.api#required": {} + } + }, + "preserveNulls": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether NULL values are to be copied as NULL to encrypted tables\n (TRUE)\n or cryptographically processed\n (FALSE).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for client-side encryption for cryptographic computing.

" + } + }, + "com.amazonaws.cleanrooms#DeleteAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to remove an analysis template from a collaboration", + "smithy.api#documentation": "

Deletes an analysis template.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteAnalysisTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "analysisTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for the analysis template resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" + } + } + } + }, + "com.amazonaws.cleanrooms#DeleteAnalysisTemplateOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.cleanrooms#DeleteCollaboration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteCollaborationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteCollaborationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete an existing collaboration", + "smithy.api#documentation": "

Deletes a collaboration. It can only be called by the collaboration owner.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/collaborations/{collaborationIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteCollaborationInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for the collaboration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + } + } + }, + "com.amazonaws.cleanrooms#DeleteCollaborationOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.cleanrooms#DeleteConfiguredAudienceModelAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredAudienceModelAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredAudienceModelAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to remove a configured audience model association from a collaboration", + "smithy.api#documentation": "

Provides the information necessary to delete a configured audience model association.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredAudienceModelAssociationInput": { + "type": "structure", + "members": { + "configuredAudienceModelAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier of the configured audience model association that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredAudienceModelAssociationId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier of the membership that contains the audience model association that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredAudienceModelAssociationOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a configured table", + "smithy.api#documentation": "

Deletes a configured table.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/configuredTables/{configuredTableIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRuleInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete an existing analysis rule", + "smithy.api#documentation": "

Deletes a configured table analysis rule.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/configuredTables/{configuredTableIdentifier}/analysisRule/{analysisRuleType}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRuleInput": { + "type": "structure", + "members": { + "configuredTableIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for the configured table that the analysis rule applies to.\n Currently accepts the configured table ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableId" + } + }, + "analysisRuleType": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", + "traits": { + "smithy.api#documentation": "

The analysis rule type to be deleted. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRuleOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty response that indicates a successful delete.

" + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to remove a configured table association from a collaboration", + "smithy.api#documentation": "

Deletes a configured table association.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationInput": { + "type": "structure", + "members": { + "configuredTableAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "traits": { + "smithy.api#documentation": "

The unique ID for the configured table association to be deleted. Currently accepts the\n configured table ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableInput": { + "type": "structure", + "members": { + "configuredTableIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "traits": { + "smithy.api#documentation": "

The unique ID for the configured table to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredTableId" + } + } + } + }, + "com.amazonaws.cleanrooms#DeleteConfiguredTableOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The empty output for a successful deletion.

" + } + }, + "com.amazonaws.cleanrooms#DeleteMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteMemberInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteMemberOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete members from a collaboration", + "smithy.api#documentation": "

Removes the specified member from a collaboration. The removed member is placed in the\n Removed status and can't interact with the collaboration. The removed member's data is\n inaccessible to active members of the collaboration.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/collaborations/{collaborationIdentifier}/member/{accountId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteMemberInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for the associated collaboration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "accountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the member to remove.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#DeleteMemberOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.cleanrooms#DeleteMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteMembershipInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteMembershipOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to leave collaborations by deleting a membership", + "smithy.api#documentation": "

Deletes a specified membership. All resources under a membership must be deleted.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteMembershipInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + } + }, + "com.amazonaws.cleanrooms#DeleteMembershipOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.cleanrooms#DeletePrivacyBudgetTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeletePrivacyBudgetTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeletePrivacyBudgetTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to remove a privacy budget from a collaboration", + "smithy.api#documentation": "

Deletes a privacy budget template for a specified membership.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeletePrivacyBudgetTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "privacyBudgetTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for your privacy budget template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "PrivacyBudgetTemplateId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#DeletePrivacyBudgetTemplateOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyAggregationExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyAggregationType": { + "type": "enum", + "members": { + "AVG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVG" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "COUNT_DISTINCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT_DISTINCT" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "STDDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDDEV" + } + } + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyColumn": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyColumn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyConfiguration": { + "type": "structure", + "members": { + "columns": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyColumnList", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the unique identifier for your users.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyParameters": { + "type": "structure", + "members": { + "sensitivityParameters": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacySensitivityParametersList", + "traits": { + "smithy.api#documentation": "

Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An array that contains the sensitivity parameters.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyPreviewAggregation": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyAggregationType", + "traits": { + "smithy.api#documentation": "

The type of aggregation function.

", + "smithy.api#required": {} + } + }, + "maxCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of aggregations that the member who can query can run given the epsilon and noise parameters.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyPreviewAggregationList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyPreviewAggregation" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyPreviewParametersInput": { + "type": "structure", + "members": { + "epsilon": { + "target": "com.amazonaws.cleanrooms#Epsilon", + "traits": { + "smithy.api#documentation": "

The epsilon value that you want to preview.

", + "smithy.api#required": {} + } + }, + "usersNoisePerQuery": { + "target": "com.amazonaws.cleanrooms#UsersNoisePerQuery", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The epsilon and noise parameters that you want to preview.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyPrivacyBudget": { + "type": "structure", + "members": { + "aggregations": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyPrivacyBudgetAggregationList", + "traits": { + "smithy.api#documentation": "

This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.

", + "smithy.api#required": {} + } + }, + "epsilon": { + "target": "com.amazonaws.cleanrooms#Epsilon", + "traits": { + "smithy.api#documentation": "

The epsilon value that you configured.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations available.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyPrivacyBudgetAggregation": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyAggregationType", + "traits": { + "smithy.api#documentation": "

The different types of aggregation functions that you can perform.

", + "smithy.api#required": {} + } + }, + "maxCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of aggregation functions that you can perform with the given privacy budget.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "remainingCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The remaining number of aggregation functions that can be run with the available privacy budget.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the total number of aggregations, as well as the remaining aggregations.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyPrivacyBudgetAggregationList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyPrivacyBudgetAggregation" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyPrivacyImpact": { + "type": "structure", + "members": { + "aggregations": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyPreviewAggregationList", + "traits": { + "smithy.api#documentation": "

The number of aggregation functions that you can perform.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacySensitivityParameters": { + "type": "structure", + "members": { + "aggregationType": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyAggregationType", + "traits": { + "smithy.api#documentation": "

The type of aggregation function that was run.

", + "smithy.api#required": {} + } + }, + "aggregationExpression": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyAggregationExpression", + "traits": { + "smithy.api#documentation": "

The aggregation expression that was run.

", + "smithy.api#required": {} + } + }, + "userContributionLimit": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of rows contributed by a user in a SQL query.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "minColumnValue": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "

The lower bound of the aggregation expression.

" + } + }, + "maxColumnValue": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "

The upper bound of the aggregation expression.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the sensitivity parameters.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacySensitivityParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacySensitivityParameters" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyTemplateParametersInput": { + "type": "structure", + "members": { + "epsilon": { + "target": "com.amazonaws.cleanrooms#Epsilon", + "traits": { + "smithy.api#documentation": "

The epsilon value that you want to use.

", + "smithy.api#required": {} + } + }, + "usersNoisePerQuery": { + "target": "com.amazonaws.cleanrooms#UsersNoisePerQuery", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The epsilon and noise parameter values that you want to use for the differential privacy template.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyTemplateParametersOutput": { + "type": "structure", + "members": { + "epsilon": { + "target": "com.amazonaws.cleanrooms#Epsilon", + "traits": { + "smithy.api#documentation": "

The epsilon value that you specified.

", + "smithy.api#required": {} + } + }, + "usersNoisePerQuery": { + "target": "com.amazonaws.cleanrooms#UsersNoisePerQuery", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The epsilon and noise parameter values that were used for the differential privacy template.

" + } + }, + "com.amazonaws.cleanrooms#DifferentialPrivacyTemplateUpdateParameters": { + "type": "structure", + "members": { + "epsilon": { + "target": "com.amazonaws.cleanrooms#Epsilon", + "traits": { + "smithy.api#documentation": "

The updated epsilon value that you want to use.

" + } + }, + "usersNoisePerQuery": { + "target": "com.amazonaws.cleanrooms#UsersNoisePerQuery", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The epsilon and noise parameter values that you want to update in the differential privacy template.

" + } + }, + "com.amazonaws.cleanrooms#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + } + }, + "com.amazonaws.cleanrooms#Epsilon": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.cleanrooms#FilterableMemberStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "INVITED", + "value": "INVITED" + }, + { + "name": "ACTIVE", + "value": "ACTIVE" + } + ] + } + }, + "com.amazonaws.cleanrooms#GetAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template", + "smithy.api#documentation": "

Retrieves an analysis template.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetAnalysisTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "analysisTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", "traits": { "smithy.api#documentation": "

The identifier for the analysis template resource.

", "smithy.api#httpLabel": {}, @@ -3578,17 +5401,232 @@ } } }, - "com.amazonaws.cleanrooms#DeleteAnalysisTemplateOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.cleanrooms#DeleteCollaboration": { + "com.amazonaws.cleanrooms#GetAnalysisTemplateOutput": { + "type": "structure", + "members": { + "analysisTemplate": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + "traits": { + "smithy.api#documentation": "

The analysis template.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#GetCollaboration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetCollaborationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetCollaborationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to view details of a collaboration", + "smithy.api#documentation": "

Returns metadata about a collaboration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template within a collaboration", + "smithy.api#documentation": "

Retrieves an analysis template within a collaboration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/analysistemplates/{analysisTemplateArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "analysisTemplateArn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateArn" + } + } + } + }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput": { + "type": "structure", + "members": { + "collaborationAnalysisTemplate": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate", + "traits": { + "smithy.api#documentation": "

The analysis template within a collaboration.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#GetCollaborationConfiguredAudienceModelAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetCollaborationConfiguredAudienceModelAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetCollaborationConfiguredAudienceModelAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get a configured audience model within a collaboration", + "smithy.api#documentation": "

Retrieves a configured audience model association within a collaboration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationConfiguredAudienceModelAssociationInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "configuredAudienceModelAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the configured audience model association that you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredAudienceModelAssociationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationConfiguredAudienceModelAssociationOutput": { + "type": "structure", + "members": { + "collaborationConfiguredAudienceModelAssociation": { + "target": "com.amazonaws.cleanrooms#CollaborationConfiguredAudienceModelAssociation", + "traits": { + "smithy.api#documentation": "

The metadata of the configured audience model association.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for the collaboration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + } + } + }, + "com.amazonaws.cleanrooms#GetCollaborationOutput": { + "type": "structure", + "members": { + "collaboration": { + "target": "com.amazonaws.cleanrooms#Collaboration", + "traits": { + "smithy.api#documentation": "

The entire collaboration for this identifier.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#GetCollaborationPrivacyBudgetTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#DeleteCollaborationInput" + "target": "com.amazonaws.cleanrooms#GetCollaborationPrivacyBudgetTemplateInput" }, "output": { - "target": "com.amazonaws.cleanrooms#DeleteCollaborationOutput" + "target": "com.amazonaws.cleanrooms#GetCollaborationPrivacyBudgetTemplateOutput" }, "errors": [ { @@ -3597,6 +5635,9 @@ { "target": "com.amazonaws.cleanrooms#InternalServerException" }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, { "target": "com.amazonaws.cleanrooms#ThrottlingException" }, @@ -3605,48 +5646,145 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete an existing collaboration", - "smithy.api#documentation": "

Deletes a collaboration. It can only be called by the collaboration owner.

", + "aws.iam#actionPermissionDescription": "Grants permission to get a privacy budget template within a collaboration", + "smithy.api#documentation": "

Returns details about a specified privacy budget template.

", "smithy.api#http": { - "code": 204, - "method": "DELETE", - "uri": "/collaborations/{collaborationIdentifier}" + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}" }, - "smithy.api#idempotent": {} + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#DeleteCollaborationInput": { + "com.amazonaws.cleanrooms#GetCollaborationPrivacyBudgetTemplateInput": { "type": "structure", "members": { "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the collaboration.

", + "smithy.api#documentation": "

A unique identifier for one of your collaborations.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" } + }, + "privacyBudgetTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for one of your privacy budget templates.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "PrivacyBudgetTemplateId" + } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#DeleteCollaborationOutput": { + "com.amazonaws.cleanrooms#GetCollaborationPrivacyBudgetTemplateOutput": { "type": "structure", - "members": {} + "members": { + "collaborationPrivacyBudgetTemplate": { + "target": "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetTemplate", + "traits": { + "smithy.api#documentation": "

Returns the details of the privacy budget template that you requested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "com.amazonaws.cleanrooms#DeleteConfiguredTable": { + "com.amazonaws.cleanrooms#GetConfiguredAudienceModelAssociation": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableInput" + "target": "com.amazonaws.cleanrooms#GetConfiguredAudienceModelAssociationInput" }, "output": { - "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableOutput" + "target": "com.amazonaws.cleanrooms#GetConfiguredAudienceModelAssociationOutput" }, "errors": [ { "target": "com.amazonaws.cleanrooms#AccessDeniedException" }, { - "target": "com.amazonaws.cleanrooms#ConflictException" + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to view details of a configured audience model association", + "smithy.api#documentation": "

Returns information about a configured audience model association.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetConfiguredAudienceModelAssociationInput": { + "type": "structure", + "members": { + "configuredAudienceModelAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the configured audience model association that you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredAudienceModelAssociationId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the membership that contains the configured audience model association that you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#GetConfiguredAudienceModelAssociationOutput": { + "type": "structure", + "members": { + "configuredAudienceModelAssociation": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociation", + "traits": { + "smithy.api#documentation": "

Information about the configured audience model association that you requested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#GetConfiguredTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetConfiguredTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" }, { "target": "com.amazonaws.cleanrooms#InternalServerException" @@ -3662,31 +5800,28 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete a configured table", - "smithy.api#documentation": "

Deletes a configured table.

", + "aws.iam#actionPermissionDescription": "Grants permission to view details for a configured table", + "smithy.api#documentation": "

Retrieves a configured table.

", "smithy.api#http": { - "code": 204, - "method": "DELETE", + "code": 200, + "method": "GET", "uri": "/configuredTables/{configuredTableIdentifier}" }, - "smithy.api#idempotent": {} + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRule": { + "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRule": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRuleInput" + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRuleInput" }, "output": { - "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRuleOutput" + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRuleOutput" }, "errors": [ { "target": "com.amazonaws.cleanrooms#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, { "target": "com.amazonaws.cleanrooms#InternalServerException" }, @@ -3701,23 +5836,23 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete an existing analysis rule", - "smithy.api#documentation": "

Deletes a configured table analysis rule.

", + "aws.iam#actionPermissionDescription": "Grants permission to get analysis rules for a configured table", + "smithy.api#documentation": "

Retrieves a configured table analysis rule.

", "smithy.api#http": { - "code": 204, - "method": "DELETE", + "code": 200, + "method": "GET", "uri": "/configuredTables/{configuredTableIdentifier}/analysisRule/{analysisRuleType}" }, - "smithy.api#idempotent": {} + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRuleInput": { + "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRuleInput": { "type": "structure", "members": { "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier for the configured table that the analysis rule applies to.\n Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The unique identifier for the configured table to retrieve. Currently accepts the\n configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -3726,35 +5861,37 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The analysis rule type to be deleted. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", + "smithy.api#documentation": "

The analysis rule to be retrieved. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#DeleteConfiguredTableAnalysisRuleOutput": { + "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRuleOutput": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

An empty response that indicates a successful delete.

" + "members": { + "analysisRule": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRule", + "traits": { + "smithy.api#documentation": "

The entire analysis rule output.

", + "smithy.api#required": {} + } + } } }, - "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociation": { + "com.amazonaws.cleanrooms#GetConfiguredTableAssociation": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationInput" + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationInput" }, "output": { - "target": "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationOutput" + "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationOutput" }, "errors": [ { "target": "com.amazonaws.cleanrooms#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, { "target": "com.amazonaws.cleanrooms#InternalServerException" }, @@ -3769,23 +5906,23 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to remove a configured table association from a collaboration", - "smithy.api#documentation": "

Deletes a configured table association.

", + "aws.iam#actionPermissionDescription": "Grants permission to view details of a configured table association", + "smithy.api#documentation": "

Retrieves a configured table association.

", "smithy.api#http": { - "code": 204, - "method": "DELETE", + "code": 200, + "method": "GET", "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}" }, - "smithy.api#idempotent": {} + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationInput": { + "com.amazonaws.cleanrooms#GetConfiguredTableAssociationInput": { "type": "structure", "members": { "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table association to be deleted. Currently accepts the\n configured table ID.

", + "smithy.api#documentation": "

The unique ID for the configured table association to retrieve. Currently accepts the\n configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -3802,17 +5939,25 @@ } } }, - "com.amazonaws.cleanrooms#DeleteConfiguredTableAssociationOutput": { + "com.amazonaws.cleanrooms#GetConfiguredTableAssociationOutput": { "type": "structure", - "members": {} + "members": { + "configuredTableAssociation": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociation", + "traits": { + "smithy.api#documentation": "

The entire configured table association object.

", + "smithy.api#required": {} + } + } + } }, - "com.amazonaws.cleanrooms#DeleteConfiguredTableInput": { + "com.amazonaws.cleanrooms#GetConfiguredTableInput": { "type": "structure", "members": { "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table to delete.

", + "smithy.api#documentation": "

The unique ID for the configured table to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -3820,28 +5965,30 @@ } } }, - "com.amazonaws.cleanrooms#DeleteConfiguredTableOutput": { + "com.amazonaws.cleanrooms#GetConfiguredTableOutput": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The empty output for a successful deletion.

" + "members": { + "configuredTable": { + "target": "com.amazonaws.cleanrooms#ConfiguredTable", + "traits": { + "smithy.api#documentation": "

The retrieved configured table.

", + "smithy.api#required": {} + } + } } }, - "com.amazonaws.cleanrooms#DeleteMember": { + "com.amazonaws.cleanrooms#GetMembership": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#DeleteMemberInput" + "target": "com.amazonaws.cleanrooms#GetMembershipInput" }, "output": { - "target": "com.amazonaws.cleanrooms#DeleteMemberOutput" + "target": "com.amazonaws.cleanrooms#GetMembershipOutput" }, "errors": [ { "target": "com.amazonaws.cleanrooms#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, { "target": "com.amazonaws.cleanrooms#InternalServerException" }, @@ -3856,57 +6003,54 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete members from a collaboration", - "smithy.api#documentation": "

Removes the specified member from a collaboration. The removed member is placed in the\n Removed status and can't interact with the collaboration. The removed member's data is\n inaccessible to active members of the collaboration.

", + "aws.iam#actionPermissionDescription": "Grants permission to view details about a membership", + "smithy.api#documentation": "

Retrieves a specified membership for an identifier.

", "smithy.api#http": { - "code": 204, - "method": "DELETE", - "uri": "/collaborations/{collaborationIdentifier}/member/{accountId}" + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}" }, - "smithy.api#idempotent": {} + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#DeleteMemberInput": { + "com.amazonaws.cleanrooms#GetMembershipInput": { "type": "structure", "members": { - "collaborationIdentifier": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier for the associated collaboration.

", + "smithy.api#documentation": "

The identifier for a membership resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" + "smithy.api#resourceIdentifier": "MembershipId" } - }, - "accountId": { - "target": "com.amazonaws.cleanrooms#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID of the member to remove.

", - "smithy.api#httpLabel": {}, + } + } + }, + "com.amazonaws.cleanrooms#GetMembershipOutput": { + "type": "structure", + "members": { + "membership": { + "target": "com.amazonaws.cleanrooms#Membership", + "traits": { + "smithy.api#documentation": "

The membership retrieved for the provided identifier.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#DeleteMemberOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.cleanrooms#DeleteMembership": { + "com.amazonaws.cleanrooms#GetPrivacyBudgetTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#DeleteMembershipInput" + "target": "com.amazonaws.cleanrooms#GetPrivacyBudgetTemplateInput" }, "output": { - "target": "com.amazonaws.cleanrooms#DeleteMembershipOutput" + "target": "com.amazonaws.cleanrooms#GetPrivacyBudgetTemplateOutput" }, "errors": [ { "target": "com.amazonaws.cleanrooms#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanrooms#ConflictException" - }, { "target": "com.amazonaws.cleanrooms#InternalServerException" }, @@ -3921,66 +6065,64 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to leave collaborations by deleting a membership", - "smithy.api#documentation": "

Deletes a specified membership. All resources under a membership must be deleted.

", + "aws.iam#actionPermissionDescription": "Grants permission to get a privacy budget template", + "smithy.api#documentation": "

Returns details for a specified privacy budget template.

", "smithy.api#http": { - "code": 204, - "method": "DELETE", - "uri": "/memberships/{membershipIdentifier}" + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}" }, - "smithy.api#idempotent": {} + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#DeleteMembershipInput": { + "com.amazonaws.cleanrooms#GetPrivacyBudgetTemplateInput": { "type": "structure", "members": { "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#documentation": "

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.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" } + }, + "privacyBudgetTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for your privacy budget template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "PrivacyBudgetTemplateId" + } } - } - }, - "com.amazonaws.cleanrooms#DeleteMembershipOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.cleanrooms#DisplayName": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#FilterableMemberStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "INVITED", - "value": "INVITED" - }, - { - "name": "ACTIVE", - "value": "ACTIVE" + "com.amazonaws.cleanrooms#GetPrivacyBudgetTemplateOutput": { + "type": "structure", + "members": { + "privacyBudgetTemplate": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplate", + "traits": { + "smithy.api#documentation": "

Returns the details of the privacy budget template that you requested.

", + "smithy.api#required": {} } - ] + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cleanrooms#GetAnalysisTemplate": { + "com.amazonaws.cleanrooms#GetProtectedQuery": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetAnalysisTemplateInput" + "target": "com.amazonaws.cleanrooms#GetProtectedQueryInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetAnalysisTemplateOutput" + "target": "com.amazonaws.cleanrooms#GetProtectedQueryOutput" }, "errors": [ { @@ -4000,58 +6142,57 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template", - "smithy.api#documentation": "

Retrieves an analysis template.

", + "aws.iam#actionPermissionDescription": "Grants permission to get a protected query", + "smithy.api#documentation": "

Returns query processing metadata.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + "uri": "/memberships/{membershipIdentifier}/protectedQueries/{protectedQueryIdentifier}" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetAnalysisTemplateInput": { + "com.amazonaws.cleanrooms#GetProtectedQueryInput": { "type": "structure", "members": { "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#documentation": "

The identifier for a membership in a protected query instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" } }, - "analysisTemplateIdentifier": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "protectedQueryIdentifier": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the analysis template resource.

", + "smithy.api#documentation": "

The identifier for a protected query instance.

", "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AnalysisTemplateId" + "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#GetAnalysisTemplateOutput": { + "com.amazonaws.cleanrooms#GetProtectedQueryOutput": { "type": "structure", "members": { - "analysisTemplate": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + "protectedQuery": { + "target": "com.amazonaws.cleanrooms#ProtectedQuery", "traits": { - "smithy.api#documentation": "

The analysis template.

", + "smithy.api#documentation": "

The query processing metadata.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#GetCollaboration": { + "com.amazonaws.cleanrooms#GetSchema": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetCollaborationInput" + "target": "com.amazonaws.cleanrooms#GetSchemaInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetCollaborationOutput" + "target": "com.amazonaws.cleanrooms#GetSchemaOutput" }, "errors": [ { @@ -4060,6 +6201,9 @@ { "target": "com.amazonaws.cleanrooms#InternalServerException" }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, { "target": "com.amazonaws.cleanrooms#ThrottlingException" }, @@ -4068,23 +6212,23 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to view details of a collaboration", - "smithy.api#documentation": "

Returns metadata about a collaboration.

", + "aws.iam#actionPermissionDescription": "Grants permission to view details of a schema", + "smithy.api#documentation": "

Retrieves the schema for a relation within a collaboration.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/collaborations/{collaborationIdentifier}" + "uri": "/collaborations/{collaborationIdentifier}/schemas/{name}" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate": { + "com.amazonaws.cleanrooms#GetSchemaAnalysisRule": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput" + "target": "com.amazonaws.cleanrooms#GetSchemaAnalysisRuleInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput" + "target": "com.amazonaws.cleanrooms#GetSchemaAnalysisRuleOutput" }, "errors": [ { @@ -4104,120 +6248,199 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template within a collaboration", - "smithy.api#documentation": "

Retrieves an analysis template within a collaboration.

", + "aws.iam#actionPermissionDescription": "Grants permission to view analysis rules associated with a schema", + "smithy.api#documentation": "

Retrieves a schema analysis rule.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/collaborations/{collaborationIdentifier}/analysistemplates/{analysisTemplateArn}" + "uri": "/collaborations/{collaborationIdentifier}/schemas/{name}/analysisRule/{type}" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput": { + "com.amazonaws.cleanrooms#GetSchemaAnalysisRuleInput": { "type": "structure", "members": { "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the schema belongs to. Currently accepts\n a collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" } }, - "analysisTemplateArn": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.

", + "smithy.api#documentation": "

The name of the schema to retrieve the analysis rule for.

", "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AnalysisTemplateArn" + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleType", + "traits": { + "smithy.api#documentation": "

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely\n identified by a combination of the collaboration, the schema name, and their type.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput": { + "com.amazonaws.cleanrooms#GetSchemaAnalysisRuleOutput": { "type": "structure", "members": { - "collaborationAnalysisTemplate": { - "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate", + "analysisRule": { + "target": "com.amazonaws.cleanrooms#AnalysisRule", "traits": { - "smithy.api#documentation": "

The analysis template within a collaboration.

", + "smithy.api#documentation": "

A specification about how data from the configured table can be used.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#GetCollaborationInput": { + "com.amazonaws.cleanrooms#GetSchemaInput": { "type": "structure", "members": { "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the collaboration.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the schema belongs to. Currently accepts\n a collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" } + }, + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", + "traits": { + "smithy.api#documentation": "

The name of the relation to retrieve the schema for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, - "com.amazonaws.cleanrooms#GetCollaborationOutput": { + "com.amazonaws.cleanrooms#GetSchemaOutput": { "type": "structure", "members": { - "collaboration": { - "target": "com.amazonaws.cleanrooms#Collaboration", + "schema": { + "target": "com.amazonaws.cleanrooms#Schema", "traits": { - "smithy.api#documentation": "

The entire collaboration for this identifier.

", + "smithy.api#documentation": "

The entire schema object.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#GetConfiguredTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#GetConfiguredTableInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#GetConfiguredTableOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" + "com.amazonaws.cleanrooms#GlueDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$" + } + }, + "com.amazonaws.cleanrooms#GlueTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + } + }, + "com.amazonaws.cleanrooms#GlueTableReference": { + "type": "structure", + "members": { + "tableName": { + "target": "com.amazonaws.cleanrooms#GlueTableName", + "traits": { + "smithy.api#documentation": "

The name of the Glue table.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" + "databaseName": { + "target": "com.amazonaws.cleanrooms#GlueDatabaseName", + "traits": { + "smithy.api#documentation": "

The name of the database the Glue table belongs to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A reference to a table within an Glue data catalog.

" + } + }, + "com.amazonaws.cleanrooms#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

Unexpected error during processing of request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.cleanrooms#JoinOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "OR", + "value": "OR" + }, + { + "name": "AND", + "value": "AND" + } + ] + } + }, + "com.amazonaws.cleanrooms#JoinOperatorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#JoinOperator" + }, + "traits": { + "smithy.api#length": { + "max": 2 } - ], + } + }, + "com.amazonaws.cleanrooms#JoinRequiredOption": { + "type": "string", "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to view details for a configured table", - "smithy.api#documentation": "

Retrieves a configured table.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/configuredTables/{configuredTableIdentifier}" + "smithy.api#enum": [ + { + "name": "QUERY_RUNNER", + "value": "QUERY_RUNNER" + } + ] + } + }, + "com.amazonaws.cleanrooms#KeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 }, - "smithy.api#readonly": {} + "smithy.api#pattern": "^[\\w!.=*/-]*$" } }, - "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRule": { + "com.amazonaws.cleanrooms#ListAnalysisTemplates": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRuleInput" + "target": "com.amazonaws.cleanrooms#ListAnalysisTemplatesInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRuleOutput" + "target": "com.amazonaws.cleanrooms#ListAnalysisTemplatesOutput" }, "errors": [ { @@ -4237,57 +6460,71 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to get analysis rules for a configured table", - "smithy.api#documentation": "

Retrieves a configured table analysis rule.

", + "aws.iam#actionPermissionDescription": "Grants permission to list analysis templates", + "smithy.api#documentation": "

Lists analysis templates that the caller owns.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/configuredTables/{configuredTableIdentifier}/analysisRule/{analysisRuleType}" + "uri": "/memberships/{membershipIdentifier}/analysistemplates" + }, + "smithy.api#paginated": { + "items": "analysisTemplateSummaries" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRuleInput": { + "com.amazonaws.cleanrooms#ListAnalysisTemplatesInput": { "type": "structure", "members": { - "configuredTableIdentifier": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier for the configured table to retrieve. Currently accepts the\n configured table ID.

", + "smithy.api#documentation": "

The identifier for a membership resource.

", "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "ConfiguredTableId" + "smithy.api#required": {} } }, - "analysisRuleType": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The analysis rule to be retrieved. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" } } } }, - "com.amazonaws.cleanrooms#GetConfiguredTableAnalysisRuleOutput": { + "com.amazonaws.cleanrooms#ListAnalysisTemplatesOutput": { "type": "structure", "members": { - "analysisRule": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRule", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The entire analysis rule output.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + } + }, + "analysisTemplateSummaries": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateSummaryList", + "traits": { + "smithy.api#documentation": "

Lists analysis template metadata.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#GetConfiguredTableAssociation": { + "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplates": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationInput" + "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetConfiguredTableAssociationOutput" + "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesOutput" }, "errors": [ { @@ -4307,84 +6544,72 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to view details of a configured table association", - "smithy.api#documentation": "

Retrieves a configured table association.

", + "aws.iam#actionPermissionDescription": "Grants permission to list analysis templates within a collaboration", + "smithy.api#documentation": "

Lists analysis templates within a collaboration.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}" + "uri": "/collaborations/{collaborationIdentifier}/analysistemplates" + }, + "smithy.api#paginated": { + "items": "collaborationAnalysisTemplateSummaries" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetConfiguredTableAssociationInput": { + "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesInput": { "type": "structure", "members": { - "configuredTableAssociationIdentifier": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table association to retrieve. Currently accepts the\n configured table ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" + "smithy.api#resourceIdentifier": "CollaborationId" } }, - "membershipIdentifier": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#httpQuery": "nextToken" } - } - } - }, - "com.amazonaws.cleanrooms#GetConfiguredTableAssociationOutput": { - "type": "structure", - "members": { - "configuredTableAssociation": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociation", + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The entire configured table association object.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" } } } }, - "com.amazonaws.cleanrooms#GetConfiguredTableInput": { + "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesOutput": { "type": "structure", "members": { - "configuredTableIdentifier": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "ConfiguredTableId" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } - } - } - }, - "com.amazonaws.cleanrooms#GetConfiguredTableOutput": { - "type": "structure", - "members": { - "configuredTable": { - "target": "com.amazonaws.cleanrooms#ConfiguredTable", + }, + "collaborationAnalysisTemplateSummaries": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummaryList", "traits": { - "smithy.api#documentation": "

The retrieved configured table.

", + "smithy.api#documentation": "

The metadata of the analysis template within a collaboration.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#GetMembership": { + "com.amazonaws.cleanrooms#ListCollaborationConfiguredAudienceModelAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetMembershipInput" + "target": "com.amazonaws.cleanrooms#ListCollaborationConfiguredAudienceModelAssociationsInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetMembershipOutput" + "target": "com.amazonaws.cleanrooms#ListCollaborationConfiguredAudienceModelAssociationsOutput" }, "errors": [ { @@ -4404,49 +6629,81 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to view details about a membership", - "smithy.api#documentation": "

Retrieves a specified membership for an identifier.

", + "aws.iam#actionPermissionDescription": "Grants permission to list configured audience associations within a collaboration", + "smithy.api#documentation": "

Lists configured audience model associations within a collaboration.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/memberships/{membershipIdentifier}" + "uri": "/collaborations/{collaborationIdentifier}/configuredaudiencemodelassociations" + }, + "smithy.api#paginated": { + "items": "collaborationConfiguredAudienceModelAssociationSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetMembershipInput": { + "com.amazonaws.cleanrooms#ListCollaborationConfiguredAudienceModelAssociationsInput": { "type": "structure", "members": { - "membershipIdentifier": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#GetMembershipOutput": { + "com.amazonaws.cleanrooms#ListCollaborationConfiguredAudienceModelAssociationsOutput": { "type": "structure", "members": { - "membership": { - "target": "com.amazonaws.cleanrooms#Membership", + "collaborationConfiguredAudienceModelAssociationSummaries": { + "target": "com.amazonaws.cleanrooms#CollaborationConfiguredAudienceModelAssociationSummaryList", "traits": { - "smithy.api#documentation": "

The membership retrieved for the provided identifier.

", + "smithy.api#documentation": "

The metadata of the configured audience model association within a collaboration.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cleanrooms#GetProtectedQuery": { + "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetTemplates": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetProtectedQueryInput" + "target": "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetTemplatesInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetProtectedQueryOutput" + "target": "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetTemplatesOutput" }, "errors": [ { @@ -4466,57 +6723,81 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to get a protected query", - "smithy.api#documentation": "

Returns query processing metadata.

", + "aws.iam#actionPermissionDescription": "Grants permission to list collaboration privacy budget templates", + "smithy.api#documentation": "

Returns an array that summarizes each privacy budget template in a specified collaboration.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/memberships/{membershipIdentifier}/protectedQueries/{protectedQueryIdentifier}" + "uri": "/collaborations/{collaborationIdentifier}/privacybudgettemplates" + }, + "smithy.api#paginated": { + "items": "collaborationPrivacyBudgetTemplateSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetProtectedQueryInput": { + "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetTemplatesInput": { "type": "structure", "members": { - "membershipIdentifier": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for a membership in a protected query instance.

", + "smithy.api#documentation": "

A unique identifier for one of your collaborations.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" + "smithy.api#resourceIdentifier": "CollaborationId" } }, - "protectedQueryIdentifier": { - "target": "com.amazonaws.cleanrooms#ProtectedQueryIdentifier", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The identifier for a protected query instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#GetProtectedQueryOutput": { + "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetTemplatesOutput": { "type": "structure", "members": { - "protectedQuery": { - "target": "com.amazonaws.cleanrooms#ProtectedQuery", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The query processing metadata.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + } + }, + "collaborationPrivacyBudgetTemplateSummaries": { + "target": "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetTemplateSummaryList", + "traits": { + "smithy.api#documentation": "

An array that summarizes the collaboration privacy budget templates. The summary includes collaboration information, creation information, the privacy budget type.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cleanrooms#GetSchema": { + "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgets": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetSchemaInput" + "target": "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetsInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetSchemaOutput" + "target": "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetsOutput" }, "errors": [ { @@ -4536,23 +6817,89 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to view details of a schema", - "smithy.api#documentation": "

Retrieves the schema for a relation within a collaboration.

", + "aws.iam#actionPermissionDescription": "Grants permission to list collaboration privacy budgets", + "smithy.api#documentation": "

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.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/collaborations/{collaborationIdentifier}/schemas/{name}" + "uri": "/collaborations/{collaborationIdentifier}/privacybudgets" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "collaborationPrivacyBudgetSummaries" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetSchemaAnalysisRule": { + "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetsInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for one of your collaborations.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "privacyBudgetType": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", + "traits": { + "smithy.api#documentation": "

Specifies the type of the privacy budget.

", + "smithy.api#httpQuery": "privacyBudgetType", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#ListCollaborationPrivacyBudgetsOutput": { + "type": "structure", + "members": { + "collaborationPrivacyBudgetSummaries": { + "target": "com.amazonaws.cleanrooms#CollaborationPrivacyBudgetSummaryList", + "traits": { + "smithy.api#documentation": "

Summaries of the collaboration privacy budgets.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#ListCollaborations": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetSchemaAnalysisRuleInput" + "target": "com.amazonaws.cleanrooms#ListCollaborationsInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetSchemaAnalysisRuleOutput" + "target": "com.amazonaws.cleanrooms#ListCollaborationsOutput" }, "errors": [ { @@ -4561,9 +6908,6 @@ { "target": "com.amazonaws.cleanrooms#InternalServerException" }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" - }, { "target": "com.amazonaws.cleanrooms#ThrottlingException" }, @@ -4572,199 +6916,163 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to view analysis rules associated with a schema", - "smithy.api#documentation": "

Retrieves a schema analysis rule.

", + "aws.iam#actionPermissionDescription": "Grants permission to list available collaborations", + "smithy.api#documentation": "

Lists collaborations the caller owns, is active in, or has been invited to.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/collaborations/{collaborationIdentifier}/schemas/{name}/analysisRule/{type}" + "uri": "/collaborations" + }, + "smithy.api#paginated": { + "items": "collaborationList" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetSchemaAnalysisRuleInput": { + "com.amazonaws.cleanrooms#ListCollaborationsInput": { "type": "structure", "members": { - "collaborationIdentifier": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the schema belongs to. Currently accepts\n a collaboration ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#httpQuery": "nextToken" } }, - "name": { - "target": "com.amazonaws.cleanrooms#TableAlias", + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The name of the schema to retrieve the analysis rule for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#httpQuery": "maxResults" } }, - "type": { - "target": "com.amazonaws.cleanrooms#AnalysisRuleType", - "traits": { - "smithy.api#documentation": "

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely\n identified by a combination of the collaboration, the schema name, and their type.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.cleanrooms#GetSchemaAnalysisRuleOutput": { - "type": "structure", - "members": { - "analysisRule": { - "target": "com.amazonaws.cleanrooms#AnalysisRule", + "memberStatus": { + "target": "com.amazonaws.cleanrooms#FilterableMemberStatus", "traits": { - "smithy.api#documentation": "

A specification about how data from the configured table can be used.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The caller's status in a collaboration.

", + "smithy.api#httpQuery": "memberStatus" } } } }, - "com.amazonaws.cleanrooms#GetSchemaInput": { + "com.amazonaws.cleanrooms#ListCollaborationsOutput": { "type": "structure", "members": { - "collaborationIdentifier": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the schema belongs to. Currently accepts\n a collaboration ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, - "name": { - "target": "com.amazonaws.cleanrooms#TableAlias", + "collaborationList": { + "target": "com.amazonaws.cleanrooms#CollaborationSummaryList", "traits": { - "smithy.api#documentation": "

The name of the relation to retrieve the schema for.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The list of collaborations.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#GetSchemaOutput": { - "type": "structure", - "members": { - "schema": { - "target": "com.amazonaws.cleanrooms#Schema", - "traits": { - "smithy.api#documentation": "

The entire schema object.

", - "smithy.api#required": {} - } + "com.amazonaws.cleanrooms#ListConfiguredAudienceModelAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListConfiguredAudienceModelAssociationsInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListConfiguredAudienceModelAssociationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" } - } - }, - "com.amazonaws.cleanrooms#GlueDatabaseName": { - "type": "string", + ], "traits": { - "smithy.api#length": { - "max": 128 + "aws.iam#actionPermissionDescription": "Grants permission to list available configured audience model associations for a membership", + "smithy.api#documentation": "

Lists information about requested configured audience model associations.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/configuredaudiencemodelassociations" }, - "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$" - } - }, - "com.amazonaws.cleanrooms#GlueTableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 128 + "smithy.api#paginated": { + "items": "configuredAudienceModelAssociationSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" }, - "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GlueTableReference": { + "com.amazonaws.cleanrooms#ListConfiguredAudienceModelAssociationsInput": { "type": "structure", "members": { - "tableName": { - "target": "com.amazonaws.cleanrooms#GlueTableName", + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

The name of the Glue table.

", + "smithy.api#documentation": "

A unique identifier for a membership that contains the configured audience model associations that you want to retrieve.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "databaseName": { - "target": "com.amazonaws.cleanrooms#GlueDatabaseName", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The name of the database the Glue table belongs to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A reference to a table within an Glue data catalog.

" - } - }, - "com.amazonaws.cleanrooms#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

Unexpected error during processing of request.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.cleanrooms#JoinOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "OR", - "value": "OR" - }, - { - "name": "AND", - "value": "AND" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" } - ] - } - }, - "com.amazonaws.cleanrooms#JoinOperatorsList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#JoinOperator" + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#httpQuery": "maxResults" + } + } }, "traits": { - "smithy.api#length": { - "max": 2 - } + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#JoinRequiredOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "QUERY_RUNNER", - "value": "QUERY_RUNNER" + "com.amazonaws.cleanrooms#ListConfiguredAudienceModelAssociationsOutput": { + "type": "structure", + "members": { + "configuredAudienceModelAssociationSummaries": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationSummaryList", + "traits": { + "smithy.api#documentation": "

Summaries of the configured audience model associations that you requested.

", + "smithy.api#required": {} } - ] - } - }, - "com.amazonaws.cleanrooms#KeyPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 }, - "smithy.api#pattern": "^[\\w!.=*/-]*$" + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value provided to access the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cleanrooms#ListAnalysisTemplates": { + "com.amazonaws.cleanrooms#ListConfiguredTableAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListAnalysisTemplatesInput" + "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListAnalysisTemplatesOutput" + "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsOutput" }, "errors": [ { @@ -4784,26 +7092,26 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list analysis templates", - "smithy.api#documentation": "

Lists analysis templates that the caller owns.

", + "aws.iam#actionPermissionDescription": "Grants permission to list available configured table associations for a membership", + "smithy.api#documentation": "

Lists configured table associations for a membership.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/memberships/{membershipIdentifier}/analysistemplates" + "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations" }, "smithy.api#paginated": { - "items": "analysisTemplateSummaries" + "items": "configuredTableAssociationSummaries" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#ListAnalysisTemplatesInput": { + "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsInput": { "type": "structure", "members": { "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#documentation": "

A unique identifier for the membership to list configured table associations for.\n Currently accepts the membership ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4824,31 +7132,104 @@ } } }, - "com.amazonaws.cleanrooms#ListAnalysisTemplatesOutput": { + "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsOutput": { "type": "structure", "members": { + "configuredTableAssociationSummaries": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummaryList", + "traits": { + "smithy.api#documentation": "

The retrieved list of configured table associations.

", + "smithy.api#required": {} + } + }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } + } + } + }, + "com.amazonaws.cleanrooms#ListConfiguredTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListConfiguredTablesInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListConfiguredTablesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list available configured tables", + "smithy.api#documentation": "

Lists configured tables.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configuredTables" + }, + "smithy.api#paginated": { + "items": "configuredTableSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListConfiguredTablesInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", + "smithy.api#httpQuery": "nextToken" + } }, - "analysisTemplateSummaries": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplateSummaryList", + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

Lists analysis template metadata.

", + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.cleanrooms#ListConfiguredTablesOutput": { + "type": "structure", + "members": { + "configuredTableSummaries": { + "target": "com.amazonaws.cleanrooms#ConfiguredTableSummaryList", + "traits": { + "smithy.api#documentation": "

The configured tables listed by the request.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + } } } }, - "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplates": { + "com.amazonaws.cleanrooms#ListMembers": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesInput" + "target": "com.amazonaws.cleanrooms#ListMembersInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesOutput" + "target": "com.amazonaws.cleanrooms#ListMembersOutput" }, "errors": [ { @@ -4868,26 +7249,26 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list analysis templates within a collaboration", - "smithy.api#documentation": "

Lists analysis templates within a collaboration.

", + "aws.iam#actionPermissionDescription": "Grants permission to list the members of a collaboration", + "smithy.api#documentation": "

Lists all members within a collaboration.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/collaborations/{collaborationIdentifier}/analysistemplates" + "uri": "/collaborations/{collaborationIdentifier}/members" }, "smithy.api#paginated": { - "items": "collaborationAnalysisTemplateSummaries" + "items": "memberSummaries" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesInput": { + "com.amazonaws.cleanrooms#ListMembersInput": { "type": "structure", "members": { "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", + "smithy.api#documentation": "

The identifier of the collaboration in which the members are listed.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -4909,7 +7290,7 @@ } } }, - "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesOutput": { + "com.amazonaws.cleanrooms#ListMembersOutput": { "type": "structure", "members": { "nextToken": { @@ -4918,22 +7299,22 @@ "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, - "collaborationAnalysisTemplateSummaries": { - "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummaryList", + "memberSummaries": { + "target": "com.amazonaws.cleanrooms#MemberSummaryList", "traits": { - "smithy.api#documentation": "

The metadata of the analysis template within a collaboration.

", + "smithy.api#documentation": "

The list of members returned by the ListMembers operation.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#ListCollaborations": { + "com.amazonaws.cleanrooms#ListMemberships": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListCollaborationsInput" + "target": "com.amazonaws.cleanrooms#ListMembershipsInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListCollaborationsOutput" + "target": "com.amazonaws.cleanrooms#ListMembershipsOutput" }, "errors": [ { @@ -4950,20 +7331,20 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list available collaborations", - "smithy.api#documentation": "

Lists collaborations the caller owns, is active in, or has been invited to.

", + "aws.iam#actionPermissionDescription": "Grants permission to list available memberships", + "smithy.api#documentation": "

Lists all memberships resources within the caller's account.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/collaborations" + "uri": "/memberships" }, "smithy.api#paginated": { - "items": "collaborationList" + "items": "membershipSummaries" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#ListCollaborationsInput": { + "com.amazonaws.cleanrooms#ListMembershipsInput": { "type": "structure", "members": { "nextToken": { @@ -4976,20 +7357,20 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", "smithy.api#httpQuery": "maxResults" } }, - "memberStatus": { - "target": "com.amazonaws.cleanrooms#FilterableMemberStatus", + "status": { + "target": "com.amazonaws.cleanrooms#MembershipStatus", "traits": { - "smithy.api#documentation": "

The caller's status in a collaboration.

", - "smithy.api#httpQuery": "memberStatus" + "smithy.api#documentation": "

A filter which will return only memberships in the specified status.

", + "smithy.api#httpQuery": "status" } } } }, - "com.amazonaws.cleanrooms#ListCollaborationsOutput": { + "com.amazonaws.cleanrooms#ListMembershipsOutput": { "type": "structure", "members": { "nextToken": { @@ -4998,22 +7379,22 @@ "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, - "collaborationList": { - "target": "com.amazonaws.cleanrooms#CollaborationSummaryList", + "membershipSummaries": { + "target": "com.amazonaws.cleanrooms#MembershipSummaryList", "traits": { - "smithy.api#documentation": "

The list of collaborations.

", + "smithy.api#documentation": "

The list of memberships returned from the ListMemberships operation.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#ListConfiguredTableAssociations": { + "com.amazonaws.cleanrooms#ListPrivacyBudgetTemplates": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsInput" + "target": "com.amazonaws.cleanrooms#ListPrivacyBudgetTemplatesInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsOutput" + "target": "com.amazonaws.cleanrooms#ListPrivacyBudgetTemplatesOutput" }, "errors": [ { @@ -5033,26 +7414,29 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list available configured table associations for a membership", - "smithy.api#documentation": "

Lists configured table associations for a membership.

", + "aws.iam#actionPermissionDescription": "Grants permission to list privacy budget templates", + "smithy.api#documentation": "

Returns detailed information about the privacy budget templates in a specified membership.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/memberships/{membershipIdentifier}/configuredTableAssociations" + "uri": "/memberships/{membershipIdentifier}/privacybudgettemplates" }, "smithy.api#paginated": { - "items": "configuredTableAssociationSummaries" + "items": "privacyBudgetTemplateSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsInput": { + "com.amazonaws.cleanrooms#ListPrivacyBudgetTemplatesInput": { "type": "structure", "members": { "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the membership to list configured table associations for.\n Currently accepts the membership ID.

", + "smithy.api#documentation": "

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.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5067,37 +7451,43 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#ListConfiguredTableAssociationsOutput": { + "com.amazonaws.cleanrooms#ListPrivacyBudgetTemplatesOutput": { "type": "structure", "members": { - "configuredTableAssociationSummaries": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationSummaryList", - "traits": { - "smithy.api#documentation": "

The retrieved list of configured table associations.

", - "smithy.api#required": {} - } - }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } + }, + "privacyBudgetTemplateSummaries": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateSummaryList", + "traits": { + "smithy.api#documentation": "

An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.

", + "smithy.api#required": {} + } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cleanrooms#ListConfiguredTables": { + "com.amazonaws.cleanrooms#ListPrivacyBudgets": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTablesInput" + "target": "com.amazonaws.cleanrooms#ListPrivacyBudgetsInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListConfiguredTablesOutput" + "target": "com.amazonaws.cleanrooms#ListPrivacyBudgetsOutput" }, "errors": [ { @@ -5106,6 +7496,9 @@ { "target": "com.amazonaws.cleanrooms#InternalServerException" }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, { "target": "com.amazonaws.cleanrooms#ThrottlingException" }, @@ -5114,22 +7507,42 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list available configured tables", - "smithy.api#documentation": "

Lists configured tables.

", + "aws.iam#actionPermissionDescription": "List Privacy Budgets", + "smithy.api#documentation": "

Returns detailed information about the privacy budgets in a specified membership.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/configuredTables" + "uri": "/memberships/{membershipIdentifier}/privacybudgets" }, "smithy.api#paginated": { - "items": "configuredTableSummaries" + "items": "privacyBudgetSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListPrivacyBudgetsInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "privacyBudgetType": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", + "traits": { + "smithy.api#documentation": "

The privacy budget type.

", + "smithy.api#httpQuery": "privacyBudgetType", + "smithy.api#required": {} + } }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.cleanrooms#ListConfiguredTablesInput": { - "type": "structure", - "members": { "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { @@ -5140,19 +7553,22 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service may return a nextToken even if the maximum results has not\n been met.

", "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#ListConfiguredTablesOutput": { + "com.amazonaws.cleanrooms#ListPrivacyBudgetsOutput": { "type": "structure", "members": { - "configuredTableSummaries": { - "target": "com.amazonaws.cleanrooms#ConfiguredTableSummaryList", + "privacyBudgetSummaries": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetSummaryList", "traits": { - "smithy.api#documentation": "

The configured tables listed by the request.

", + "smithy.api#documentation": "

An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.

", "smithy.api#required": {} } }, @@ -5162,15 +7578,18 @@ "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cleanrooms#ListMembers": { + "com.amazonaws.cleanrooms#ListProtectedQueries": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListMembersInput" + "target": "com.amazonaws.cleanrooms#ListProtectedQueriesInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListMembersOutput" + "target": "com.amazonaws.cleanrooms#ListProtectedQueriesOutput" }, "errors": [ { @@ -5190,29 +7609,38 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list the members of a collaboration", - "smithy.api#documentation": "

Lists all members within a collaboration.

", + "aws.iam#actionPermissionDescription": "Grants permission to list protected queries", + "smithy.api#documentation": "

Lists protected queries, sorted by the most recent query.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/collaborations/{collaborationIdentifier}/members" + "uri": "/memberships/{membershipIdentifier}/protectedQueries" }, "smithy.api#paginated": { - "items": "memberSummaries" + "items": "protectedQueries", + "inputToken": "nextToken", + "outputToken": "nextToken" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#ListMembersInput": { + "com.amazonaws.cleanrooms#ListProtectedQueriesInput": { "type": "structure", "members": { - "collaborationIdentifier": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the collaboration in which the members are listed.

", + "smithy.api#documentation": "

The identifier for the membership in the collaboration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "status": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryStatus", + "traits": { + "smithy.api#documentation": "

A filter on the status of the protected query.

", + "smithy.api#httpQuery": "status" } }, "nextToken": { @@ -5225,13 +7653,13 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service can return a nextToken even if the maximum results has not\n been met.

", "smithy.api#httpQuery": "maxResults" } } } }, - "com.amazonaws.cleanrooms#ListMembersOutput": { + "com.amazonaws.cleanrooms#ListProtectedQueriesOutput": { "type": "structure", "members": { "nextToken": { @@ -5240,22 +7668,22 @@ "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, - "memberSummaries": { - "target": "com.amazonaws.cleanrooms#MemberSummaryList", + "protectedQueries": { + "target": "com.amazonaws.cleanrooms#ProtectedQuerySummaryList", "traits": { - "smithy.api#documentation": "

The list of members returned by the ListMembers operation.

", + "smithy.api#documentation": "

A list of protected queries.

", "smithy.api#required": {} } } } }, - "com.amazonaws.cleanrooms#ListMemberships": { + "com.amazonaws.cleanrooms#ListSchemas": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListMembershipsInput" + "target": "com.amazonaws.cleanrooms#ListSchemasInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListMembershipsOutput" + "target": "com.amazonaws.cleanrooms#ListSchemasOutput" }, "errors": [ { @@ -5264,6 +7692,9 @@ { "target": "com.amazonaws.cleanrooms#InternalServerException" }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, { "target": "com.amazonaws.cleanrooms#ThrottlingException" }, @@ -5272,22 +7703,38 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list available memberships", - "smithy.api#documentation": "

Lists all memberships resources within the caller's account.

", + "aws.iam#actionPermissionDescription": "Grants permission to view available schemas for a collaboration", + "smithy.api#documentation": "

Lists the schemas for relations within a collaboration.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/memberships" + "uri": "/collaborations/{collaborationIdentifier}/schemas" }, "smithy.api#paginated": { - "items": "membershipSummaries" + "items": "schemaSummaries" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#ListMembershipsInput": { + "com.amazonaws.cleanrooms#ListSchemasInput": { "type": "structure", "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the schema belongs to. Currently accepts\n a collaboration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "schemaType": { + "target": "com.amazonaws.cleanrooms#SchemaType", + "traits": { + "smithy.api#documentation": "

If present, filter schemas by schema type. The only valid schema type is currently\n `TABLE`.

", + "smithy.api#httpQuery": "schemaType" + } + }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { @@ -5301,463 +7748,544 @@ "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", "smithy.api#httpQuery": "maxResults" } - }, - "status": { - "target": "com.amazonaws.cleanrooms#MembershipStatus", - "traits": { - "smithy.api#documentation": "

A filter which will return only memberships in the specified status.

", - "smithy.api#httpQuery": "status" - } } } }, - "com.amazonaws.cleanrooms#ListMembershipsOutput": { + "com.amazonaws.cleanrooms#ListSchemasOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.cleanrooms#PaginationToken", + "schemaSummaries": { + "target": "com.amazonaws.cleanrooms#SchemaSummaryList", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The retrieved list of schemas.

", + "smithy.api#required": {} } }, - "membershipSummaries": { - "target": "com.amazonaws.cleanrooms#MembershipSummaryList", + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The list of memberships returned from the ListMemberships operation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } }, - "com.amazonaws.cleanrooms#ListProtectedQueries": { + "com.amazonaws.cleanrooms#ListTagsForResource": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#ListProtectedQueriesInput" + "target": "com.amazonaws.cleanrooms#ListTagsForResourceInput" }, "output": { - "target": "com.amazonaws.cleanrooms#ListProtectedQueriesOutput" + "target": "com.amazonaws.cleanrooms#ListTagsForResourceOutput" }, "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" - }, { "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" - }, { "target": "com.amazonaws.cleanrooms#ValidationException" } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list protected queries", - "smithy.api#documentation": "

Lists protected queries, sorted by the most recent query.

", + "smithy.api#documentation": "

Lists all of the tags that have been added to a resource.

", "smithy.api#http": { - "code": 200, "method": "GET", - "uri": "/memberships/{membershipIdentifier}/protectedQueries" - }, - "smithy.api#paginated": { - "items": "protectedQueries", - "inputToken": "nextToken", - "outputToken": "nextToken" + "uri": "/tags/{resourceArn}", + "code": 200 }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#ListProtectedQueriesInput": { + "com.amazonaws.cleanrooms#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cleanrooms#CleanroomsArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to list tags\n on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "

A map of objects specifying each key name and value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cleanrooms#MemberAbilities": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#MemberAbility" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.cleanrooms#MemberAbility": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CAN_QUERY", + "value": "CAN_QUERY" + }, + { + "name": "CAN_RECEIVE_RESULTS", + "value": "CAN_RECEIVE_RESULTS" + } + ] + } + }, + "com.amazonaws.cleanrooms#MemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#MemberSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + } + } + }, + "com.amazonaws.cleanrooms#MemberSpecification": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", + "smithy.api#required": {} + } + }, + "memberAbilities": { + "target": "com.amazonaws.cleanrooms#MemberAbilities", + "traits": { + "smithy.api#documentation": "

The abilities granted to the collaboration member.

", + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.cleanrooms#DisplayName", + "traits": { + "smithy.api#documentation": "

The member's display name.

", + "smithy.api#required": {} + } + }, + "paymentConfiguration": { + "target": "com.amazonaws.cleanrooms#PaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The collaboration\n member's payment responsibilities set by the collaboration creator.\n

\n

If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Basic metadata used to construct a new member.

" + } + }, + "com.amazonaws.cleanrooms#MemberStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "INVITED", + "value": "INVITED" + }, + { + "name": "ACTIVE", + "value": "ACTIVE" + }, + { + "name": "LEFT", + "value": "LEFT" + }, + { + "name": "REMOVED", + "value": "REMOVED" + } + ] + } + }, + "com.amazonaws.cleanrooms#MemberSummary": { "type": "structure", "members": { - "membershipIdentifier": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "accountId": { + "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier for the membership in the collaboration.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" + "smithy.api#resourceIdentifier": "AccountId" } }, "status": { - "target": "com.amazonaws.cleanrooms#ProtectedQueryStatus", + "target": "com.amazonaws.cleanrooms#MemberStatus", "traits": { - "smithy.api#documentation": "

A filter on the status of the protected query.

", - "smithy.api#httpQuery": "status" + "smithy.api#documentation": "

The status of the member.\n

", + "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.cleanrooms#PaginationToken", + "displayName": { + "target": "com.amazonaws.cleanrooms#DisplayName", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The member's display name.

", + "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.cleanrooms#MaxResults", + "abilities": { + "target": "com.amazonaws.cleanrooms#MemberAbilities", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call. Service chooses a default if\n it has not been set. Service can return a nextToken even if the maximum results has not\n been met.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The abilities granted to the collaboration member.

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.cleanrooms#ListProtectedQueriesOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cleanrooms#PaginationToken", + }, + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The time when the member was created.

", + "smithy.api#required": {} } }, - "protectedQueries": { - "target": "com.amazonaws.cleanrooms#ProtectedQuerySummaryList", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

A list of protected queries.

", + "smithy.api#documentation": "

The time the member metadata was last updated.

", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.cleanrooms#ListSchemas": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#ListSchemasInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#ListSchemasOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" - }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID for the member's associated membership, if present.

" + } }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the member's associated membership, if present.

" + } }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" + "paymentConfiguration": { + "target": "com.amazonaws.cleanrooms#PaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The collaboration\n member's payment responsibilities set by the collaboration creator.\n

", + "smithy.api#required": {} + } } - ], + }, "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to view available schemas for a collaboration", - "smithy.api#documentation": "

Lists the schemas for relations within a collaboration.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/collaborations/{collaborationIdentifier}/schemas" - }, - "smithy.api#paginated": { - "items": "schemaSummaries" - }, - "smithy.api#readonly": {} + "smithy.api#documentation": "

The member object listed by the request.

" } }, - "com.amazonaws.cleanrooms#ListSchemasInput": { + "com.amazonaws.cleanrooms#MemberSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#MemberSummary" + } + }, + "com.amazonaws.cleanrooms#Membership": { "type": "structure", "members": { - "collaborationIdentifier": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "id": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the schema belongs to. Currently accepts\n a collaboration ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The unique ID of the membership.

", "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" + "smithy.api#resourceIdentifier": "MembershipId" } }, - "schemaType": { - "target": "com.amazonaws.cleanrooms#SchemaType", + "arn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "

If present, filter schemas by schema type. The only valid schema type is currently\n `TABLE`.

", - "smithy.api#httpQuery": "schemaType" + "smithy.api#documentation": "

The unique ARN for the membership.

", + "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.cleanrooms#PaginationToken", + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The unique ARN for the membership's associated collaboration.

", + "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.cleanrooms#MaxResults", + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The unique ID for the membership's collaboration.

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.cleanrooms#ListSchemasOutput": { - "type": "structure", - "members": { - "schemaSummaries": { - "target": "com.amazonaws.cleanrooms#SchemaSummaryList", + }, + "collaborationCreatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The retrieved list of schemas.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.cleanrooms#PaginationToken", + "collaborationCreatorDisplayName": { + "target": "com.amazonaws.cleanrooms#DisplayName", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + "smithy.api#documentation": "

The display name of the collaboration creator.

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.cleanrooms#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#ListTagsForResourceInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#ListTagsForResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the tags that have been added to a resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "collaborationName": { + "target": "com.amazonaws.cleanrooms#CollaborationName", + "traits": { + "smithy.api#documentation": "

The name of the membership's collaboration.

", + "smithy.api#required": {} + } }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.cleanrooms#ListTagsForResourceInput": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.cleanrooms#CleanroomsArn", + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the membership was created.

", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the membership metadata was last updated.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanrooms#MembershipStatus", + "traits": { + "smithy.api#documentation": "

The status of the\n membership.

", + "smithy.api#required": {} + } + }, + "memberAbilities": { + "target": "com.amazonaws.cleanrooms#MemberAbilities", + "traits": { + "smithy.api#documentation": "

The abilities granted to the collaboration member.

", + "smithy.api#required": {} + } + }, + "queryLogStatus": { + "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to list tags\n on.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n membership.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cleanrooms#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.cleanrooms#TagMap", + }, + "defaultResultConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", "traits": { - "smithy.api#documentation": "

A map of objects specifying each key name and value.

", + "smithy.api#documentation": "

The default protected query result configuration as specified by the member who can\n receive results.

" + } + }, + "paymentConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

The membership object.

" } }, - "com.amazonaws.cleanrooms#MaxResults": { - "type": "integer", + "com.amazonaws.cleanrooms#MembershipArn": { + "type": "string", "traits": { - "smithy.api#range": { - "min": 1, + "smithy.api#length": { "max": 100 - } + }, + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+$" } }, - "com.amazonaws.cleanrooms#MemberAbilities": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#MemberAbility" - }, + "com.amazonaws.cleanrooms#MembershipIdentifier": { + "type": "string", "traits": { - "smithy.api#uniqueItems": {} + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, - "com.amazonaws.cleanrooms#MemberAbility": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "CAN_QUERY", - "value": "CAN_QUERY" - }, - { - "name": "CAN_RECEIVE_RESULTS", - "value": "CAN_RECEIVE_RESULTS" + "com.amazonaws.cleanrooms#MembershipPaymentConfiguration": { + "type": "structure", + "members": { + "queryCompute": { + "target": "com.amazonaws.cleanrooms#MembershipQueryComputePaymentConfig", + "traits": { + "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member for query compute\n costs.

", + "smithy.api#required": {} } - ] + } + }, + "traits": { + "smithy.api#documentation": "

An object\n representing the payment responsibilities accepted by the collaboration\n member.

" } }, - "com.amazonaws.cleanrooms#MemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#MemberSpecification" + "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryS3OutputConfiguration" + } }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 9 - } + "smithy.api#documentation": "

Contains configurations for protected query results.

" } }, - "com.amazonaws.cleanrooms#MemberSpecification": { + "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration": { "type": "structure", "members": { - "accountId": { - "target": "com.amazonaws.cleanrooms#AccountId", + "outputConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", + "smithy.api#documentation": "

Configuration for protected query results.

", "smithy.api#required": {} } }, - "memberAbilities": { - "target": "com.amazonaws.cleanrooms#MemberAbilities", + "roleArn": { + "target": "com.amazonaws.cleanrooms#RoleArn", "traits": { - "smithy.api#documentation": "

The abilities granted to the collaboration member.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unique ARN for an IAM role that is used by Clean Rooms to write protected\n query results to the result location, given by the member who can receive results.

" } - }, - "displayName": { - "target": "com.amazonaws.cleanrooms#DisplayName", + } + }, + "traits": { + "smithy.api#documentation": "

Contains configurations for protected query results.

" + } + }, + "com.amazonaws.cleanrooms#MembershipQueryComputePaymentConfig": { + "type": "structure", + "members": { + "isResponsible": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The member's display name.

", + "smithy.api#documentation": "

Indicates whether\n the collaboration member has accepted to pay for query compute costs (TRUE) or\n has not accepted to pay for query compute costs\n (FALSE).

\n

If the collaboration creator has not specified anyone to pay for query compute costs,\n then the member who can query is the default payer.

\n

An error message is returned for the following reasons:

\n ", "smithy.api#required": {} } - }, - "paymentConfiguration": { - "target": "com.amazonaws.cleanrooms#PaymentConfiguration", - "traits": { - "smithy.api#documentation": "

The collaboration\n member's payment responsibilities set by the collaboration creator.\n

\n

If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.

" - } } }, "traits": { - "smithy.api#documentation": "

Basic metadata used to construct a new member.

" + "smithy.api#documentation": "

An object\n representing the payment responsibilities accepted by the collaboration member for query\n compute costs.

" } }, - "com.amazonaws.cleanrooms#MemberStatus": { + "com.amazonaws.cleanrooms#MembershipQueryLogStatus": { "type": "string", "traits": { "smithy.api#enum": [ { - "name": "INVITED", - "value": "INVITED" - }, - { - "name": "ACTIVE", - "value": "ACTIVE" - }, - { - "name": "LEFT", - "value": "LEFT" + "name": "ENABLED", + "value": "ENABLED" }, { - "name": "REMOVED", - "value": "REMOVED" + "name": "DISABLED", + "value": "DISABLED" } ] } }, - "com.amazonaws.cleanrooms#MemberSummary": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.cleanrooms#AccountId", - "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AccountId" - } - }, - "status": { - "target": "com.amazonaws.cleanrooms#MemberStatus", - "traits": { - "smithy.api#documentation": "

The status of the member.\n

", - "smithy.api#required": {} - } + "com.amazonaws.cleanrooms#MembershipResource": { + "type": "resource", + "identifiers": { + "MembershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier" + } + }, + "create": { + "target": "com.amazonaws.cleanrooms#CreateMembership" + }, + "read": { + "target": "com.amazonaws.cleanrooms#GetMembership" + }, + "update": { + "target": "com.amazonaws.cleanrooms#UpdateMembership" + }, + "delete": { + "target": "com.amazonaws.cleanrooms#DeleteMembership" + }, + "list": { + "target": "com.amazonaws.cleanrooms#ListMemberships" + }, + "operations": [ + { + "target": "com.amazonaws.cleanrooms#GetProtectedQuery" }, - "displayName": { - "target": "com.amazonaws.cleanrooms#DisplayName", - "traits": { - "smithy.api#documentation": "

The member's display name.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.cleanrooms#ListPrivacyBudgets" }, - "abilities": { - "target": "com.amazonaws.cleanrooms#MemberAbilities", - "traits": { - "smithy.api#documentation": "

The abilities granted to the collaboration member.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.cleanrooms#ListProtectedQueries" }, - "createTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the member was created.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.cleanrooms#PreviewPrivacyImpact" }, - "updateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the member metadata was last updated.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.cleanrooms#StartProtectedQuery" }, - "membershipId": { - "target": "com.amazonaws.cleanrooms#UUID", - "traits": { - "smithy.api#documentation": "

The unique ID for the member's associated membership, if present.

" - } + { + "target": "com.amazonaws.cleanrooms#UpdateProtectedQuery" + } + ], + "traits": { + "aws.api#arn": { + "template": "membership/{MembershipId}" }, - "membershipArn": { - "target": "com.amazonaws.cleanrooms#MembershipArn", - "traits": { - "smithy.api#documentation": "

The unique ARN for the member's associated membership, if present.

" - } + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "membership" }, - "paymentConfiguration": { - "target": "com.amazonaws.cleanrooms#PaymentConfiguration", - "traits": { - "smithy.api#documentation": "

The collaboration\n member's payment responsibilities set by the collaboration creator.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "Represents an AWS account that is a part of a collaboration" + } + }, + "com.amazonaws.cleanrooms#MembershipStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACTIVE", + "value": "ACTIVE" + }, + { + "name": "REMOVED", + "value": "REMOVED" + }, + { + "name": "COLLABORATION_DELETED", + "value": "COLLABORATION_DELETED" } - } - }, - "traits": { - "smithy.api#documentation": "

The member object listed by the request.

" - } - }, - "com.amazonaws.cleanrooms#MemberSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#MemberSummary" + ] } }, - "com.amazonaws.cleanrooms#Membership": { + "com.amazonaws.cleanrooms#MembershipSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The unique ID of the membership.

", + "smithy.api#documentation": "

The unique ID for the membership's collaboration.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" } @@ -5777,7 +8305,7 @@ } }, "collaborationId": { - "target": "com.amazonaws.cleanrooms#UUID", + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { "smithy.api#documentation": "

The unique ID for the membership's collaboration.

", "smithy.api#required": {} @@ -5786,7 +8314,7 @@ "collaborationCreatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier of the Amazon Web Services principal that created the collaboration. Currently only\n supports Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -5800,7 +8328,7 @@ "collaborationName": { "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "

The name of the membership's collaboration.

", + "smithy.api#documentation": "

The name for the membership's collaboration.

", "smithy.api#required": {} } }, @@ -5832,19 +8360,6 @@ "smithy.api#required": {} } }, - "queryLogStatus": { - "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", - "traits": { - "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n membership.

", - "smithy.api#required": {} - } - }, - "defaultResultConfiguration": { - "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", - "traits": { - "smithy.api#documentation": "

The default protected query result configuration as specified by the member who can\n receive results.

" - } - }, "paymentConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", "traits": { @@ -5854,414 +8369,653 @@ } }, "traits": { - "smithy.api#documentation": "

The membership object.

" + "smithy.api#documentation": "

The membership object listed by the request.

" } }, - "com.amazonaws.cleanrooms#MembershipArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 100 - }, - "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+$" + "com.amazonaws.cleanrooms#MembershipSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#MembershipSummary" } }, - "com.amazonaws.cleanrooms#MembershipIdentifier": { + "com.amazonaws.cleanrooms#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + "max": 10240 + } } }, - "com.amazonaws.cleanrooms#MembershipPaymentConfiguration": { - "type": "structure", - "members": { - "queryCompute": { - "target": "com.amazonaws.cleanrooms#MembershipQueryComputePaymentConfig", - "traits": { - "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member for query compute\n costs.

", - "smithy.api#required": {} - } - } + "com.amazonaws.cleanrooms#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cleanrooms#ParameterName" }, - "traits": { - "smithy.api#documentation": "

An object\n representing the payment responsibilities accepted by the collaboration\n member.

" + "value": { + "target": "com.amazonaws.cleanrooms#ParameterValue" } }, - "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration": { - "type": "union", - "members": { - "s3": { - "target": "com.amazonaws.cleanrooms#ProtectedQueryS3OutputConfiguration" - } - }, + "com.amazonaws.cleanrooms#ParameterName": { + "type": "string", "traits": { - "smithy.api#documentation": "

Contains configurations for protected query results.

" + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_]+$" } }, - "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration": { - "type": "structure", + "com.amazonaws.cleanrooms#ParameterType": { + "type": "enum", "members": { - "outputConfiguration": { - "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration", + "SMALLINT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Configuration for protected query results.

", - "smithy.api#required": {} + "smithy.api#enumValue": "SMALLINT" } }, - "roleArn": { - "target": "com.amazonaws.cleanrooms#RoleArn", + "INTEGER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The unique ARN for an IAM role that is used by Clean Rooms to write protected\n query results to the result location, given by the member who can receive results.

" + "smithy.api#enumValue": "INTEGER" + } + }, + "BIGINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGINT" + } + }, + "DECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIMAL" + } + }, + "REAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REAL" + } + }, + "DOUBLE_PRECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE_PRECISION" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "CHAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAR" + } + }, + "VARCHAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARCHAR" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } + }, + "TIMESTAMPTZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMPTZ" + } + }, + "TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIME" + } + }, + "TIMETZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMETZ" + } + }, + "VARBYTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARBYTE" } } - }, + } + }, + "com.amazonaws.cleanrooms#ParameterValue": { + "type": "string", "traits": { - "smithy.api#documentation": "

Contains configurations for protected query results.

" + "smithy.api#length": { + "min": 0, + "max": 250 + } } }, - "com.amazonaws.cleanrooms#MembershipQueryComputePaymentConfig": { + "com.amazonaws.cleanrooms#PaymentConfiguration": { "type": "structure", "members": { - "isResponsible": { - "target": "smithy.api#Boolean", + "queryCompute": { + "target": "com.amazonaws.cleanrooms#QueryComputePaymentConfig", "traits": { - "smithy.api#documentation": "

Indicates whether\n the collaboration member has accepted to pay for query compute costs (TRUE) or\n has not accepted to pay for query compute costs\n (FALSE).

\n

If the collaboration creator has not specified anyone to pay for query compute costs,\n then the member who can query is the default payer.

\n

An error message is returned for the following reasons:

\n ", + "smithy.api#documentation": "

The collaboration\n member's payment responsibilities set by the collaboration creator for query compute\n costs.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

An object\n representing the payment responsibilities accepted by the collaboration member for query\n compute costs.

" - } - }, - "com.amazonaws.cleanrooms#MembershipQueryLogStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ENABLED", - "value": "ENABLED" - }, - { - "name": "DISABLED", - "value": "DISABLED" - } - ] + "smithy.api#documentation": "

An object\n representing the collaboration member's payment responsibilities set by the collaboration\n creator.

" } }, - "com.amazonaws.cleanrooms#MembershipResource": { - "type": "resource", - "identifiers": { - "MembershipId": { - "target": "com.amazonaws.cleanrooms#MembershipIdentifier" - } - }, - "create": { - "target": "com.amazonaws.cleanrooms#CreateMembership" - }, - "read": { - "target": "com.amazonaws.cleanrooms#GetMembership" - }, - "update": { - "target": "com.amazonaws.cleanrooms#UpdateMembership" - }, - "delete": { - "target": "com.amazonaws.cleanrooms#DeleteMembership" + "com.amazonaws.cleanrooms#PreviewPrivacyImpact": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#PreviewPrivacyImpactInput" }, - "list": { - "target": "com.amazonaws.cleanrooms#ListMemberships" + "output": { + "target": "com.amazonaws.cleanrooms#PreviewPrivacyImpactOutput" }, - "operations": [ + "errors": [ { - "target": "com.amazonaws.cleanrooms#GetProtectedQuery" + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" }, { - "target": "com.amazonaws.cleanrooms#ListProtectedQueries" + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" }, { - "target": "com.amazonaws.cleanrooms#StartProtectedQuery" + "target": "com.amazonaws.cleanrooms#ThrottlingException" }, { - "target": "com.amazonaws.cleanrooms#UpdateProtectedQuery" + "target": "com.amazonaws.cleanrooms#ValidationException" } ], "traits": { - "aws.api#arn": { - "template": "membership/{MembershipId}" - }, - "aws.iam#disableConditionKeyInference": {}, - "aws.iam#iamResource": { - "name": "membership" + "aws.iam#actionPermissionDescription": "Grants permission to preview a new privacy impacting change", + "smithy.api#documentation": "

An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/previewprivacyimpact" + } + } + }, + "com.amazonaws.cleanrooms#PreviewPrivacyImpactInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for one of your memberships for a collaboration. Accepts a membership ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } }, - "smithy.api#documentation": "Represents an AWS account that is a part of a collaboration" + "parameters": { + "target": "com.amazonaws.cleanrooms#PreviewPrivacyImpactParametersInput", + "traits": { + "smithy.api#documentation": "

Specifies the desired epsilon and noise parameters to preview.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#MembershipStatus": { - "type": "string", + "com.amazonaws.cleanrooms#PreviewPrivacyImpactOutput": { + "type": "structure", + "members": { + "privacyImpact": { + "target": "com.amazonaws.cleanrooms#PrivacyImpact", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#enum": [ - { - "name": "ACTIVE", - "value": "ACTIVE" - }, - { - "name": "REMOVED", - "value": "REMOVED" - }, - { - "name": "COLLABORATION_DELETED", - "value": "COLLABORATION_DELETED" + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanrooms#PreviewPrivacyImpactParametersInput": { + "type": "union", + "members": { + "differentialPrivacy": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyPreviewParametersInput", + "traits": { + "smithy.api#documentation": "

An array that specifies the epsilon and noise parameters.

" } - ] + } + }, + "traits": { + "smithy.api#documentation": "

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.

" } }, - "com.amazonaws.cleanrooms#MembershipSummary": { + "com.amazonaws.cleanrooms#PrivacyBudget": { + "type": "union", + "members": { + "differentialPrivacy": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyPrivacyBudget", + "traits": { + "smithy.api#documentation": "

An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The epsilon parameter value and number of each aggregation function that you can perform.

" + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The unique ID for the membership's collaboration.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "MembershipId" + "smithy.api#documentation": "

The unique identifier of the privacy budget.

", + "smithy.api#required": {} } }, - "arn": { + "privacyBudgetTemplateId": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the privacy budget template.

", + "smithy.api#required": {} + } + }, + "privacyBudgetTemplateArn": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateArn", + "traits": { + "smithy.api#documentation": "

The ARN of the privacy budget template.

", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#required": {} + } + }, + "membershipArn": { "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "

The unique ARN for the membership.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member who created the privacy budget summary.

", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier of the collaboration that contains this privacy budget.

", "smithy.api#required": {} } }, "collaborationArn": { "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The unique ARN for the membership's associated collaboration.

", + "smithy.api#documentation": "

The ARN of the collaboration that contains this privacy budget.

", "smithy.api#required": {} } }, - "collaborationId": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "type": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", "traits": { - "smithy.api#documentation": "

The unique ID for the membership's collaboration.

", + "smithy.api#documentation": "

Specifies the type of the privacy budget.

", "smithy.api#required": {} } }, - "collaborationCreatorAccountId": { - "target": "com.amazonaws.cleanrooms#AccountId", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services principal that created the collaboration. Currently only\n supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The time at which the privacy budget was created.

", "smithy.api#required": {} } }, - "collaborationCreatorDisplayName": { - "target": "com.amazonaws.cleanrooms#DisplayName", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The display name of the collaboration creator.

", + "smithy.api#documentation": "

The most recent time at which the privacy budget was updated.

", "smithy.api#required": {} } }, - "collaborationName": { - "target": "com.amazonaws.cleanrooms#CollaborationName", + "budget": { + "target": "com.amazonaws.cleanrooms#PrivacyBudget", "traits": { - "smithy.api#documentation": "

The name for the membership's collaboration.

", + "smithy.api#documentation": "

The provided privacy budget.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.

" + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetSummary" + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetTemplate": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the privacy budget template.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateArn", + "traits": { + "smithy.api#documentation": "

The ARN of the privacy budget template.

", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#required": {} + } + }, + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member who created the privacy budget template.

", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the collaboration that contains this privacy budget template.

", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the collaboration that contains this privacy budget template.

", "smithy.api#required": {} } }, "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time when the membership was created.

", + "smithy.api#documentation": "

The time at which the privacy budget template was created.

", "smithy.api#required": {} } }, "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time the membership metadata was last updated.

", + "smithy.api#documentation": "

The most recent time at which the privacy budget template was updated.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.cleanrooms#MembershipStatus", + "privacyBudgetType": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", "traits": { - "smithy.api#documentation": "

The status of the\n membership.

", + "smithy.api#documentation": "

Specifies the type of the privacy budget template.

", "smithy.api#required": {} } }, - "memberAbilities": { - "target": "com.amazonaws.cleanrooms#MemberAbilities", + "autoRefresh": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateAutoRefresh", "traits": { - "smithy.api#documentation": "

The abilities granted to the collaboration member.

", + "smithy.api#documentation": "

How often the privacy budget refreshes.

\n \n

If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

\n ", "smithy.api#required": {} } }, - "paymentConfiguration": { - "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", + "parameters": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateParametersOutput", "traits": { - "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member.

", + "smithy.api#documentation": "

Specifies the epislon and noise parameters for the privacy budget template.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The membership object listed by the request.

" - } - }, - "com.amazonaws.cleanrooms#MembershipSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#MembershipSummary" - } - }, - "com.amazonaws.cleanrooms#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 10240 - } - } - }, - "com.amazonaws.cleanrooms#ParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.cleanrooms#ParameterName" - }, - "value": { - "target": "com.amazonaws.cleanrooms#ParameterValue" + "smithy.api#documentation": "

An object that defines the privacy budget template.

" } }, - "com.amazonaws.cleanrooms#ParameterName": { + "com.amazonaws.cleanrooms#PrivacyBudgetTemplateArn": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, "max": 100 }, - "smithy.api#pattern": "^[0-9a-zA-Z_]+$" + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:privacybudgettemplate/[\\d\\w-]+$" } }, - "com.amazonaws.cleanrooms#ParameterType": { + "com.amazonaws.cleanrooms#PrivacyBudgetTemplateAutoRefresh": { "type": "enum", "members": { - "SMALLINT": { + "CALENDAR_MONTH": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SMALLINT" + "smithy.api#enumValue": "CALENDAR_MONTH" } }, - "INTEGER": { + "NONE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INTEGER" + "smithy.api#enumValue": "NONE" } + } + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 }, - "BIGINT": { - "target": "smithy.api#Unit", + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetTemplateParametersInput": { + "type": "union", + "members": { + "differentialPrivacy": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyTemplateParametersInput", "traits": { - "smithy.api#enumValue": "BIGINT" + "smithy.api#documentation": "

An object that specifies the epsilon and noise parameters.

" } - }, - "DECIMAL": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "

The epsilon and noise parameters that you want to use for the privacy budget template.

" + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetTemplateParametersOutput": { + "type": "union", + "members": { + "differentialPrivacy": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyTemplateParametersOutput", "traits": { - "smithy.api#enumValue": "DECIMAL" + "smithy.api#documentation": "

The epsilon and noise parameters.

" } + } + }, + "traits": { + "smithy.api#documentation": "

The epsilon and noise parameters that were used in the privacy budget template.

" + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetTemplateResource": { + "type": "resource", + "identifiers": { + "MembershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier" + }, + "PrivacyBudgetTemplateId": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier" + } + }, + "create": { + "target": "com.amazonaws.cleanrooms#CreatePrivacyBudgetTemplate" + }, + "read": { + "target": "com.amazonaws.cleanrooms#GetPrivacyBudgetTemplate" + }, + "update": { + "target": "com.amazonaws.cleanrooms#UpdatePrivacyBudgetTemplate" + }, + "delete": { + "target": "com.amazonaws.cleanrooms#DeletePrivacyBudgetTemplate" + }, + "list": { + "target": "com.amazonaws.cleanrooms#ListPrivacyBudgetTemplates" + }, + "traits": { + "aws.api#arn": { + "template": "memberships/{MembershipId}/privacybudgettemplate/{PrivacyBudgetTemplateId}" }, - "REAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REAL" - } + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "privacybudgettemplate" }, - "DOUBLE_PRECISION": { - "target": "smithy.api#Unit", + "smithy.api#documentation": "Represents a privacy budget template" + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetTemplateSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", "traits": { - "smithy.api#enumValue": "DOUBLE_PRECISION" + "smithy.api#documentation": "

The unique identifier of the privacy budget template.

", + "smithy.api#required": {} } }, - "BOOLEAN": { - "target": "smithy.api#Unit", + "arn": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateArn", "traits": { - "smithy.api#enumValue": "BOOLEAN" + "smithy.api#documentation": "

The ARN of the privacy budget template.

", + "smithy.api#required": {} } }, - "CHAR": { - "target": "smithy.api#Unit", + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#enumValue": "CHAR" + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#required": {} } }, - "VARCHAR": { - "target": "smithy.api#Unit", + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#enumValue": "VARCHAR" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member who created the privacy budget template.

", + "smithy.api#required": {} } }, - "DATE": { - "target": "smithy.api#Unit", + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#enumValue": "DATE" + "smithy.api#documentation": "

The unique ID of the collaboration that contains this privacy budget template.

", + "smithy.api#required": {} } }, - "TIMESTAMP": { - "target": "smithy.api#Unit", + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#enumValue": "TIMESTAMP" + "smithy.api#documentation": "

The ARN of the collaboration that contains this privacy budget template.

", + "smithy.api#required": {} } }, - "TIMESTAMPTZ": { - "target": "smithy.api#Unit", + "privacyBudgetType": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", "traits": { - "smithy.api#enumValue": "TIMESTAMPTZ" + "smithy.api#documentation": "

The type of the privacy budget template.

", + "smithy.api#required": {} } }, - "TIME": { - "target": "smithy.api#Unit", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#enumValue": "TIME" + "smithy.api#documentation": "

The time at which the privacy budget template was created.

", + "smithy.api#required": {} } }, - "TIMETZ": { - "target": "smithy.api#Unit", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#enumValue": "TIMETZ" + "smithy.api#documentation": "

The most recent time at which the privacy budget template was updated.

", + "smithy.api#required": {} } - }, - "VARBYTE": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.

" + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetTemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateSummary" + } + }, + "com.amazonaws.cleanrooms#PrivacyBudgetTemplateUpdateParameters": { + "type": "union", + "members": { + "differentialPrivacy": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyTemplateUpdateParameters", "traits": { - "smithy.api#enumValue": "VARBYTE" + "smithy.api#documentation": "

An object that specifies the new values for the epsilon and noise parameters.

" } } + }, + "traits": { + "smithy.api#documentation": "

The epsilon and noise parameters that you want to update in the privacy budget template.

" } }, - "com.amazonaws.cleanrooms#ParameterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 + "com.amazonaws.cleanrooms#PrivacyBudgetType": { + "type": "enum", + "members": { + "DIFFERENTIAL_PRIVACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIFFERENTIAL_PRIVACY" + } } } }, - "com.amazonaws.cleanrooms#PaymentConfiguration": { - "type": "structure", + "com.amazonaws.cleanrooms#PrivacyImpact": { + "type": "union", "members": { - "queryCompute": { - "target": "com.amazonaws.cleanrooms#QueryComputePaymentConfig", + "differentialPrivacy": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyPrivacyImpact", "traits": { - "smithy.api#documentation": "

The collaboration\n member's payment responsibilities set by the collaboration creator for query compute\n costs.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An object that lists the number and type of aggregation functions you can perform.

" } } }, "traits": { - "smithy.api#documentation": "

An object\n representing the collaboration member's payment responsibilities set by the collaboration\n creator.

" + "smithy.api#documentation": "

Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.

" } }, "com.amazonaws.cleanrooms#ProtectedQuery": { @@ -6332,6 +9086,12 @@ "traits": { "smithy.api#documentation": "

An error thrown by the protected query.

" } + }, + "differentialPrivacy": { + "target": "com.amazonaws.cleanrooms#DifferentialPrivacyParameters", + "traits": { + "smithy.api#documentation": "

The sensitivity parameters of the differential privacy results of the protected query.

" + } } }, "traits": { @@ -7511,6 +10271,94 @@ } } }, + "com.amazonaws.cleanrooms#UpdateConfiguredAudienceModelAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredAudienceModelAssociationInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#UpdateConfiguredAudienceModelAssociationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to update a configured audience model association", + "smithy.api#documentation": "

Provides the details necessary to update a configured audience model association.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}" + } + } + }, + "com.amazonaws.cleanrooms#UpdateConfiguredAudienceModelAssociationInput": { + "type": "structure", + "members": { + "configuredAudienceModelAssociationIdentifier": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the configured audience model association that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ConfiguredAudienceModelAssociationId" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier of the membership that contains the configured audience model association that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

A new description for the configured audience model association.

" + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociationName", + "traits": { + "smithy.api#documentation": "

A new name for the configured audience model association.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#UpdateConfiguredAudienceModelAssociationOutput": { + "type": "structure", + "members": { + "configuredAudienceModelAssociation": { + "target": "com.amazonaws.cleanrooms#ConfiguredAudienceModelAssociation", + "traits": { + "smithy.api#documentation": "

Details about the configured audience model association that you updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#UpdateConfiguredTable": { "type": "operation", "input": { @@ -7829,6 +10677,98 @@ } } }, + "com.amazonaws.cleanrooms#UpdatePrivacyBudgetTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#UpdatePrivacyBudgetTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#UpdatePrivacyBudgetTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to update a privacy budget template", + "smithy.api#documentation": "

Updates the privacy budget template for the specified membership.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}" + } + } + }, + "com.amazonaws.cleanrooms#UpdatePrivacyBudgetTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "privacyBudgetTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for your privacy budget template that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "PrivacyBudgetTemplateId" + } + }, + "privacyBudgetType": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetType", + "traits": { + "smithy.api#documentation": "

Specifies the type of the privacy budget template.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateUpdateParameters", + "traits": { + "smithy.api#documentation": "

Specifies the epsilon and noise parameters for the privacy budget template.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#UpdatePrivacyBudgetTemplateOutput": { + "type": "structure", + "members": { + "privacyBudgetTemplate": { + "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplate", + "traits": { + "smithy.api#documentation": "

Summary of the privacy budget template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#UpdateProtectedQuery": { "type": "operation", "input": { @@ -7909,6 +10849,15 @@ } } }, + "com.amazonaws.cleanrooms#UsersNoisePerQuery": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 10, + "max": 100 + } + } + }, "com.amazonaws.cleanrooms#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/cleanroomsml.json b/codegen/sdk-codegen/aws-models/cleanroomsml.json new file mode 100644 index 00000000000..4dac13db762 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/cleanroomsml.json @@ -0,0 +1,4347 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.cleanroomsml#AWSStarkControlService": { + "type": "service", + "version": "2023-09-06", + "operations": [ + { + "target": "com.amazonaws.cleanroomsml#ListTagsForResource" + }, + { + "target": "com.amazonaws.cleanroomsml#TagResource" + }, + { + "target": "com.amazonaws.cleanroomsml#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.cleanroomsml#AudienceExportJob" + }, + { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJob" + }, + { + "target": "com.amazonaws.cleanroomsml#AudienceModel" + }, + { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModel" + }, + { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelPolicy" + }, + { + "target": "com.amazonaws.cleanroomsml#TrainingDataset" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "CleanRoomsML", + "arnNamespace": "cleanrooms-ml", + "cloudTrailEventSource": "cleanrooms-ml.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "cleanrooms-ml" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "

API Reference for Amazon Web Services Clean Rooms ML.

", + "smithy.api#title": "cleanrooms-ml", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cleanrooms-ml-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cleanrooms-ml-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cleanrooms-ml.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cleanrooms-ml.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cleanrooms-ml.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.cleanroomsml#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.cleanroomsml#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.cleanroomsml#AudienceDestination": { + "type": "structure", + "members": { + "s3Destination": { + "target": "com.amazonaws.cleanroomsml#S3ConfigMap", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket and path for the configured audience.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the Amazon S3 bucket where the configured audience is stored.

" + } + }, + "com.amazonaws.cleanroomsml#AudienceExportJob": { + "type": "resource", + "identifiers": { + "audienceExportJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceExportJobArn" + } + }, + "create": { + "target": "com.amazonaws.cleanroomsml#StartAudienceExportJob" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListAudienceExportJobs" + }, + "traits": { + "aws.api#arn": { + "template": "{audienceExportJobArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#AudienceExportJobArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#AudienceExportJob" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-export-job/[-a-zA-Z0-9_/.]+$" + } + }, + "com.amazonaws.cleanroomsml#AudienceExportJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#AudienceExportJobSummary" + } + }, + "com.amazonaws.cleanroomsml#AudienceExportJobStatus": { + "type": "enum", + "members": { + "CREATE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_PENDING" + } + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.cleanroomsml#AudienceExportJobSummary": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the audience export job was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the audience export job was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the audience export job.

", + "smithy.api#required": {} + } + }, + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience generation job that was exported.

", + "smithy.api#required": {} + } + }, + "audienceSize": { + "target": "com.amazonaws.cleanroomsml#AudienceSize", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the audience export job.

" + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#AudienceExportJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the audience export job.

", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails" + }, + "outputLocation": { + "target": "com.amazonaws.cleanroomsml#S3Path", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket where the audience export is stored.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the audience export job.

" + } + }, + "com.amazonaws.cleanroomsml#AudienceGenerationJob": { + "type": "resource", + "identifiers": { + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn" + } + }, + "create": { + "target": "com.amazonaws.cleanroomsml#StartAudienceGenerationJob" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetAudienceGenerationJob" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJob" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListAudienceGenerationJobs" + }, + "traits": { + "aws.api#arn": { + "template": "{audienceGenerationJobArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#AudienceGenerationJobArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#AudienceGenerationJob" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-generation-job/[-a-zA-Z0-9_/.]+$" + } + }, + "com.amazonaws.cleanroomsml#AudienceGenerationJobDataSource": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.cleanroomsml#S3ConfigMap", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket where the training data for the configured audience is stored.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that can read the Amazon S3 bucket where the training data is stored.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the Amazon S3 bucket where the training data for the configured audience is stored.

" + } + }, + "com.amazonaws.cleanroomsml#AudienceGenerationJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobSummary" + } + }, + "com.amazonaws.cleanroomsml#AudienceGenerationJobStatus": { + "type": "enum", + "members": { + "CREATE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_PENDING" + } + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.cleanroomsml#AudienceGenerationJobSummary": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the audience generation job was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the audience generation job was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience generation job.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the audience generation job.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the audience generation job.

" + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the audience generation job.

", + "smithy.api#required": {} + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that was used for this audience generation job.

", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "

The identifier of the collaboration that contains this audience generation job.

" + } + }, + "startedBy": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS Account that submitted the job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the configured audience generation job.

" + } + }, + "com.amazonaws.cleanroomsml#AudienceModel": { + "type": "resource", + "identifiers": { + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn" + } + }, + "create": { + "target": "com.amazonaws.cleanroomsml#CreateAudienceModel" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetAudienceModel" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteAudienceModel" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListAudienceModels" + }, + "traits": { + "aws.api#arn": { + "template": "{audienceModelArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#AudienceModelArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#AudienceModel" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-model/[-a-zA-Z0-9_/.]+$" + } + }, + "com.amazonaws.cleanroomsml#AudienceModelList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#AudienceModelSummary" + } + }, + "com.amazonaws.cleanroomsml#AudienceModelMetric": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanroomsml#AudienceModelMetricType", + "traits": { + "smithy.api#documentation": "

The audience model metric.

", + "smithy.api#required": {} + } + }, + "forTopKItemPredictions": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of users that were used to generate these model metrics.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The value of the audience model metric

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The audience model metrics.

" + } + }, + "com.amazonaws.cleanroomsml#AudienceModelMetricType": { + "type": "enum", + "members": { + "NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN" + } + }, + "MEAN_RECIPROCAL_RANK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEAN_RECIPROCAL_RANK" + } + }, + "PRECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRECISION" + } + }, + "RECALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECALL" + } + } + } + }, + "com.amazonaws.cleanroomsml#AudienceModelMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#AudienceModelMetric" + } + }, + "com.amazonaws.cleanroomsml#AudienceModelStatus": { + "type": "enum", + "members": { + "CREATE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_PENDING" + } + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.cleanroomsml#AudienceModelSummary": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the audience model was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the audience model was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience model.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the audience model.

", + "smithy.api#required": {} + } + }, + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training dataset that was used for the audience model.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#AudienceModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the audience model.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the audience model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the audience model.

" + } + }, + "com.amazonaws.cleanroomsml#AudienceQualityMetrics": { + "type": "structure", + "members": { + "relevanceMetrics": { + "target": "com.amazonaws.cleanroomsml#RelevanceMetrics", + "traits": { + "smithy.api#documentation": "

The relevance scores of the generated audience.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Metrics that describe the quality of the generated audience.

" + } + }, + "com.amazonaws.cleanroomsml#AudienceSize": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeType", + "traits": { + "smithy.api#documentation": "

Whether the audience size is defined in absolute terms or as a percentage. You can use the ABSOLUTE\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage\n AudienceSize to configure sizes in the range 1-100 percent.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeValue", + "traits": { + "smithy.api#documentation": "

Specify an audience size value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The size of the generated audience. Must match one of the sizes in the configured audience model.

" + } + }, + "com.amazonaws.cleanroomsml#AudienceSizeBins": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.cleanroomsml#AudienceSizeConfig": { + "type": "structure", + "members": { + "audienceSizeType": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeType", + "traits": { + "smithy.api#documentation": "

Whether the audience output sizes are defined as an absolute number or a percentage.

", + "smithy.api#required": {} + } + }, + "audienceSizeBins": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeBins", + "traits": { + "smithy.api#documentation": "

An array of the different audience output sizes.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configure the list of audience output sizes that can be created. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage\n AudienceSize to configure sizes in the range 1-100 percent.

" + } + }, + "com.amazonaws.cleanroomsml#AudienceSizeType": { + "type": "enum", + "members": { + "ABSOLUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSOLUTE" + } + }, + "PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE" + } + } + } + }, + "com.amazonaws.cleanroomsml#AudienceSizeValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20000000 + } + } + }, + "com.amazonaws.cleanroomsml#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + } + }, + "com.amazonaws.cleanroomsml#ColumnSchema": { + "type": "structure", + "members": { + "columnName": { + "target": "com.amazonaws.cleanroomsml#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of a column.

", + "smithy.api#required": {} + } + }, + "columnTypes": { + "target": "com.amazonaws.cleanroomsml#ColumnTypeList", + "traits": { + "smithy.api#documentation": "

The data type of column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a column.

" + } + }, + "com.amazonaws.cleanroomsml#ColumnType": { + "type": "enum", + "members": { + "USER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_ID" + } + }, + "ITEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ITEM_ID" + } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } + }, + "CATEGORICAL_FEATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CATEGORICAL_FEATURE" + } + }, + "NUMERICAL_FEATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERICAL_FEATURE" + } + } + } + }, + "com.amazonaws.cleanroomsml#ColumnTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ColumnType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModel": { + "type": "resource", + "identifiers": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn" + } + }, + "create": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModel" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModel" + }, + "update": { + "target": "com.amazonaws.cleanroomsml#UpdateConfiguredAudienceModel" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModel" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListConfiguredAudienceModels" + }, + "traits": { + "aws.api#arn": { + "template": "{configuredAudienceModelArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#ConfiguredAudienceModel" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+$" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelSummary" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig": { + "type": "structure", + "members": { + "destination": { + "target": "com.amazonaws.cleanroomsml#AudienceDestination", + "traits": { + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that can write the Amazon S3 bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information necessary for the configure audience model output.

" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelPolicy": { + "type": "resource", + "identifiers": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn" + } + }, + "put": { + "target": "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicy" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicy" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicy" + }, + "traits": { + "aws.api#arn": { + "template": "{configuredAudienceModelArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelSummary": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the configured audience model was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the configured audience model was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the configured audience model.

", + "smithy.api#required": {} + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.

", + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "traits": { + "smithy.api#documentation": "

The output configuration of the configured audience model.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the configured audience model.

" + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that you are interested in.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the configured audience model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the configured audience model.

" + } + }, + "com.amazonaws.cleanroomsml#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource with that name already exists in this region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cleanroomsml#CreateAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateAudienceModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateAudienceModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/audience-model" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#CreateAudienceModelRequest": { + "type": "structure", + "members": { + "trainingDataStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start date and time of the training window.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "trainingDataEndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end date and time of the training window.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the audience model resource.

", + "smithy.api#required": {} + } + }, + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training dataset for this audience model.

", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.

" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the audience model.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#CreateAudienceModelResponse": { + "type": "structure", + "members": { + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Defines the information necessary to create a configured audience model.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configured-audience-model" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the configured audience model.

", + "smithy.api#required": {} + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.

", + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "traits": { + "smithy.api#documentation": "

Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have s3:PutObject permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the configured audience model.

" + } + }, + "sharedAudienceMetrics": { + "target": "com.amazonaws.cleanroomsml#MetricsList", + "traits": { + "smithy.api#documentation": "

Whether audience metrics are shared.

", + "smithy.api#required": {} + } + }, + "minMatchingSeedSize": { + "target": "com.amazonaws.cleanroomsml#MinMatchingSeedSize", + "traits": { + "smithy.api#default": 500, + "smithy.api#documentation": "

The minimum number of users from the seed audience that must match with users in the training data of the audience model.

" + } + }, + "audienceSizeConfig": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeConfig", + "traits": { + "smithy.api#documentation": "

Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage\n AudienceSize to configure sizes in the range 1-100 percent.

" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + } + }, + "childResourceTagOnCreatePolicy": { + "target": "com.amazonaws.cleanroomsml#TagOnCreatePolicy", + "traits": { + "smithy.api#documentation": "

Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelResponse": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#CreateTrainingDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateTrainingDatasetRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateTrainingDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Defines the information necessary to create a training dataset, or seed audience. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/training-dataset" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#CreateTrainingDatasetRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the training dataset. This name must be unique in your account and region.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.

\n

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.

", + "smithy.api#required": {} + } + }, + "trainingData": { + "target": "com.amazonaws.cleanroomsml#DatasetList", + "traits": { + "smithy.api#documentation": "

An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.

", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the training dataset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#CreateTrainingDatasetResponse": { + "type": "structure", + "members": { + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training dataset resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#DataSource": { + "type": "structure", + "members": { + "glueDataSource": { + "target": "com.amazonaws.cleanroomsml#GlueDataSource", + "traits": { + "smithy.api#documentation": "

A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines information about the Glue data source that contains the training data.

" + } + }, + "com.amazonaws.cleanroomsml#Dataset": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanroomsml#DatasetType", + "traits": { + "smithy.api#documentation": "

What type of information is found in the dataset.

", + "smithy.api#required": {} + } + }, + "inputConfig": { + "target": "com.amazonaws.cleanroomsml#DatasetInputConfig", + "traits": { + "smithy.api#documentation": "

A DatasetInputConfig object that defines the data source and schema mapping.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines where the training dataset is located, what type of data it contains, and how to access the data.

" + } + }, + "com.amazonaws.cleanroomsml#DatasetInputConfig": { + "type": "structure", + "members": { + "schema": { + "target": "com.amazonaws.cleanroomsml#DatasetSchemaList", + "traits": { + "smithy.api#documentation": "

The schema information for the training data.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "dataSource": { + "target": "com.amazonaws.cleanroomsml#DataSource", + "traits": { + "smithy.api#documentation": "

A DataSource object that specifies the Glue data source for the training data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the Glue data source and schema mapping information.

" + } + }, + "com.amazonaws.cleanroomsml#DatasetList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#Dataset" + } + }, + "com.amazonaws.cleanroomsml#DatasetSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ColumnSchema" + } + }, + "com.amazonaws.cleanroomsml#DatasetType": { + "type": "enum", + "members": { + "INTERACTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERACTIONS" + } + } + } + }, + "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified audience generation job, and removes all data associated with the job.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/audience-generation-job/{audienceGenerationJobArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJobRequest": { + "type": "structure", + "members": { + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience generation job that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteAudienceModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.

", + "smithy.api#http": { + "code": 200, + "uri": "/audience-model/{audienceModelArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteAudienceModelRequest": { + "type": "structure", + "members": { + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience model that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.

", + "smithy.api#http": { + "code": 200, + "uri": "/configured-audience-model/{configuredAudienceModelArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified configured audience model policy.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/configured-audience-model/{configuredAudienceModelArn}/policy" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicyRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteTrainingDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteTrainingDatasetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.

", + "smithy.api#http": { + "uri": "/training-dataset/{trainingDatasetArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteTrainingDatasetRequest": { + "type": "structure", + "members": { + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training dataset that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceGenerationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetAudienceGenerationJobRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetAudienceGenerationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an audience generation job.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-generation-job/{audienceGenerationJobArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceGenerationJobRequest": { + "type": "structure", + "members": { + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience generation job that you are interested in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceGenerationJobResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the audience generation job was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the audience generation job was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience generation job.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the audience generation job.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the audience generation job.

" + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the audience generation job.

", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails", + "traits": { + "smithy.api#documentation": "

Details about the status of the audience generation job.

" + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.

", + "smithy.api#required": {} + } + }, + "seedAudience": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobDataSource", + "traits": { + "smithy.api#documentation": "

The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.

" + } + }, + "includeSeedInOutput": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.

" + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "

The identifier of the collaboration that this audience generation job is associated with.

" + } + }, + "metrics": { + "target": "com.amazonaws.cleanroomsml#AudienceQualityMetrics", + "traits": { + "smithy.api#documentation": "

The relevance scores for different audience sizes.

" + } + }, + "startedBy": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account that started this audience generation job.

" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that are associated to this audience generation job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetAudienceModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetAudienceModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an audience model

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-model/{audienceModelArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceModelRequest": { + "type": "structure", + "members": { + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience model that you are interested in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceModelResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the audience model was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the audience model was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "trainingDataStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start date specified for the training window.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "trainingDataEndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end date specified for the training window.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience model.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the audience model.

", + "smithy.api#required": {} + } + }, + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training dataset that was used for this audience model.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#AudienceModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the audience model.

", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails", + "traits": { + "smithy.api#documentation": "

Details about the status of the audience model.

" + } + }, + "metrics": { + "target": "com.amazonaws.cleanroomsml#AudienceModelMetrics", + "traits": { + "smithy.api#documentation": "

Accuracy metrics for the model.

" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN used for the audience model.

" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that are assigned to the audience model.

" + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the audience model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specified configured audience model.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configured-audience-model/{configuredAudienceModelArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a configured audience model policy.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configured-audience-model/{configuredAudienceModelArn}/policy" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that you are interested in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyResponse": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model.

", + "smithy.api#required": {} + } + }, + "configuredAudienceModelPolicy": { + "target": "com.amazonaws.cleanroomsml#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The configured audience model policy. This is a JSON IAM resource policy.

", + "smithy.api#required": {} + } + }, + "policyHash": { + "target": "com.amazonaws.cleanroomsml#Hash", + "traits": { + "smithy.api#documentation": "

A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that you are interested in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the configured audience model was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the configured audience model was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the configured audience model.

", + "smithy.api#required": {} + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience model used for this configured audience model.

", + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "traits": { + "smithy.api#documentation": "

The output configuration of the configured audience model

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the configured audience model.

" + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the configured audience model.

", + "smithy.api#required": {} + } + }, + "sharedAudienceMetrics": { + "target": "com.amazonaws.cleanroomsml#MetricsList", + "traits": { + "smithy.api#documentation": "

Whether audience metrics are shared.

", + "smithy.api#required": {} + } + }, + "minMatchingSeedSize": { + "target": "com.amazonaws.cleanroomsml#MinMatchingSeedSize", + "traits": { + "smithy.api#documentation": "

The minimum number of users from the seed audience that must match with users in the training data of the audience model.

" + } + }, + "audienceSizeConfig": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeConfig", + "traits": { + "smithy.api#documentation": "

The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage\n AudienceSize to configure sizes in the range 1-100 percent.

" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that are associated to this configured audience model.

" + } + }, + "childResourceTagOnCreatePolicy": { + "target": "com.amazonaws.cleanroomsml#TagOnCreatePolicy", + "traits": { + "smithy.api#documentation": "

Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainingDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetTrainingDatasetRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetTrainingDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a training dataset.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/training-dataset/{trainingDatasetArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainingDatasetRequest": { + "type": "structure", + "members": { + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training dataset that you are interested in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainingDatasetResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the training dataset was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the training dataset was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training dataset.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the training dataset.

", + "smithy.api#required": {} + } + }, + "trainingData": { + "target": "com.amazonaws.cleanroomsml#DatasetList", + "traits": { + "smithy.api#documentation": "

Metadata about the requested training data.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetStatus", + "traits": { + "smithy.api#documentation": "

The status of the training dataset.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The IAM role used to read the training data.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that are assigned to this training dataset.

" + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the training dataset.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GlueDataSource": { + "type": "structure", + "members": { + "tableName": { + "target": "com.amazonaws.cleanroomsml#GlueTableName", + "traits": { + "smithy.api#documentation": "

The Glue table that contains the training data.

", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.cleanroomsml#GlueDatabaseName", + "traits": { + "smithy.api#documentation": "

The Glue database that contains the training data.

", + "smithy.api#required": {} + } + }, + "catalogId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "

The Glue catalog that contains the training data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the Glue data source that contains the training data.

" + } + }, + "com.amazonaws.cleanroomsml#GlueDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$" + } + }, + "com.amazonaws.cleanroomsml#GlueTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + } + }, + "com.amazonaws.cleanroomsml#Hash": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 64, + "max": 128 + }, + "smithy.api#pattern": "^[0-9a-f]+$" + } + }, + "com.amazonaws.cleanroomsml#IamRoleArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::IAM::Role" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$" + } + }, + "com.amazonaws.cleanroomsml#KmsKeyArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::KMS::Key" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+$" + } + }, + "com.amazonaws.cleanroomsml#ListAudienceExportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListAudienceExportJobsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListAudienceExportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the audience export jobs.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-export-job" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "audienceExportJobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceExportJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience generation job that you are interested in.

", + "smithy.api#httpQuery": "audienceGenerationJobArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceExportJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + } + }, + "audienceExportJobs": { + "target": "com.amazonaws.cleanroomsml#AudienceExportJobList", + "traits": { + "smithy.api#documentation": "

The audience export jobs that match the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceGenerationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of audience generation jobs.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-generation-job" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "audienceGenerationJobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.

", + "smithy.api#httpQuery": "configuredAudienceModelArn" + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "

The identifier of the collaboration that contains the audience generation jobs that you are interested in.

", + "smithy.api#httpQuery": "collaborationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + } + }, + "audienceGenerationJobs": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobList", + "traits": { + "smithy.api#documentation": "

The audience generation jobs that match the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListAudienceModelsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListAudienceModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of audience models.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-model" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "audienceModels" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceModelsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + } + }, + "audienceModels": { + "target": "com.amazonaws.cleanroomsml#AudienceModelList", + "traits": { + "smithy.api#documentation": "

The audience models that match the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredAudienceModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the configured audience models.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configured-audience-model" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "configuredAudienceModels" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + } + }, + "configuredAudienceModels": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelList", + "traits": { + "smithy.api#documentation": "

The configured audience models.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of tags for a provided resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cleanroomsml#TaggableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you are interested in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that are associated with the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListTrainingDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListTrainingDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListTrainingDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of training datasets.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/training-dataset" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "trainingDatasets" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListTrainingDatasetsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListTrainingDatasetsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + } + }, + "trainingDatasets": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetList", + "traits": { + "smithy.api#documentation": "

The training datasets that match the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cleanroomsml#MetricsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#SharedAudienceMetrics" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cleanroomsml#MinMatchingSeedSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 25, + "max": 500000 + } + } + }, + "com.amazonaws.cleanroomsml#NameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + } + }, + "com.amazonaws.cleanroomsml#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + } + } + }, + "com.amazonaws.cleanroomsml#PolicyExistenceCondition": { + "type": "enum", + "members": { + "POLICY_MUST_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY_MUST_EXIST" + } + }, + "POLICY_MUST_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY_MUST_NOT_EXIST" + } + } + } + }, + "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create or update the resource policy for a configured audience model.

", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/configured-audience-model/{configuredAudienceModelArn}/policy" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "configuredAudienceModelPolicy": { + "target": "com.amazonaws.cleanroomsml#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The IAM resource policy.

", + "smithy.api#required": {} + } + }, + "previousPolicyHash": { + "target": "com.amazonaws.cleanroomsml#Hash", + "traits": { + "smithy.api#documentation": "

A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

" + } + }, + "policyExistenceCondition": { + "target": "com.amazonaws.cleanroomsml#PolicyExistenceCondition", + "traits": { + "smithy.api#documentation": "

Use this to prevent unexpected concurrent modification of the policy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyResponse": { + "type": "structure", + "members": { + "configuredAudienceModelPolicy": { + "target": "com.amazonaws.cleanroomsml#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The IAM resource policy.

", + "smithy.api#required": {} + } + }, + "policyHash": { + "target": "com.amazonaws.cleanroomsml#Hash", + "traits": { + "smithy.api#documentation": "

A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#RelevanceMetric": { + "type": "structure", + "members": { + "audienceSize": { + "target": "com.amazonaws.cleanroomsml#AudienceSize", + "traits": { + "smithy.api#required": {} + } + }, + "score": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The relevance score of the generated audience.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The relevance score of a generated audience.

" + } + }, + "com.amazonaws.cleanroomsml#RelevanceMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#RelevanceMetric" + } + }, + "com.amazonaws.cleanroomsml#ResourceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$" + } + }, + "com.amazonaws.cleanroomsml#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource you are requesting does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cleanroomsml#ResourcePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20480 + } + } + }, + "com.amazonaws.cleanroomsml#S3ConfigMap": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.cleanroomsml#S3Path", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location URI.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an Amazon S3 bucket and path.

" + } + }, + "com.amazonaws.cleanroomsml#S3Path": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1285 + }, + "smithy.api#pattern": "^s3://.+$" + } + }, + "com.amazonaws.cleanroomsml#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You have exceeded your service quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.cleanroomsml#SharedAudienceMetrics": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.cleanroomsml#StartAudienceExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#StartAudienceExportJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Export an audience of a specified size after you have generated an audience.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/audience-export-job" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#StartAudienceExportJobRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the audience export job.

", + "smithy.api#required": {} + } + }, + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience generation job that you want to export.

", + "smithy.api#required": {} + } + }, + "audienceSize": { + "target": "com.amazonaws.cleanroomsml#AudienceSize", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the audience export job.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#StartAudienceGenerationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#StartAudienceGenerationJobRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#StartAudienceGenerationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Information necessary to start the audience generation job.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/audience-generation-job" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#StartAudienceGenerationJobRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the audience generation job.

", + "smithy.api#required": {} + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.

", + "smithy.api#required": {} + } + }, + "seedAudience": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobDataSource", + "traits": { + "smithy.api#documentation": "

The seed audience that is used to generate the audience.

", + "smithy.api#required": {} + } + }, + "includeSeedInOutput": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the seed audience is included in the audience generation output.

" + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "

The identifier of the collaboration that contains the audience generation job.

" + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the audience generation job.

" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#StartAudienceGenerationJobResponse": { + "type": "structure", + "members": { + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the audience generation job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#StatusDetails": { + "type": "structure", + "members": { + "statusCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.

" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the status of a resource.

" + } + }, + "com.amazonaws.cleanroomsml#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:).{1,128}$" + } + }, + "com.amazonaws.cleanroomsml#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.cleanroomsml#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cleanroomsml#TagKey" + }, + "value": { + "target": "com.amazonaws.cleanroomsml#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.cleanroomsml#TagOnCreatePolicy": { + "type": "enum", + "members": { + "FROM_PARENT_RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FROM_PARENT_RESOURCE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.cleanroomsml#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds metadata tags to a specified resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.cleanroomsml#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cleanroomsml#TaggableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to assign tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "

The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cleanroomsml#TaggableArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:(training-dataset|audience-model|configured-audience-model|audience-generation-job)/[-a-zA-Z0-9_/.]+$" + } + }, + "com.amazonaws.cleanroomsml#TrainingDataset": { + "type": "resource", + "identifiers": { + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn" + } + }, + "create": { + "target": "com.amazonaws.cleanroomsml#CreateTrainingDataset" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetTrainingDataset" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteTrainingDataset" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListTrainingDatasets" + }, + "traits": { + "aws.api#arn": { + "template": "{trainingDatasetArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#TrainingDatasetArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#TrainingDataset" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:training-dataset/[-a-zA-Z0-9_/.]+$" + } + }, + "com.amazonaws.cleanroomsml#TrainingDatasetList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetSummary" + } + }, + "com.amazonaws.cleanroomsml#TrainingDatasetStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.cleanroomsml#TrainingDatasetSummary": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the training dataset was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the training dataset was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the training dataset.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "

The name of the training dataset.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetStatus", + "traits": { + "smithy.api#documentation": "

The status of the training dataset.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the training dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the training dataset.

" + } + }, + "com.amazonaws.cleanroomsml#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.cleanroomsml#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes metadata tags from a specified resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cleanroomsml#TaggableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.cleanroomsml#TagKeys", + "traits": { + "smithy.api#documentation": "

The key values of tags that you want to remove.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#UpdateConfiguredAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#UpdateConfiguredAudienceModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#UpdateConfiguredAudienceModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/configured-audience-model/{configuredAudienceModelArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#UpdateConfiguredAudienceModelRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "traits": { + "smithy.api#documentation": "

The new output configuration.

" + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new audience model that you want to use.

" + } + }, + "sharedAudienceMetrics": { + "target": "com.amazonaws.cleanroomsml#MetricsList", + "traits": { + "smithy.api#documentation": "

The new value for whether to share audience metrics.

" + } + }, + "minMatchingSeedSize": { + "target": "com.amazonaws.cleanroomsml#MinMatchingSeedSize", + "traits": { + "smithy.api#documentation": "

The minimum number of users from the seed audience that must match with users in the training data of the audience model.

" + } + }, + "audienceSizeConfig": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeConfig", + "traits": { + "smithy.api#documentation": "

The new audience size configuration.

" + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The new description of the configured audience model.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#UpdateConfiguredAudienceModelResponse": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configured audience model that was updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for this request are incorrect.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/opensearch.json b/codegen/sdk-codegen/aws-models/opensearch.json index 8a07e601ade..22bbdd8476f 100644 --- a/codegen/sdk-codegen/aws-models/opensearch.json +++ b/codegen/sdk-codegen/aws-models/opensearch.json @@ -258,6 +258,98 @@ } } }, + "com.amazonaws.opensearch#AddDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#AddDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#AddDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DependencyFailureException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#LimitExceededException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds the data source on the domain.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#AddDataSourceRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source.

", + "smithy.api#required": {} + } + }, + "DataSourceType": { + "target": "com.amazonaws.opensearch#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of data source.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.opensearch#DataSourceDescription", + "traits": { + "smithy.api#documentation": "

A description of the data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the parameters to the AddDataSource\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#AddDataSourceResponse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.opensearch#String", + "traits": { + "smithy.api#documentation": "

A message associated with the data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of an AddDataSource operation.

", + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#AddTags": { "type": "operation", "input": { @@ -477,6 +569,9 @@ { "target": "com.amazonaws.opensearch#AcceptInboundConnection" }, + { + "target": "com.amazonaws.opensearch#AddDataSource" + }, { "target": "com.amazonaws.opensearch#AddTags" }, @@ -501,6 +596,9 @@ { "target": "com.amazonaws.opensearch#CreateVpcEndpoint" }, + { + "target": "com.amazonaws.opensearch#DeleteDataSource" + }, { "target": "com.amazonaws.opensearch#DeleteDomain" }, @@ -567,6 +665,9 @@ { "target": "com.amazonaws.opensearch#GetCompatibleVersions" }, + { + "target": "com.amazonaws.opensearch#GetDataSource" + }, { "target": "com.amazonaws.opensearch#GetDomainMaintenanceStatus" }, @@ -579,6 +680,9 @@ { "target": "com.amazonaws.opensearch#GetUpgradeStatus" }, + { + "target": "com.amazonaws.opensearch#ListDataSources" + }, { "target": "com.amazonaws.opensearch#ListDomainMaintenances" }, @@ -630,6 +734,9 @@ { "target": "com.amazonaws.opensearch#StartServiceSoftwareUpdate" }, + { + "target": "com.amazonaws.opensearch#UpdateDataSource" + }, { "target": "com.amazonaws.opensearch#UpdateDomainConfig" }, @@ -3321,6 +3428,149 @@ "smithy.api#documentation": "

Cross-cluster search specific connection properties.

" } }, + "com.amazonaws.opensearch#DataSourceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" + } + }, + "com.amazonaws.opensearch#DataSourceDetails": { + "type": "structure", + "members": { + "DataSourceType": { + "target": "com.amazonaws.opensearch#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of data source.

" + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source.

" + } + }, + "Description": { + "target": "com.amazonaws.opensearch#DataSourceDescription", + "traits": { + "smithy.api#documentation": "

A description of the data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the data sources.

" + } + }, + "com.amazonaws.opensearch#DataSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#DataSourceDetails" + } + }, + "com.amazonaws.opensearch#DataSourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 80 + }, + "smithy.api#pattern": "^[a-z][a-z0-9_]+$" + } + }, + "com.amazonaws.opensearch#DataSourceType": { + "type": "union", + "members": { + "S3GlueDataCatalog": { + "target": "com.amazonaws.opensearch#S3GlueDataCatalog", + "traits": { + "smithy.api#documentation": "

The data source for the AWS S3 Glue Data Catalog.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the data source.

" + } + }, + "com.amazonaws.opensearch#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DependencyFailureException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the data source.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the parameters to the DeleteDataSource\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#DeleteDataSourceResponse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.opensearch#String", + "traits": { + "smithy.api#documentation": "

A message associated with the initiated request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of a GetDataSource operation.

", + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#DeleteDomain": { "type": "operation", "input": { @@ -5226,7 +5476,7 @@ "TLSSecurityPolicy": { "target": "com.amazonaws.opensearch#TLSSecurityPolicy", "traits": { - "smithy.api#documentation": "

Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

\n

Can be one of the following values:

\n " + "smithy.api#documentation": "

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can\n be one of the following values:

\n " } }, "CustomEndpointEnabled": { @@ -6233,6 +6483,95 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#GetDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#GetDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#GetDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DependencyFailureException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the data source details.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#GetDataSourceRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the parameters to the GetDataSource\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#GetDataSourceResponse": { + "type": "structure", + "members": { + "DataSourceType": { + "target": "com.amazonaws.opensearch#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of data source.

" + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source.

" + } + }, + "Description": { + "target": "com.amazonaws.opensearch#DataSourceDescription", + "traits": { + "smithy.api#documentation": "

A description of the data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of a GetDataSource operation.

", + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#GetDomainMaintenanceStatus": { "type": "operation", "input": { @@ -7041,6 +7380,75 @@ "smithy.api#documentation": "

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can\n be one of the following:

\n " } }, + "com.amazonaws.opensearch#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#ListDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DependencyFailureException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

A list of the data source details of the domain.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#ListDataSourcesRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the parameters to the ListDataSources\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#ListDataSourcesResponse": { + "type": "structure", + "members": { + "DataSources": { + "target": "com.amazonaws.opensearch#DataSourceList", + "traits": { + "smithy.api#documentation": "

A list of the data sources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of a ListDataSources operation.

", + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#ListDomainMaintenances": { "type": "operation", "input": { @@ -10132,6 +10540,20 @@ } } }, + "com.amazonaws.opensearch#S3GlueDataCatalog": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.opensearch#RoleArn", + "traits": { + "smithy.api#documentation": "

The role ARN for the AWS S3 Glue Data Catalog.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the AWS S3 Glue Data Catalog.

" + } + }, "com.amazonaws.opensearch#S3Key": { "type": "string", "traits": { @@ -11005,6 +11427,96 @@ "com.amazonaws.opensearch#UncompressedPluginSizeInBytes": { "type": "long" }, + "com.amazonaws.opensearch#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DependencyFailureException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the data source on the domain.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#UpdateDataSourceRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceType": { + "target": "com.amazonaws.opensearch#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of data source.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.opensearch#DataSourceDescription", + "traits": { + "smithy.api#documentation": "

A description of the data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the parameters to the UpdateDataSource\n operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#UpdateDataSourceResponse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.opensearch#String", + "traits": { + "smithy.api#documentation": "

A message associated with the data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of an UpdateDataSource operation.

", + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#UpdateDomainConfig": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/opensearchserverless.json b/codegen/sdk-codegen/aws-models/opensearchserverless.json index efd43bd825c..c8c9e0a149e 100644 --- a/codegen/sdk-codegen/aws-models/opensearchserverless.json +++ b/codegen/sdk-codegen/aws-models/opensearchserverless.json @@ -497,6 +497,12 @@ "smithy.api#documentation": "

The ARN of the Amazon Web Services KMS key used to encrypt the collection.

" } }, + "standbyReplicas": { + "target": "com.amazonaws.opensearchserverless#StandbyReplicas", + "traits": { + "smithy.api#documentation": "

Details about an OpenSearch Serverless collection.

" + } + }, "createdDate": { "target": "smithy.api#Long", "traits": { @@ -906,6 +912,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

" } }, + "standbyReplicas": { + "target": "com.amazonaws.opensearchserverless#StandbyReplicas", + "traits": { + "smithy.api#documentation": "

Creates details about an OpenSearch Serverless collection.

" + } + }, "createdDate": { "target": "smithy.api#Long", "traits": { @@ -954,6 +966,12 @@ "smithy.api#documentation": "

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

" } }, + "standbyReplicas": { + "target": "com.amazonaws.opensearchserverless#StandbyReplicas", + "traits": { + "smithy.api#documentation": "

Indicates whether standby replicas should be used for a collection.

" + } + }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { @@ -3604,6 +3622,17 @@ "expect": { "error": "Invalid Configuration: Missing Region" } + }, + { + "documentation": "Partition doesn't support DualStack", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } } ], "version": "1.0" @@ -4126,6 +4155,23 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.opensearchserverless#StandbyReplicas": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ENABLED", + "value": "ENABLED", + "documentation": "Standby replicas enabled" + }, + { + "name": "DISABLED", + "value": "DISABLED", + "documentation": "Standby replicas disabled" + } + ] + } + }, "com.amazonaws.opensearchserverless#SubnetId": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker-runtime.json b/codegen/sdk-codegen/aws-models/sagemaker-runtime.json index 30d8e59a521..6aa9e23bd96 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker-runtime.json +++ b/codegen/sdk-codegen/aws-models/sagemaker-runtime.json @@ -1130,6 +1130,16 @@ "smithy.api#pattern": "^\\p{ASCII}*$" } }, + "com.amazonaws.sagemakerruntime#InferenceComponentHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + } + }, "com.amazonaws.sagemakerruntime#InferenceId": { "type": "string", "traits": { @@ -1432,6 +1442,13 @@ "smithy.api#documentation": "

An optional JMESPath expression used to override the EnableExplanations\n parameter of the ClarifyExplainerConfig API. See the EnableExplanations section in the developer guide for more information.\n

", "smithy.api#httpHeader": "X-Amzn-SageMaker-Enable-Explanations" } + }, + "InferenceComponentName": { + "target": "com.amazonaws.sagemakerruntime#InferenceComponentHeader", + "traits": { + "smithy.api#documentation": "

If the endpoint hosts one or more inference components, this parameter specifies the\n name of inference component to invoke.

", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Component" + } } }, "traits": { @@ -1505,7 +1522,7 @@ } ], "traits": { - "smithy.api#documentation": "

Invokes a model at the specified endpoint to return the inference response as a\n stream. The inference stream provides the response payload incrementally as a series of\n parts. Before you can get an inference stream, you must have access to a model that's\n deployed using Amazon SageMaker hosting services, and the container for that model\n must support inference streaming.

\n

For more information that can help you use this API, see the following sections in the\n Amazon SageMaker Developer Guide:

\n \n

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.

\n

Calls to InvokeEndpointWithResponseStream are authenticated by using\n Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the\n Amazon S3 API Reference.

", + "smithy.api#documentation": "

Invokes a model at the specified endpoint to return the inference response as a\n stream. The inference stream provides the response payload incrementally as a series of\n parts. Before you can get an inference stream, you must have access to a model that's\n deployed using Amazon SageMaker hosting services, and the container for that model\n must support inference streaming.

\n

For more information that can help you use this API, see the following sections in the\n Amazon SageMaker Developer Guide:

\n \n

Before you can use this operation, your IAM permissions must allow the\n sagemaker:InvokeEndpoint action. For more information about Amazon SageMaker actions for IAM policies, see Actions, resources, and condition keys for Amazon SageMaker in the IAM Service Authorization\n Reference.

\n

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.

\n

Calls to InvokeEndpointWithResponseStream are authenticated by using\n Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the\n Amazon S3 API Reference.

", "smithy.api#http": { "method": "POST", "uri": "/endpoints/{EndpointName}/invocations-response-stream", @@ -1574,6 +1591,13 @@ "smithy.api#documentation": "

An identifier that you assign to your request.

", "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Id" } + }, + "InferenceComponentName": { + "target": "com.amazonaws.sagemakerruntime#InferenceComponentHeader", + "traits": { + "smithy.api#documentation": "

If the endpoint hosts one or more inference components, this parameter specifies the\n name of inference component to invoke for a streaming response.

", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Component" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index bf1c1c7e26e..370908efe0d 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -262,7 +262,7 @@ "target": "com.amazonaws.sagemaker#AddTagsOutput" }, "traits": { - "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain\n or CreateUserProfile.

\n " + "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain\n or CreateUserProfile.

\n " } }, "com.amazonaws.sagemaker#AddTagsInput": { @@ -2730,7 +2730,7 @@ "MaxRuntimePerTrainingJobInSeconds": { "target": "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.

\n

For job V2s (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.

" + "smithy.api#documentation": "

The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.

\n

For job V2s (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.

\n

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours\n (259200 seconds).

" } }, "MaxAutoMLJobRuntimeInSeconds": { @@ -5749,6 +5749,741 @@ "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, + "com.amazonaws.sagemaker#ClusterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupDetails": { + "type": "structure", + "members": { + "CurrentCount": { + "target": "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances that are currently in the instance group of a\n SageMaker HyperPod cluster.

" + } + }, + "TargetCount": { + "target": "com.amazonaws.sagemaker#ClusterInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

" + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the instance group of a SageMaker HyperPod cluster.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type of the instance group of a SageMaker HyperPod cluster.

" + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#documentation": "

Details of LifeCycle configuration for the instance group.

" + } + }, + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The execution role for the instance group to assume.

" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "

The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud\n User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of an instance group in a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetails" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ClusterInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the name of the instance group.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the instance type of the instance group.

", + "smithy.api#required": {} + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the LifeCycle configuration for the instance group.

", + "smithy.api#required": {} + } + }, + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies an IAM execution role to be assumed by the instance group.

", + "smithy.api#required": {} + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "

Specifies the value for Threads per core. For instance types that\n support multithreading, you can specify 1 for disabling multithreading and\n 2 for enabling multithreading. For instance types that doesn't support\n multithreading, specify 1. For more information, see the reference table of\n CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud\n User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specifications of an instance group that you need to define.

" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failure" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "SHUTTING_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShuttingDown" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStatusDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of an instance in a SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The message from an instance in a SageMaker HyperPod cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of an instance in a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceType": { + "type": "enum", + "members": { + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_C5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.large" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.12xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.24xlarge" + } + }, + "ML_C5N_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.large" + } + }, + "ML_C5N_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.2xlarge" + } + }, + "ML_C5N_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.4xlarge" + } + }, + "ML_C5N_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.9xlarge" + } + }, + "ML_C5N_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.18xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.8xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.16xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterLifeCycleConfig": { + "type": "structure", + "members": { + "SourceS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An Amazon S3 bucket path where your LifeCycle scripts are stored.

", + "smithy.api#required": {} + } + }, + "OnCreate": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfigFileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The directory of the LifeCycle script under SourceS3Uri. This LifeCycle\n script runs during cluster creation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The LifeCycle configuration for a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterLifeCycleConfigFileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#ClusterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ClusterNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" + } + }, + "com.amazonaws.sagemaker#ClusterNodeDetails": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

The instance group name in which the instance is.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

" + } + }, + "InstanceStatus": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", + "traits": { + "smithy.api#documentation": "

The status of the instance.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#documentation": "

The type of the instance.

" + } + }, + "LaunchTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the instance is launched.

" + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#documentation": "

The LifeCycle configuration applied to the instance.

" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "

The number of threads per CPU core you specified under\n CreateCluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of an instance (also called a node interchangeably) in a\n SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterNodeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$" + } + }, + "com.amazonaws.sagemaker#ClusterNodeSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterNodeSummary" + } + }, + "com.amazonaws.sagemaker#ClusterNodeSummary": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the instance group in which the instance is.

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of the instance.

", + "smithy.api#required": {} + } + }, + "LaunchTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the instance is launched.

", + "smithy.api#required": {} + } + }, + "InstanceStatus": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists a summary of the properties of an instance (also called a\n node interchangeably) of a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ClusterSortBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "INSERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "ROLLINGBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollingBack" + } + }, + "SYSTEMUPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterSummary" + } + }, + "com.amazonaws.sagemaker#ClusterSummary": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the SageMaker HyperPod cluster is created.

", + "smithy.api#required": {} + } + }, + "ClusterStatus": { + "target": "com.amazonaws.sagemaker#ClusterStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists a summary of the properties of a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterThreadsPerCore": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.sagemaker#CodeRepositories": { "type": "list", "member": { @@ -6931,7 +7666,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active simultaneously.

" + "smithy.api#documentation": "

Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active simultaneously.

" } }, "com.amazonaws.sagemaker#CreateAppImageConfig": { @@ -7365,6 +8100,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

" + } + }, + "com.amazonaws.sagemaker#CreateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the new SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance groups to be created in the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging Amazon Web Services Resources User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreateCodeRepository": { "type": "operation", "input": { @@ -7800,7 +8604,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated\n Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,\n policy, and Amazon Virtual Private Cloud (VPC) configurations.\n Users within a domain can share notebook files and other artifacts with each other.

\n

\n EFS storage\n

\n

When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks,\n Git repositories, and data files.

\n

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with\n an Amazon Web Services managed key by default. For more control, you can specify a\n customer managed key. For more information, see\n Protect Data at\n Rest Using Encryption.

\n

\n VPC configuration\n

\n

All SageMaker Studio traffic between the domain and the EFS volume is through the specified\n VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to Studio. The following options are available:

\n \n \n

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a SageMaker Studio app successfully.

\n \n

For more information, see\n Connect\n SageMaker Studio Notebooks to Resources in a VPC.

" + "smithy.api#documentation": "

Creates a Domain. A domain consists of an associated\n Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,\n policy, and Amazon Virtual Private Cloud (VPC) configurations.\n Users within a domain can share notebook files and other artifacts with each other.

\n

\n EFS storage\n

\n

When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks,\n Git repositories, and data files.

\n

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with\n an Amazon Web Services managed key by default. For more control, you can specify a\n customer managed key. For more information, see\n Protect Data at\n Rest Using Encryption.

\n

\n VPC configuration\n

\n

All traffic between the domain and the EFS volume is through the specified\n VPC and subnets. For other traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to the domain. The following options are available:

\n \n \n

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a Amazon SageMaker Studio app successfully.

\n \n

For more information, see\n Connect\n Amazon SageMaker Studio Notebooks to Resources in a VPC.

" } }, "com.amazonaws.sagemaker#CreateDomainRequest": { @@ -7834,7 +8638,7 @@ "target": "com.amazonaws.sagemaker#Subnets", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The VPC subnets that Studio uses for communication.

", + "smithy.api#documentation": "

The VPC subnets that the domain uses for communication.

", "smithy.api#required": {} } }, @@ -7842,7 +8646,7 @@ "target": "com.amazonaws.sagemaker#VpcId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

", + "smithy.api#documentation": "

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

", "smithy.api#required": {} } }, @@ -7855,7 +8659,7 @@ "AppNetworkAccessType": { "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "

Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

\n " + "smithy.api#documentation": "

Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

\n " } }, "HomeEfsFileSystemKmsKeyId": { @@ -8204,6 +9008,21 @@ "traits": { "smithy.api#documentation": "

An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants. If you use this field, you can only\n specify one variant for ProductionVariants and one variant for\n ShadowProductionVariants.

" } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker\n Roles.

\n \n

To be able to pass this role to Amazon SageMaker, the caller of this action must\n have the iam:PassRole permission.

\n " + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Sets whether all model containers deployed to the endpoint are isolated. If they are, no\n inbound or outbound network calls can be made to or from the model containers.

" + } } }, "traits": { @@ -8973,6 +9792,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreateInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateInferenceComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an inference component, which is a SageMaker hosting object that you can\n use to deploy a model to an endpoint. In the inference component settings, you specify the\n model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You\n can optimize resource utilization by tailoring how the required CPU cores, accelerators,\n and memory are allocated. You can deploy multiple inference components to an endpoint,\n where each inference component contains one model and the resource utilization needs for\n that individual model. After you deploy an inference component, you can directly invoke the\n associated model when you use the InvokeEndpoint API action.

" + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique name to assign to the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of an existing endpoint where you host the inference component.

", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of an existing production variant where you host the inference\n component.

", + "smithy.api#required": {} + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.

", + "smithy.api#required": {} + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General\n Reference.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreateInferenceExperiment": { "type": "operation", "input": { @@ -9739,9 +10645,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n " } }, "Tags": { @@ -10494,7 +11398,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser,\n the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of\n the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume.\n This operation can only be called when the authentication mode equals IAM.\n

\n

The IAM role or user passed to this API defines the permissions to access the app. Once\n the presigned URL is created, no additional permission is required to access this URL. IAM\n authorization policies for this API are also enforced for every HTTP request and WebSocket\n frame that attempts to connect to the app.

\n

You can restrict access to this API and to the\n URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to SageMaker Studio Through an Interface VPC Endpoint\n .

\n \n

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you\n are directed to the Amazon Web Services console sign-in page.

\n " + "smithy.api#documentation": "

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser,\n the user will be automatically signed in to the domain, and granted access to all of\n the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume.\n This operation can only be called when the authentication mode equals IAM.\n

\n

The IAM role or user passed to this API defines the permissions to access the app. Once\n the presigned URL is created, no additional permission is required to access this URL. IAM\n authorization policies for this API are also enforced for every HTTP request and WebSocket\n frame that attempts to connect to the app.

\n

You can restrict access to this API and to the\n URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint\n .

\n \n

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you\n are directed to the Amazon Web Services console sign-in page.

\n " } }, "com.amazonaws.sagemaker#CreatePresignedDomainUrlRequest": { @@ -10533,6 +11437,12 @@ "traits": { "smithy.api#documentation": "

The name of the space.

" } + }, + "LandingUri": { + "target": "com.amazonaws.sagemaker#LandingUri", + "traits": { + "smithy.api#documentation": "

The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

\n " + } } }, "traits": { @@ -10880,7 +11790,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Studio Lifecycle Configuration.

" + "smithy.api#documentation": "

Creates a new Amazon SageMaker Studio Lifecycle Configuration.

" } }, "com.amazonaws.sagemaker#CreateStudioLifecycleConfigRequest": { @@ -10890,7 +11800,7 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Studio Lifecycle Configuration to create.

", + "smithy.api#documentation": "

The name of the Amazon SageMaker Studio Lifecycle Configuration to create.

", "smithy.api#required": {} } }, @@ -10898,7 +11808,7 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The content of your Studio Lifecycle Configuration script. This content must be base64 encoded.

", + "smithy.api#documentation": "

The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.

", "smithy.api#required": {} } }, @@ -11092,6 +12002,12 @@ "traits": { "smithy.api#documentation": "

The number of times to retry the job when the job fails due to an\n InternalServerError.

" } + }, + "InfraCheckConfig": { + "target": "com.amazonaws.sagemaker#InfraCheckConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the infrastructure health check configuration for the training job.

" + } } }, "traits": { @@ -11440,7 +12356,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user profile is\n automatically created. A user profile is the primary holder of settings for an individual\n user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.\n

" + "smithy.api#documentation": "

Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to a domain. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user profile is\n automatically created. A user profile is the primary holder of settings for an individual\n user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.\n

" } }, "com.amazonaws.sagemaker#CreateUserProfileRequest": { @@ -12642,6 +13558,58 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#DeleteClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DeleteCodeRepository": { "type": "operation", "input": { @@ -13312,6 +14280,34 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DeleteInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteInferenceComponentInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes an inference component.

" + } + }, + "com.amazonaws.sagemaker#DeleteInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.sagemaker#DeleteInferenceExperiment": { "type": "operation", "input": { @@ -13860,7 +14856,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

" + "smithy.api#documentation": "

Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

" } }, "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest": { @@ -13870,7 +14866,7 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Studio Lifecycle Configuration to delete.

", + "smithy.api#documentation": "

The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.

", "smithy.api#required": {} } } @@ -13888,7 +14884,7 @@ "target": "com.amazonaws.sagemaker#DeleteTagsOutput" }, "traits": { - "smithy.api#documentation": "

Deletes the specified tags from an SageMaker resource.

\n

To list a resource's tags, use the ListTags API.

\n \n

When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.

\n \n \n

When you call this API to delete tags from a SageMaker Studio Domain or User\n Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain\n or User Profile launched before you called this API.

\n " + "smithy.api#documentation": "

Deletes the specified tags from an SageMaker resource.

\n

To list a resource's tags, use the ListTags API.

\n \n

When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.

\n \n \n

When you call this API to delete tags from a SageMaker Domain or User\n Profile, the deleted tags are not removed from Apps that the SageMaker Domain\n or User Profile launched before you called this API.

\n " } }, "com.amazonaws.sagemaker#DeleteTagsInput": { @@ -15291,6 +16287,149 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DescribeCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information of a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#DescribeClusterNode": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterNodeRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterNodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information of an instance (also called a node\n interchangeably) of a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#DescribeClusterNodeRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.

", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterNodeResponse": { + "type": "structure", + "members": { + "NodeDetails": { + "target": "com.amazonaws.sagemaker#ClusterNodeDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The details of the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#documentation": "

The name of the SageMaker HyperPod cluster.

" + } + }, + "ClusterStatus": { + "target": "com.amazonaws.sagemaker#ClusterStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the SageMaker Cluster is created.

" + } + }, + "FailureMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

The failure message of the SageMaker HyperPod cluster.

" + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance groups of the SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeCodeRepository": { "type": "operation", "input": { @@ -16092,7 +17231,7 @@ "AppNetworkAccessType": { "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "

Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

\n " + "smithy.api#documentation": "

Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

\n " } }, "HomeEfsFileSystemKmsKeyId": { @@ -16107,7 +17246,7 @@ "SubnetIds": { "target": "com.amazonaws.sagemaker#Subnets", "traits": { - "smithy.api#documentation": "

The VPC subnets that Studio uses for communication.

" + "smithy.api#documentation": "

The VPC subnets that the domain uses for communication.

" } }, "Url": { @@ -16119,7 +17258,7 @@ "VpcId": { "target": "com.amazonaws.sagemaker#VpcId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

" + "smithy.api#documentation": "

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

" } }, "KmsKeyId": { @@ -16581,6 +17720,21 @@ "traits": { "smithy.api#documentation": "

An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants.

" } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that you assigned to the\n endpoint configuration.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether all model containers deployed to the endpoint are isolated. If they\n are, no inbound or outbound network calls can be made to or from the model\n containers.

" + } } }, "traits": { @@ -18115,6 +19269,120 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DescribeInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponentOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns information about an inference component.

" + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component.

", + "smithy.api#required": {} + } + }, + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "

The name of the production variant that hosts the inference component.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

If the inference component status is Failed, the reason for the\n failure.

" + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecificationSummary", + "traits": { + "smithy.api#documentation": "

Details about the resources that are deployed with this inference component.

" + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary", + "traits": { + "smithy.api#documentation": "

Details about the runtime settings for the model that is deployed with the inference\n component.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the inference component was created.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the inference component was last updated.

", + "smithy.api#required": {} + } + }, + "InferenceComponentStatus": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "

The status of the inference component.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeInferenceExperiment": { "type": "operation", "input": { @@ -19195,9 +20463,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.

" } }, "VpcConfig": { @@ -20766,6 +22032,12 @@ "traits": { "smithy.api#documentation": "

A collection of space settings.

" } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

\n

The following application types are supported:

\n " + } } }, "traits": { @@ -20786,7 +22058,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the Studio Lifecycle Configuration.

" + "smithy.api#documentation": "

Describes the Amazon SageMaker Studio Lifecycle Configuration.

" } }, "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigRequest": { @@ -20796,7 +22068,7 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Studio Lifecycle Configuration to describe.

", + "smithy.api#documentation": "

The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.

", "smithy.api#required": {} } } @@ -20817,25 +22089,25 @@ "StudioLifecycleConfigName": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { - "smithy.api#documentation": "

The name of the Studio Lifecycle Configuration that is described.

" + "smithy.api#documentation": "

The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.

" } }, "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

The creation time of the Studio Lifecycle Configuration.

" + "smithy.api#documentation": "

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

" } }, "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

" + "smithy.api#documentation": "

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

" } }, "StudioLifecycleConfigContent": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", "traits": { - "smithy.api#documentation": "

The content of your Studio Lifecycle Configuration script.

" + "smithy.api#documentation": "

The content of your Amazon SageMaker Studio Lifecycle Configuration script.

" } }, "StudioLifecycleConfigAppType": { @@ -21223,6 +22495,12 @@ "traits": { "smithy.api#documentation": "

The status of the warm pool associated with the training job.

" } + }, + "InfraCheckConfig": { + "target": "com.amazonaws.sagemaker#InfraCheckConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the infrastructure health check configuration for the training job.

" + } } }, "traits": { @@ -23610,6 +24888,9 @@ "com.amazonaws.sagemaker#EnableCapture": { "type": "boolean" }, + "com.amazonaws.sagemaker#EnableInfraCheck": { + "type": "boolean" + }, "com.amazonaws.sagemaker#EnableIotRoleAlias": { "type": "boolean" }, @@ -28732,6 +30013,16 @@ "smithy.api#documentation": "

A version of a SageMaker Image. A version represents an existing container\n image.

" } }, + "com.amazonaws.sagemaker#ImageVersionAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)$" + } + }, "com.amazonaws.sagemaker#ImageVersionArn": { "type": "string", "traits": { @@ -28968,6 +30259,382 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#InferenceComponentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements": { + "type": "structure", + "members": { + "NumberOfCpuCoresRequired": { + "target": "com.amazonaws.sagemaker#NumberOfCpuCores", + "traits": { + "smithy.api#documentation": "

The number of CPU cores to allocate to run a model that you assign to an inference\n component.

" + } + }, + "NumberOfAcceleratorDevicesRequired": { + "target": "com.amazonaws.sagemaker#NumberOfAcceleratorDevices", + "traits": { + "smithy.api#documentation": "

The number of accelerators to allocate to run a model that you assign to an inference\n component. Accelerators include GPUs and Amazon Web Services Inferentia.

" + } + }, + "MinMemoryRequiredInMb": { + "target": "com.amazonaws.sagemaker#MemoryInMb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum MB of memory to allocate to run a model that you assign to an inference\n component.

", + "smithy.api#required": {} + } + }, + "MaxMemoryRequiredInMb": { + "target": "com.amazonaws.sagemaker#MemoryInMb", + "traits": { + "smithy.api#documentation": "

The maximum MB of memory to allocate to run a model that you assign to an inference\n component.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the compute resources to allocate to run a model that you assign to an inference\n component. These resources include CPU cores, accelerators, and memory.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentContainerSpecification": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#documentation": "

The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

" + } + }, + "ArtifactUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

The Amazon S3 path where the model artifacts, which result from model training,\n are stored. This path must point to a single gzip compressed tar archive (.tar.gz\n suffix).

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container. Each key and value in the\n Environment string-to-string map can have length of up to 1024. We support up to 16 entries\n in the map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary": { + "type": "structure", + "members": { + "DeployedImage": { + "target": "com.amazonaws.sagemaker#DeployedImage" + }, + "ArtifactUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

The Amazon S3 path where the model artifacts are stored.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the resources that are deployed with this inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentCopyCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + } + }, + "com.amazonaws.sagemaker#InferenceComponentNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig": { + "type": "structure", + "members": { + "CopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of runtime copies of the model container to deploy with the inference\n component. Each copy can serve inference requests.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary": { + "type": "structure", + "members": { + "DesiredCopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#documentation": "

The number of runtime copies of the model container that you requested to deploy with\n the inference component.

" + } + }, + "CurrentCopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#documentation": "

The number of runtime copies of the model container that are currently deployed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the runtime settings for the model that is deployed with the inference\n component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentSpecification": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

The name of an existing SageMaker model object in your account that you want to\n deploy with the inference component.

" + } + }, + "Container": { + "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecification", + "traits": { + "smithy.api#documentation": "

Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.

" + } + }, + "StartupParameters": { + "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", + "traits": { + "smithy.api#documentation": "

Settings that take effect while the model container starts up.

" + } + }, + "ComputeResourceRequirements": { + "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The compute resources allocated to run the model assigned \n to the inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentSpecificationSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the SageMaker model object that is deployed with the inference\n component.

" + } + }, + "Container": { + "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary", + "traits": { + "smithy.api#documentation": "

Details about the container that provides the runtime environment for the model that is\n deployed with the inference component.

" + } + }, + "StartupParameters": { + "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", + "traits": { + "smithy.api#documentation": "

Settings that take effect while the model container starts up.

" + } + }, + "ComputeResourceRequirements": { + "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", + "traits": { + "smithy.api#documentation": "

The compute resources allocated to run the model assigned \n to the inference component.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the resources that are deployed with this inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentStartupParameters": { + "type": "structure", + "members": { + "ModelDataDownloadTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this inference\n component.

" + } + }, + "ContainerStartupHealthCheckTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

The timeout value, in seconds, for your inference container to pass health check by\n Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings that take effect while the model container starts up.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentStatus": { + "type": "enum", + "members": { + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentSummary": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the inference component was created.

", + "smithy.api#required": {} + } + }, + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + }, + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the endpoint that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the production variant that hosts the inference component.

", + "smithy.api#required": {} + } + }, + "InferenceComponentStatus": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "

The status of the inference component.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time when the inference component was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the properties of an inference component.

" + } + }, + "com.amazonaws.sagemaker#InferenceComponentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceComponentSummary" + } + }, "com.amazonaws.sagemaker#InferenceExecutionConfig": { "type": "structure", "members": { @@ -29548,6 +31215,20 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" } }, + "com.amazonaws.sagemaker#InfraCheckConfig": { + "type": "structure", + "members": { + "EnableInfraCheck": { + "target": "com.amazonaws.sagemaker#EnableInfraCheck", + "traits": { + "smithy.api#documentation": "

Enables an infrastructure health check.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network \n connectivity.

" + } + }, "com.amazonaws.sagemaker#InitialInstanceCount": { "type": "integer", "traits": { @@ -31115,6 +32796,15 @@ "smithy.api#documentation": "

Metadata for a Lambda step.

" } }, + "com.amazonaws.sagemaker#LandingUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + } + } + }, "com.amazonaws.sagemaker#LastModifiedTime": { "type": "timestamp" }, @@ -32158,6 +33848,191 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#ListClusterNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClusterNodesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClusterNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the list of instances (also called nodes interchangeably)\n in a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ListClusterNodesRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

", + "smithy.api#required": {} + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are\n formatted according to the ISO 8601 standard.

\n

Acceptable formats include:

\n \n

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

" + } + }, + "InstanceGroupNameContains": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

A filter that returns the instance groups whose name contain a specified string.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of nodes to return in the response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous ListClusterNodes request was truncated, the\n response includes a NextToken. To retrieve the next set of cluster nodes, use\n the token in the next request.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ClusterSortBy", + "traits": { + "smithy.api#documentation": "

The field by which to sort results. The default value is\n CREATION_TIME.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default value is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClusterNodesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The next token specified for listing instances in a SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + }, + "ClusterNodeSummaries": { + "target": "com.amazonaws.sagemaker#ClusterNodeSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of listed instances in a SageMaker HyperPod cluster

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClustersRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClustersResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the list of SageMaker HyperPod clusters.

" + } + }, + "com.amazonaws.sagemaker#ListClustersRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Set a start time for the time range during which you want to list SageMaker HyperPod clusters.\n Timestamps are formatted according to the ISO 8601 standard.

\n

Acceptable formats include:

\n \n

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable\n formats are the same as the timestamp formats for CreationTimeAfter. For more\n information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

Set the maximum number of SageMaker HyperPod clusters to list.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

Set the maximum number of instances to print in the list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

Set the next token to retrieve the list of SageMaker HyperPod clusters.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ClusterSortBy", + "traits": { + "smithy.api#documentation": "

The field by which to sort results. The default value is\n CREATION_TIME.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default value is Ascending.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClustersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If the result of the previous ListClusters request was truncated, the\n response includes a NextToken. To retrieve the next set of clusters, use the\n token in the next request.

", + "smithy.api#required": {} + } + }, + "ClusterSummaries": { + "target": "com.amazonaws.sagemaker#ClusterSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The summaries of listed SageMaker HyperPod clusters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListCodeRepositories": { "type": "operation", "input": { @@ -34308,6 +36183,126 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#ListInferenceComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceComponentsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceComponentsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the inference components in your account and their properties.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InferenceComponents", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceComponentsInput": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#InferenceComponentSortKey", + "traits": { + "smithy.api#documentation": "

The field by which to sort the inference components in the response. The default is\n CreationTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#OrderKey", + "traits": { + "smithy.api#documentation": "

The sort order for results. The default is Descending.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of inference components to return in the response. This value\n defaults to 10.

" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#InferenceComponentNameContains", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components with a name that contains the\n specified string.

" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components that were created before the\n specified time.

" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components that were created after the\n specified time.

" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components that were updated before the\n specified time.

" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components that were updated after the\n specified time.

" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "

Filters the results to only those inference components with the specified status.

" + } + }, + "EndpointNameEquals": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

An endpoint name to filter the listed inference components. The response includes only\n those inference components that are hosted at the specified endpoint.

" + } + }, + "VariantNameEquals": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "

A production variant name to filter the listed inference components. The response\n includes only those inference components that are hosted at the specified variant.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceComponentsOutput": { + "type": "structure", + "members": { + "InferenceComponents": { + "target": "com.amazonaws.sagemaker#InferenceComponentSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of inference components and their properties that matches any of the filters you\n specified in the request.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use in a subsequent request to get the next set of results following a\n truncated response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListInferenceExperiments": { "type": "operation", "input": { @@ -37369,7 +39364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Studio Lifecycle Configurations in your Amazon Web Services Account.

", + "smithy.api#documentation": "

Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -38414,6 +40409,39 @@ "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" } }, + "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds": { "type": "integer", "traits": { @@ -38633,6 +40661,14 @@ } } }, + "com.amazonaws.sagemaker#MemoryInMb": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 128 + } + } + }, "com.amazonaws.sagemaker#MetadataProperties": { "type": "structure", "members": { @@ -43276,6 +45312,22 @@ "smithy.api#pattern": "^arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*$" } }, + "com.amazonaws.sagemaker#NumberOfAcceleratorDevices": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#NumberOfCpuCores": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0.25 + } + } + }, "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject": { "type": "integer", "traits": { @@ -44204,6 +46256,18 @@ "traits": { "smithy.api#documentation": "

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

" } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "

Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "

Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

" + } } }, "traits": { @@ -46004,9 +48068,7 @@ "ModelName": { "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the model that you want to host. This is the name that you specified\n when creating the model.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the model that you want to host. This is the name that you specified\n when creating the model.

" } }, "InitialInstanceCount": { @@ -46068,6 +48130,18 @@ "traits": { "smithy.api#documentation": "

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM)\n access for a production variant behind an endpoint. By default, SSM access is disabled\n for all production variants behind an endpoint. You can turn on or turn off SSM access\n for a production variant behind an existing endpoint by creating a new endpoint\n configuration and calling UpdateEndpoint.

" } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "

Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "

Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

" + } } }, "traits": { @@ -47051,6 +49125,32 @@ } } }, + "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether managed instance scaling is enabled.

" + } + }, + "MinInstanceCount": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount", + "traits": { + "smithy.api#documentation": "

The minimum number of instances that the endpoint must retain when it scales down to\n accommodate a decrease in traffic.

" + } + }, + "MaxInstanceCount": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount", + "traits": { + "smithy.api#documentation": "

The maximum number of instances that the endpoint can provision when it scales up to\n accommodate an increase in traffic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

" + } + }, "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds": { "type": "integer", "traits": { @@ -47060,6 +49160,22 @@ } } }, + "com.amazonaws.sagemaker#ProductionVariantRoutingConfig": { + "type": "structure", + "members": { + "RoutingStrategy": { + "target": "com.amazonaws.sagemaker#RoutingStrategy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Sets how the endpoint routes incoming traffic:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

" + } + }, "com.amazonaws.sagemaker#ProductionVariantSSMAccess": { "type": "boolean" }, @@ -47211,6 +49327,18 @@ "traits": { "smithy.api#documentation": "

The serverless configuration requested for the endpoint update.

" } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "

Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "

Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

" + } } }, "traits": { @@ -49725,6 +51853,12 @@ "smithy.api#documentation": "

The ARN of the image version created on the instance.

" } }, + "SageMakerImageVersionAlias": { + "target": "com.amazonaws.sagemaker#ImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The SageMakerImageVersionAlias.

" + } + }, "InstanceType": { "target": "com.amazonaws.sagemaker#AppInstanceType", "traits": { @@ -50031,6 +52165,23 @@ } } }, + "com.amazonaws.sagemaker#RoutingStrategy": { + "type": "enum", + "members": { + "LEAST_OUTSTANDING_REQUESTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEAST_OUTSTANDING_REQUESTS" + } + }, + "RANDOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANDOM" + } + } + } + }, "com.amazonaws.sagemaker#RuleConfigurationName": { "type": "string", "traits": { @@ -50329,6 +52480,9 @@ { "target": "com.amazonaws.sagemaker#CreateAutoMLJobV2" }, + { + "target": "com.amazonaws.sagemaker#CreateCluster" + }, { "target": "com.amazonaws.sagemaker#CreateCodeRepository" }, @@ -50386,6 +52540,9 @@ { "target": "com.amazonaws.sagemaker#CreateImageVersion" }, + { + "target": "com.amazonaws.sagemaker#CreateInferenceComponent" + }, { "target": "com.amazonaws.sagemaker#CreateInferenceExperiment" }, @@ -50488,6 +52645,9 @@ { "target": "com.amazonaws.sagemaker#DeleteAssociation" }, + { + "target": "com.amazonaws.sagemaker#DeleteCluster" + }, { "target": "com.amazonaws.sagemaker#DeleteCodeRepository" }, @@ -50539,6 +52699,9 @@ { "target": "com.amazonaws.sagemaker#DeleteImageVersion" }, + { + "target": "com.amazonaws.sagemaker#DeleteInferenceComponent" + }, { "target": "com.amazonaws.sagemaker#DeleteInferenceExperiment" }, @@ -50629,6 +52792,12 @@ { "target": "com.amazonaws.sagemaker#DescribeAutoMLJobV2" }, + { + "target": "com.amazonaws.sagemaker#DescribeCluster" + }, + { + "target": "com.amazonaws.sagemaker#DescribeClusterNode" + }, { "target": "com.amazonaws.sagemaker#DescribeCodeRepository" }, @@ -50692,6 +52861,9 @@ { "target": "com.amazonaws.sagemaker#DescribeImageVersion" }, + { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponent" + }, { "target": "com.amazonaws.sagemaker#DescribeInferenceExperiment" }, @@ -50839,6 +53011,12 @@ { "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJob" }, + { + "target": "com.amazonaws.sagemaker#ListClusterNodes" + }, + { + "target": "com.amazonaws.sagemaker#ListClusters" + }, { "target": "com.amazonaws.sagemaker#ListCodeRepositories" }, @@ -50902,6 +53080,9 @@ { "target": "com.amazonaws.sagemaker#ListImageVersions" }, + { + "target": "com.amazonaws.sagemaker#ListInferenceComponents" + }, { "target": "com.amazonaws.sagemaker#ListInferenceExperiments" }, @@ -51118,6 +53299,9 @@ { "target": "com.amazonaws.sagemaker#UpdateArtifact" }, + { + "target": "com.amazonaws.sagemaker#UpdateCluster" + }, { "target": "com.amazonaws.sagemaker#UpdateCodeRepository" }, @@ -51157,6 +53341,12 @@ { "target": "com.amazonaws.sagemaker#UpdateImageVersion" }, + { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponent" + }, + { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfig" + }, { "target": "com.amazonaws.sagemaker#UpdateInferenceExperiment" }, @@ -53227,7 +55417,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies options for sharing SageMaker Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain\n API is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing\n isn't allowed.

" + "smithy.api#documentation": "

Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain\n API is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing\n isn't allowed.

" } }, "com.amazonaws.sagemaker#ShuffleConfig": { @@ -54945,19 +57135,19 @@ "StudioLifecycleConfigName": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { - "smithy.api#documentation": "

The name of the Studio Lifecycle Configuration.

" + "smithy.api#documentation": "

The name of the Amazon SageMaker Studio Lifecycle Configuration.

" } }, "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

The creation time of the Studio Lifecycle Configuration.

" + "smithy.api#documentation": "

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

" } }, "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

" + "smithy.api#documentation": "

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

" } }, "StudioLifecycleConfigAppType": { @@ -54968,7 +57158,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details of the Studio Lifecycle Configuration.

" + "smithy.api#documentation": "

Details of the Amazon SageMaker Studio Lifecycle Configuration.

" } }, "com.amazonaws.sagemaker#StudioLifecycleConfigName": { @@ -55010,6 +57200,23 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigDetails" } }, + "com.amazonaws.sagemaker#StudioWebPortal": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.sagemaker#SubnetId": { "type": "string", "traits": { @@ -55817,16 +58024,60 @@ "smithy.api#documentation": "

The collection of settings used by an AutoML job V2 for the text classification problem\n type.

" } }, + "com.amazonaws.sagemaker#TextGenerationHyperParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, "com.amazonaws.sagemaker#TextGenerationJobConfig": { "type": "structure", "members": { "CompletionCriteria": { - "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig\n problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h\n (259200s).

" + } }, "BaseModelName": { "target": "com.amazonaws.sagemaker#BaseModelName", "traits": { - "smithy.api#documentation": "

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon-7B-Instruct.\n

" + "smithy.api#documentation": "

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon7BInstruct.

" + } + }, + "TextGenerationHyperParameters": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameters", + "traits": { + "smithy.api#documentation": "

The hyperparameters used to configure and optimize the learning process of the base\n model. You can set any combination of the following hyperparameters for all base models.\n For more information on each supported hyperparameter, see Optimize\n the learning process of your text generation models with hyperparameters.

\n \n

Here is an example where all four hyperparameters are configured.

\n

\n { \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\",\n \"learningRateWarmupSteps\": \"10\" }\n

" } } }, @@ -58988,6 +61239,69 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#UpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Update a SageMaker HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#UpdateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the name of the SageMaker HyperPod cluster you want to update.

", + "smithy.api#required": {} + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify the instance groups to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdateCodeRepository": { "type": "operation", "input": { @@ -59258,6 +61572,18 @@ "traits": { "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.

" } + }, + "SubnetIds": { + "target": "com.amazonaws.sagemaker#Subnets", + "traits": { + "smithy.api#documentation": "

The VPC subnets that Studio uses for communication.

\n

If removing subnets, ensure there are no apps in the InService,\n Pending, or Deleting state.

" + } + }, + "AppNetworkAccessType": { + "target": "com.amazonaws.sagemaker#AppNetworkAccessType", + "traits": { + "smithy.api#documentation": "

Specifies the VPC used for non-EFS traffic.

\n \n

This configuration can only be modified if there are no apps in the InService,\n Pending, or Deleting state. The configuration cannot be updated if\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set\n or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided\n as part of the same request.

" + } } }, "traits": { @@ -59855,6 +62181,124 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#UpdateInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an inference component.

" + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component.

", + "smithy.api#required": {} + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", + "traits": { + "smithy.api#documentation": "

Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.

" + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

" + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the inference component to update.

", + "smithy.api#required": {} + } + }, + "DesiredRuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference component.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdateInferenceExperiment": { "type": "operation", "input": { @@ -61283,13 +63727,13 @@ "SecurityGroups": { "target": "com.amazonaws.sagemaker#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

\n

Optional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.

\n

Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

\n

Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the\n number of security groups that you can specify is one less than the maximum number shown.

" + "smithy.api#documentation": "

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

\n

Optional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.

\n

Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

\n

Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the\n number of security groups that you can specify is one less than the maximum number shown.

" } }, "SharingSettings": { "target": "com.amazonaws.sagemaker#SharingSettings", "traits": { - "smithy.api#documentation": "

Specifies options for sharing SageMaker Studio notebooks.

" + "smithy.api#documentation": "

Specifies options for sharing Amazon SageMaker Studio notebooks.

" } }, "JupyterServerAppSettings": { @@ -61327,10 +63771,22 @@ "traits": { "smithy.api#documentation": "

The Canvas app settings.

" } + }, + "DefaultLandingUri": { + "target": "com.amazonaws.sagemaker#LandingUri", + "traits": { + "smithy.api#documentation": "

The default experience that the user is directed to when accessing the domain. The supported values are:

\n " + } + }, + "StudioWebPortal": { + "target": "com.amazonaws.sagemaker#StudioWebPortal", + "traits": { + "smithy.api#documentation": "

Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

" + } } }, "traits": { - "smithy.api#documentation": "

A collection of settings that apply to users of Amazon SageMaker Studio. These settings are\n specified when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.

\n

\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.

" + "smithy.api#documentation": "

A collection of settings that apply to users in a domain. These settings are\n specified when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.

\n

\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.

" } }, "com.amazonaws.sagemaker#UsersPerStep": { @@ -61593,7 +64049,7 @@ "target": "com.amazonaws.sagemaker#VpcSecurityGroupIds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for\n the VPC that is specified in the Subnets field.

", + "smithy.api#documentation": "

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.

", "smithy.api#required": {} } }, @@ -61607,7 +64063,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a VPC that your training jobs and hosted models have access to. Control\n access to and from your training and model containers by configuring the VPC. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs\n by Using an Amazon Virtual Private Cloud.

" + "smithy.api#documentation": "

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources\n have access to. You can control access to and from your resources by configuring a VPC.\n For more information, see Give SageMaker Access to Resources in your Amazon VPC.

" } }, "com.amazonaws.sagemaker#VpcId": { diff --git a/codegen/sdk-codegen/aws-models/sts.json b/codegen/sdk-codegen/aws-models/sts.json index e8ccef1b150..eabc44ceb77 100644 --- a/codegen/sdk-codegen/aws-models/sts.json +++ b/codegen/sdk-codegen/aws-models/sts.json @@ -2389,7 +2389,7 @@ "ProvidedContexts": { "target": "com.amazonaws.sts#ProvidedContextsListType", "traits": { - "smithy.api#documentation": "

A list of previously acquired trusted context assertions in the format of a JSON array.\n The trusted context assertion is signed and encrypted by Amazon Web Services STS.

\n

The following is an example of a ProvidedContext value that includes a\n single trusted context assertion and the ARN of the context provider from which the trusted\n context assertion was generated.

\n

\n [{\"ProviderArn\":\"arn:aws:iam::aws:contextProvider/identitycenter\",\"ContextAssertion\":\"trusted-context-assertion\"}]\n

" + "smithy.api#documentation": "

A list of previously acquired trusted context assertions in the format of a JSON array.\n The trusted context assertion is signed and encrypted by Amazon Web Services STS.

\n

The following is an example of a ProvidedContext value that includes a\n single trusted context assertion and the ARN of the context provider from which the trusted\n context assertion was generated.

\n

\n [{\"ProviderArn\":\"arn:aws:iam::aws:contextProvider/IdentityCenter\",\"ContextAssertion\":\"trusted-context-assertion\"}]\n

" } } },