diff --git a/.changes/1.33.3.json b/.changes/1.33.3.json new file mode 100644 index 0000000000..956e889e59 --- /dev/null +++ b/.changes/1.33.3.json @@ -0,0 +1,47 @@ +[ + { + "category": "``application-autoscaling``", + "description": "Amazon SageMaker customers can now use Application Auto Scaling to automatically scale the number of Inference Component copies across an endpoint to meet the varying demand of their workloads.", + "type": "api-change" + }, + { + "category": "``cleanrooms``", + "description": "AWS Clean Rooms now provides differential privacy to protect against user-identification attempts and machine learning modeling to allow two parties to identify similar users in their data.", + "type": "api-change" + }, + { + "category": "``cleanroomsml``", + "description": "Public Preview SDK release of AWS Clean Rooms ML APIs", + "type": "api-change" + }, + { + "category": "``opensearch``", + "description": "Launching Amazon OpenSearch Service support for new zero-ETL integration with Amazon S3. Customers can now manage their direct query data sources to Amazon S3 programatically", + "type": "api-change" + }, + { + "category": "``opensearchserverless``", + "description": "Amazon OpenSearch Serverless collections support an additional attribute called standby-replicas. This allows to specify whether a collection should have redundancy enabled.", + "type": "api-change" + }, + { + "category": "``sagemaker-runtime``", + "description": "Update sagemaker-runtime client to latest version", + "type": "api-change" + }, + { + "category": "``sagemaker``", + "description": "This release adds following support 1/ Improved SDK tooling for model deployment. 2/ New Inference Component based features to lower inference costs and latency 3/ SageMaker HyperPod management. 4/ Additional parameters for FM Fine Tuning in Autopilot", + "type": "api-change" + }, + { + "category": "``sts``", + "description": "Documentation updates for AWS Security Token Service.", + "type": "api-change" + }, + { + "category": "``endpoint-rules``", + "description": "Update endpoint-rules client to latest version", + "type": "api-change" + } +] \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a22d9ec407..6ae84b8aa0 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,20 @@ CHANGELOG ========= +1.33.3 +====== + +* api-change:``application-autoscaling``: Amazon SageMaker customers can now use Application Auto Scaling to automatically scale the number of Inference Component copies across an endpoint to meet the varying demand of their workloads. +* api-change:``cleanrooms``: AWS Clean Rooms now provides differential privacy to protect against user-identification attempts and machine learning modeling to allow two parties to identify similar users in their data. +* api-change:``cleanroomsml``: Public Preview SDK release of AWS Clean Rooms ML APIs +* api-change:``opensearch``: Launching Amazon OpenSearch Service support for new zero-ETL integration with Amazon S3. Customers can now manage their direct query data sources to Amazon S3 programatically +* api-change:``opensearchserverless``: Amazon OpenSearch Serverless collections support an additional attribute called standby-replicas. This allows to specify whether a collection should have redundancy enabled. +* api-change:``sagemaker-runtime``: Update sagemaker-runtime client to latest version +* api-change:``sagemaker``: This release adds following support 1/ Improved SDK tooling for model deployment. 2/ New Inference Component based features to lower inference costs and latency 3/ SageMaker HyperPod management. 4/ Additional parameters for FM Fine Tuning in Autopilot +* api-change:``sts``: Documentation updates for AWS Security Token Service. +* api-change:``endpoint-rules``: Update endpoint-rules client to latest version + + 1.33.2 ====== diff --git a/botocore/__init__.py b/botocore/__init__.py index f7b1c60b9b..fdbae38aea 100644 --- a/botocore/__init__.py +++ b/botocore/__init__.py @@ -16,7 +16,7 @@ import os import re -__version__ = '1.33.2' +__version__ = '1.33.3' class NullHandler(logging.Handler): diff --git a/botocore/data/application-autoscaling/2016-02-06/endpoint-rule-set-1.json b/botocore/data/application-autoscaling/2016-02-06/endpoint-rule-set-1.json index 7d892db546..3e4f23e330 100644 --- a/botocore/data/application-autoscaling/2016-02-06/endpoint-rule-set-1.json +++ b/botocore/data/application-autoscaling/2016-02-06/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,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": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,18 +212,17 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ - "aws-us-gov", { "fn": "getAttr", "argv": [ @@ -236,7 +231,8 @@ }, "name" ] - } + }, + "aws-us-gov" ] } ], @@ -256,14 +252,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -277,7 +275,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -297,7 +294,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -308,14 +304,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -326,9 +324,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/botocore/data/application-autoscaling/2016-02-06/service-2.json b/botocore/data/application-autoscaling/2016-02-06/service-2.json index 99b4f5d785..cd24f26ca5 100644 --- a/botocore/data/application-autoscaling/2016-02-06/service-2.json +++ b/botocore/data/application-autoscaling/2016-02-06/service-2.json @@ -27,7 +27,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"

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

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

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

" + "documentation":"

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

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

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

" }, "DeleteScheduledAction":{ "name":"DeleteScheduledAction", @@ -315,11 +315,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" } } }, @@ -347,11 +347,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" } } }, @@ -374,11 +374,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" } } }, @@ -397,11 +397,11 @@ }, "ResourceIds":{ "shape":"ResourceIdsMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

The scalable dimension associated with the scalable target. 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.

" + "documentation":"

The scalable dimension associated with the scalable target. 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.

" }, "MaxResults":{ "shape":"MaxResults", @@ -436,11 +436,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

The scalable dimension. 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.

" + "documentation":"

The scalable dimension. 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.

" }, "MaxResults":{ "shape":"MaxResults", @@ -483,11 +483,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

The scalable dimension. 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.

" + "documentation":"

The scalable dimension. 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.

" }, "MaxResults":{ "shape":"MaxResults", @@ -526,11 +526,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

The scalable dimension. 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.

" + "documentation":"

The scalable dimension. 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.

" }, "MaxResults":{ "shape":"MaxResults", @@ -693,7 +693,8 @@ "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage", "NeptuneReaderAverageCPUUtilization", "SageMakerVariantProvisionedConcurrencyUtilization", - "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage" + "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage", + "SageMakerInferenceComponentInvocationsPerCopy" ] }, "MetricUnit":{"type":"string"}, @@ -759,7 +760,7 @@ "documentation":"

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

" } }, - "documentation":"

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

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

" + "documentation":"

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

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

" }, "PutScalingPolicyRequest":{ "type":"structure", @@ -780,15 +781,15 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" }, "PolicyType":{ "shape":"PolicyType", - "documentation":"

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

The following policy types are supported:

TargetTrackingScaling—Not supported for Amazon EMR

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

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

" + "documentation":"

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

The following policy types are supported:

TargetTrackingScaling—Not supported for Amazon EMR.

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

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

" }, "StepScalingPolicyConfiguration":{ "shape":"StepScalingPolicyConfiguration", @@ -841,11 +842,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" }, "StartTime":{ "shape":"TimestampType", @@ -880,11 +881,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" }, "MinCapacity":{ "shape":"ResourceCapacity", @@ -974,7 +975,8 @@ "elasticache:replication-group:NodeGroups", "elasticache:replication-group:Replicas", "neptune:cluster:ReadReplicaCount", - "sagemaker:variant:DesiredProvisionedConcurrency" + "sagemaker:variant:DesiredProvisionedConcurrency", + "sagemaker:inference-component:DesiredCopyCount" ] }, "ScalableTarget":{ @@ -995,11 +997,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" }, "MinCapacity":{ "shape":"ResourceCapacity", @@ -1073,11 +1075,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" }, "Description":{ "shape":"XmlString", @@ -1156,11 +1158,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" }, "PolicyType":{ "shape":"PolicyType", @@ -1219,11 +1221,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

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

" + "documentation":"

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

" }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

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

" + "documentation":"

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

" }, "StartTime":{ "shape":"TimestampType", @@ -1313,7 +1315,7 @@ }, "Cooldown":{ "shape":"Cooldown", - "documentation":"

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

" + "documentation":"

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

" }, "MetricAggregationType":{ "shape":"MetricAggregationType", @@ -1524,11 +1526,11 @@ }, "ScaleOutCooldown":{ "shape":"Cooldown", - "documentation":"

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

" + "documentation":"

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

" }, "ScaleInCooldown":{ "shape":"Cooldown", - "documentation":"

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

" + "documentation":"

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

" }, "DisableScaleIn":{ "shape":"DisableScaleIn", @@ -1585,5 +1587,5 @@ "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" } }, - "documentation":"

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

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

API Summary

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

" + "documentation":"

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

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

API Summary

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

" } diff --git a/botocore/data/cleanrooms/2022-02-17/paginators-1.json b/botocore/data/cleanrooms/2022-02-17/paginators-1.json index 2320b11e46..1bbb0a6cfd 100644 --- a/botocore/data/cleanrooms/2022-02-17/paginators-1.json +++ b/botocore/data/cleanrooms/2022-02-17/paginators-1.json @@ -53,6 +53,42 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "collaborationAnalysisTemplateSummaries" + }, + "ListCollaborationConfiguredAudienceModelAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "collaborationConfiguredAudienceModelAssociationSummaries" + }, + "ListCollaborationPrivacyBudgetTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "collaborationPrivacyBudgetTemplateSummaries" + }, + "ListCollaborationPrivacyBudgets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "collaborationPrivacyBudgetSummaries" + }, + "ListConfiguredAudienceModelAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "configuredAudienceModelAssociationSummaries" + }, + "ListPrivacyBudgetTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "privacyBudgetTemplateSummaries" + }, + "ListPrivacyBudgets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "privacyBudgetSummaries" } } } diff --git a/botocore/data/cleanrooms/2022-02-17/service-2.json b/botocore/data/cleanrooms/2022-02-17/service-2.json index e0a0b88b7e..a66b1da60e 100644 --- a/botocore/data/cleanrooms/2022-02-17/service-2.json +++ b/botocore/data/cleanrooms/2022-02-17/service-2.json @@ -86,6 +86,26 @@ ], "documentation":"

Creates a new collaboration.

" }, + "CreateConfiguredAudienceModelAssociation":{ + "name":"CreateConfiguredAudienceModelAssociation", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations", + "responseCode":200 + }, + "input":{"shape":"CreateConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"CreateConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

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

" + }, "CreateConfiguredTable":{ "name":"CreateConfiguredTable", "http":{ @@ -167,6 +187,25 @@ ], "documentation":"

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

" }, + "CreatePrivacyBudgetTemplate":{ + "name":"CreatePrivacyBudgetTemplate", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates", + "responseCode":200 + }, + "input":{"shape":"CreatePrivacyBudgetTemplateInput"}, + "output":{"shape":"CreatePrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

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.

" + }, "DeleteAnalysisTemplate":{ "name":"DeleteAnalysisTemplate", "http":{ @@ -204,6 +243,25 @@ "documentation":"

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

", "idempotent":true }, + "DeleteConfiguredAudienceModelAssociation":{ + "name":"DeleteConfiguredAudienceModelAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"DeleteConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

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

", + "idempotent":true + }, "DeleteConfiguredTable":{ "name":"DeleteConfiguredTable", "http":{ @@ -304,6 +362,25 @@ "documentation":"

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

", "idempotent":true }, + "DeletePrivacyBudgetTemplate":{ + "name":"DeletePrivacyBudgetTemplate", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}", + "responseCode":204 + }, + "input":{"shape":"DeletePrivacyBudgetTemplateInput"}, + "output":{"shape":"DeletePrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes a privacy budget template for a specified membership.

", + "idempotent":true + }, "GetAnalysisTemplate":{ "name":"GetAnalysisTemplate", "http":{ @@ -357,6 +434,60 @@ ], "documentation":"

Retrieves an analysis template within a collaboration.

" }, + "GetCollaborationConfiguredAudienceModelAssociation":{ + "name":"GetCollaborationConfiguredAudienceModelAssociation", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetCollaborationConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"GetCollaborationConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Retrieves a configured audience model association within a collaboration.

" + }, + "GetCollaborationPrivacyBudgetTemplate":{ + "name":"GetCollaborationPrivacyBudgetTemplate", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetCollaborationPrivacyBudgetTemplateInput"}, + "output":{"shape":"GetCollaborationPrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns details about a specified privacy budget template.

" + }, + "GetConfiguredAudienceModelAssociation":{ + "name":"GetConfiguredAudienceModelAssociation", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"GetConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns information about a configured audience model association.

" + }, "GetConfiguredTable":{ "name":"GetConfiguredTable", "http":{ @@ -429,6 +560,24 @@ ], "documentation":"

Retrieves a specified membership for an identifier.

" }, + "GetPrivacyBudgetTemplate":{ + "name":"GetPrivacyBudgetTemplate", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}", + "responseCode":200 + }, + "input":{"shape":"GetPrivacyBudgetTemplateInput"}, + "output":{"shape":"GetPrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns details for a specified privacy budget template.

" + }, "GetProtectedQuery":{ "name":"GetProtectedQuery", "http":{ @@ -519,6 +668,60 @@ ], "documentation":"

Lists analysis templates within a collaboration.

" }, + "ListCollaborationConfiguredAudienceModelAssociations":{ + "name":"ListCollaborationConfiguredAudienceModelAssociations", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/configuredaudiencemodelassociations", + "responseCode":200 + }, + "input":{"shape":"ListCollaborationConfiguredAudienceModelAssociationsInput"}, + "output":{"shape":"ListCollaborationConfiguredAudienceModelAssociationsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists configured audience model associations within a collaboration.

" + }, + "ListCollaborationPrivacyBudgetTemplates":{ + "name":"ListCollaborationPrivacyBudgetTemplates", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/privacybudgettemplates", + "responseCode":200 + }, + "input":{"shape":"ListCollaborationPrivacyBudgetTemplatesInput"}, + "output":{"shape":"ListCollaborationPrivacyBudgetTemplatesOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns an array that summarizes each privacy budget template in a specified collaboration.

" + }, + "ListCollaborationPrivacyBudgets":{ + "name":"ListCollaborationPrivacyBudgets", + "http":{ + "method":"GET", + "requestUri":"/collaborations/{collaborationIdentifier}/privacybudgets", + "responseCode":200 + }, + "input":{"shape":"ListCollaborationPrivacyBudgetsInput"}, + "output":{"shape":"ListCollaborationPrivacyBudgetsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

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.

" + }, "ListCollaborations":{ "name":"ListCollaborations", "http":{ @@ -536,6 +739,24 @@ ], "documentation":"

Lists collaborations the caller owns, is active in, or has been invited to.

" }, + "ListConfiguredAudienceModelAssociations":{ + "name":"ListConfiguredAudienceModelAssociations", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations", + "responseCode":200 + }, + "input":{"shape":"ListConfiguredAudienceModelAssociationsInput"}, + "output":{"shape":"ListConfiguredAudienceModelAssociationsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists information about requested configured audience model associations.

" + }, "ListConfiguredTableAssociations":{ "name":"ListConfiguredTableAssociations", "http":{ @@ -606,6 +827,42 @@ ], "documentation":"

Lists all memberships resources within the caller's account.

" }, + "ListPrivacyBudgetTemplates":{ + "name":"ListPrivacyBudgetTemplates", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates", + "responseCode":200 + }, + "input":{"shape":"ListPrivacyBudgetTemplatesInput"}, + "output":{"shape":"ListPrivacyBudgetTemplatesOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns detailed information about the privacy budget templates in a specified membership.

" + }, + "ListPrivacyBudgets":{ + "name":"ListPrivacyBudgets", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgets", + "responseCode":200 + }, + "input":{"shape":"ListPrivacyBudgetsInput"}, + "output":{"shape":"ListPrivacyBudgetsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns detailed information about the privacy budgets in a specified membership.

" + }, "ListProtectedQueries":{ "name":"ListProtectedQueries", "http":{ @@ -657,6 +914,24 @@ ], "documentation":"

Lists all of the tags that have been added to a resource.

" }, + "PreviewPrivacyImpact":{ + "name":"PreviewPrivacyImpact", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/previewprivacyimpact", + "responseCode":200 + }, + "input":{"shape":"PreviewPrivacyImpactInput"}, + "output":{"shape":"PreviewPrivacyImpactOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

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

" + }, "StartProtectedQuery":{ "name":"StartProtectedQuery", "http":{ @@ -741,6 +1016,24 @@ ], "documentation":"

Updates collaboration metadata and can only be called by the collaboration owner.

" }, + "UpdateConfiguredAudienceModelAssociation":{ + "name":"UpdateConfiguredAudienceModelAssociation", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateConfiguredAudienceModelAssociationInput"}, + "output":{"shape":"UpdateConfiguredAudienceModelAssociationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

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

" + }, "UpdateConfiguredTable":{ "name":"UpdateConfiguredTable", "http":{ @@ -817,6 +1110,25 @@ ], "documentation":"

Updates a membership.

" }, + "UpdatePrivacyBudgetTemplate":{ + "name":"UpdatePrivacyBudgetTemplate", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/privacybudgettemplates/{privacyBudgetTemplateIdentifier}", + "responseCode":200 + }, + "input":{"shape":"UpdatePrivacyBudgetTemplateInput"}, + "output":{"shape":"UpdatePrivacyBudgetTemplateOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates the privacy budget template for the specified membership.

" + }, "UpdateProtectedQuery":{ "name":"UpdateProtectedQuery", "http":{ @@ -1084,9 +1396,13 @@ "allowedAnalysisProviders":{ "shape":"AnalysisRuleCustomAllowedAnalysisProvidersList", "documentation":"

The Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.

" + }, + "differentialPrivacy":{ + "shape":"DifferentialPrivacyConfiguration", + "documentation":"

The differential privacy configuration.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "AnalysisRuleCustomAllowedAnalysesList":{ "type":"list", @@ -1703,58 +2019,343 @@ "min":0, "pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:collaboration/[\\d\\w-]+" }, - "CollaborationDescription":{ - "type":"string", - "max":255, - "min":1, - "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*" - }, - "CollaborationIdentifier":{ - "type":"string", - "max":36, - "min":36, - "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" - }, - "CollaborationName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" - }, - "CollaborationQueryLogStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "CollaborationSummary":{ + "CollaborationConfiguredAudienceModelAssociation":{ "type":"structure", "required":[ "id", "arn", + "collaborationId", + "collaborationArn", + "configuredAudienceModelArn", "name", "creatorAccountId", - "creatorDisplayName", "createTime", - "updateTime", - "memberStatus" + "updateTime" ], "members":{ "id":{ - "shape":"UUID", - "documentation":"

The identifier for the collaboration.

" + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"

The identifier of the configured audience model association.

" }, "arn":{ + "shape":"ConfiguredAudienceModelAssociationArn", + "documentation":"

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

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "collaborationArn":{ "shape":"CollaborationArn", - "documentation":"

The ARN of the collaboration.

" + "documentation":"

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

" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

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

" }, "name":{ - "shape":"CollaborationName", - "documentation":"

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

" + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"

The name of the configured audience model association.

" }, - "creatorAccountId":{ - "shape":"AccountId", + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the configured audience model association.

" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"

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

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + } + }, + "documentation":"

The configured audience model association within a collaboration.

" + }, + "CollaborationConfiguredAudienceModelAssociationSummary":{ + "type":"structure", + "required":[ + "arn", + "createTime", + "id", + "name", + "updateTime", + "collaborationArn", + "collaborationId", + "creatorAccountId" + ], + "members":{ + "arn":{ + "shape":"ConfiguredAudienceModelAssociationArn", + "documentation":"

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

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "id":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"

The identifier of the configured audience model association.

" + }, + "name":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"

The name of the configured audience model association.

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"

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

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"

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

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the configured audience model association.

" + } + }, + "documentation":"

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

" + }, + "CollaborationConfiguredAudienceModelAssociationSummaryList":{ + "type":"list", + "member":{"shape":"CollaborationConfiguredAudienceModelAssociationSummary"} + }, + "CollaborationDescription":{ + "type":"string", + "max":255, + "min":1, + "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*" + }, + "CollaborationIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "CollaborationName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" + }, + "CollaborationPrivacyBudgetSummary":{ + "type":"structure", + "required":[ + "id", + "privacyBudgetTemplateId", + "privacyBudgetTemplateArn", + "collaborationId", + "collaborationArn", + "creatorAccountId", + "type", + "createTime", + "updateTime", + "budget" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"

The unique identifier of the collaboration privacy budget.

" + }, + "privacyBudgetTemplateId":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

The unique identifier of the collaboration privacy budget template.

" + }, + "privacyBudgetTemplateArn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"

The ARN of the collaboration privacy budget template.

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"

The ARN of the collaboration that includes this privacy budget.

" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"

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

" + }, + "type":{ + "shape":"PrivacyBudgetType", + "documentation":"

The type of privacy budget template.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the privacy budget was created.

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "budget":{ + "shape":"PrivacyBudget", + "documentation":"

The includes epsilon provided and utility in terms of aggregations.

" + } + }, + "documentation":"

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

" + }, + "CollaborationPrivacyBudgetSummaryList":{ + "type":"list", + "member":{"shape":"CollaborationPrivacyBudgetSummary"} + }, + "CollaborationPrivacyBudgetTemplate":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationId", + "collaborationArn", + "creatorAccountId", + "createTime", + "updateTime", + "privacyBudgetType", + "autoRefresh", + "parameters" + ], + "members":{ + "id":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

The unique identifier of the collaboration privacy budget template.

" + }, + "arn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"

The ARN of the collaboration privacy budget template.

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"

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

" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"

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

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"

The type of privacy budget template.

" + }, + "autoRefresh":{ + "shape":"PrivacyBudgetTemplateAutoRefresh", + "documentation":"

How often the privacy budget refreshes.

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.

" + }, + "parameters":{ + "shape":"PrivacyBudgetTemplateParametersOutput", + "documentation":"

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

" + } + }, + "documentation":"

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

" + }, + "CollaborationPrivacyBudgetTemplateSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "collaborationId", + "collaborationArn", + "creatorAccountId", + "privacyBudgetType", + "createTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

The unique identifier of the collaboration privacy budget template.

" + }, + "arn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"

The ARN of the collaboration privacy budget template.

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"

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

" + }, + "creatorAccountId":{ + "shape":"AccountId", + "documentation":"

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

" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"

The type of the privacy budget template.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + } + }, + "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.

" + }, + "CollaborationPrivacyBudgetTemplateSummaryList":{ + "type":"list", + "member":{"shape":"CollaborationPrivacyBudgetTemplateSummary"} + }, + "CollaborationQueryLogStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "CollaborationSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "name", + "creatorAccountId", + "creatorDisplayName", + "createTime", + "updateTime", + "memberStatus" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"

The identifier for the collaboration.

" + }, + "arn":{ + "shape":"CollaborationArn", + "documentation":"

The ARN of the collaboration.

" + }, + "name":{ + "shape":"CollaborationName", + "documentation":"

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

" + }, + "creatorAccountId":{ + "shape":"AccountId", "documentation":"

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

" }, "creatorDisplayName":{ @@ -1822,6 +2423,163 @@ "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" }, + "ConfiguredAudienceModelArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+" + }, + "ConfiguredAudienceModelAssociation":{ + "type":"structure", + "required":[ + "id", + "arn", + "configuredAudienceModelArn", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "name", + "manageResourcePolicies", + "createTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"

A unique identifier of the configured audience model association.

" + }, + "arn":{ + "shape":"ConfiguredAudienceModelAssociationArn", + "documentation":"

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

" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

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

" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"

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

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"

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

" + }, + "name":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"

The name of the configured audience model association.

" + }, + "manageResourcePolicies":{ + "shape":"Boolean", + "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.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the configured audience model association.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + } + }, + "documentation":"

Details about the configured audience model association.

" + }, + "ConfiguredAudienceModelAssociationArn":{ + "type":"string", + "max":256, + "min":0, + "pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/configuredaudiencemodelassociation/[\\d\\w-]+" + }, + "ConfiguredAudienceModelAssociationIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "ConfiguredAudienceModelAssociationName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" + }, + "ConfiguredAudienceModelAssociationSummary":{ + "type":"structure", + "required":[ + "membershipId", + "membershipArn", + "collaborationArn", + "collaborationId", + "createTime", + "updateTime", + "id", + "arn", + "name", + "configuredAudienceModelArn" + ], + "members":{ + "membershipId":{ + "shape":"MembershipIdentifier", + "documentation":"

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

" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"

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

" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"

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

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "id":{ + "shape":"UUID", + "documentation":"

A unique identifier of the configured audience model association.

" + }, + "arn":{ + "shape":"ConfiguredAudienceModelAssociationArn", + "documentation":"

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

" + }, + "name":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"

The name of the configured audience model association.

" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

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

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the configured audience model association.

" + } + }, + "documentation":"

A summary of the configured audience model association.

" + }, + "ConfiguredAudienceModelAssociationSummaryList":{ + "type":"list", + "member":{"shape":"ConfiguredAudienceModelAssociationSummary"} + }, "ConfiguredTable":{ "type":"structure", "required":[ @@ -2286,6 +3044,53 @@ } } }, + "CreateConfiguredAudienceModelAssociationInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredAudienceModelArn", + "configuredAudienceModelAssociationName", + "manageResourcePolicies" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

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

" + }, + "configuredAudienceModelAssociationName":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"

The name of the configured audience model association.

" + }, + "manageResourcePolicies":{ + "shape":"Boolean", + "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.

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.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

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

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

A description of the configured audience model association.

" + } + } + }, + "CreateConfiguredAudienceModelAssociationOutput":{ + "type":"structure", + "required":["configuredAudienceModelAssociation"], + "members":{ + "configuredAudienceModelAssociation":{ + "shape":"ConfiguredAudienceModelAssociation", + "documentation":"

Information about the configured audience model association.

" + } + } + }, "CreateConfiguredTableAnalysisRuleInput":{ "type":"structure", "required":[ @@ -2430,24 +3235,67 @@ "tags":{ "shape":"TagMap", "documentation":"

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

" - }, - "defaultResultConfiguration":{ - "shape":"MembershipProtectedQueryResultConfiguration", - "documentation":"

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

" - }, - "paymentConfiguration":{ - "shape":"MembershipPaymentConfiguration", - "documentation":"

The payment responsibilities accepted by the collaboration member.

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

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

" + }, + "defaultResultConfiguration":{ + "shape":"MembershipProtectedQueryResultConfiguration", + "documentation":"

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

" + }, + "paymentConfiguration":{ + "shape":"MembershipPaymentConfiguration", + "documentation":"

The payment responsibilities accepted by the collaboration member.

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

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

" + } + } + }, + "CreateMembershipOutput":{ + "type":"structure", + "required":["membership"], + "members":{ + "membership":{ + "shape":"Membership", + "documentation":"

The membership that was created.

" + } + } + }, + "CreatePrivacyBudgetTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "autoRefresh", + "privacyBudgetType", + "parameters" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "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.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "autoRefresh":{ + "shape":"PrivacyBudgetTemplateAutoRefresh", + "documentation":"

How often the privacy budget refreshes.

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

" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"

Specifies the type of the privacy budget template.

" + }, + "parameters":{ + "shape":"PrivacyBudgetTemplateParametersInput", + "documentation":"

Specifies your parameters for the privacy budget template.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

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

" } } }, - "CreateMembershipOutput":{ + "CreatePrivacyBudgetTemplateOutput":{ "type":"structure", - "required":["membership"], + "required":["privacyBudgetTemplate"], "members":{ - "membership":{ - "shape":"Membership", - "documentation":"

The membership that was created.

" + "privacyBudgetTemplate":{ + "shape":"PrivacyBudgetTemplate", + "documentation":"

A summary of the elements in the privacy budget template.

" } } }, @@ -2522,6 +3370,32 @@ "members":{ } }, + "DeleteConfiguredAudienceModelAssociationInput":{ + "type":"structure", + "required":[ + "configuredAudienceModelAssociationIdentifier", + "membershipIdentifier" + ], + "members":{ + "configuredAudienceModelAssociationIdentifier":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"configuredAudienceModelAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"membershipIdentifier" + } + } + }, + "DeleteConfiguredAudienceModelAssociationOutput":{ + "type":"structure", + "members":{ + } + }, "DeleteConfiguredTableAnalysisRuleInput":{ "type":"structure", "required":[ @@ -2636,6 +3510,286 @@ "members":{ } }, + "DeletePrivacyBudgetTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "privacyBudgetTemplateIdentifier" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "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.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "privacyBudgetTemplateIdentifier":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

A unique identifier for your privacy budget template.

", + "location":"uri", + "locationName":"privacyBudgetTemplateIdentifier" + } + } + }, + "DeletePrivacyBudgetTemplateOutput":{ + "type":"structure", + "members":{ + } + }, + "DifferentialPrivacyAggregationExpression":{ + "type":"string", + "min":1 + }, + "DifferentialPrivacyAggregationType":{ + "type":"string", + "enum":[ + "AVG", + "COUNT", + "COUNT_DISTINCT", + "SUM", + "STDDEV" + ] + }, + "DifferentialPrivacyColumn":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"

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.

" + } + }, + "documentation":"

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

" + }, + "DifferentialPrivacyColumnList":{ + "type":"list", + "member":{"shape":"DifferentialPrivacyColumn"}, + "max":1, + "min":1 + }, + "DifferentialPrivacyConfiguration":{ + "type":"structure", + "required":["columns"], + "members":{ + "columns":{ + "shape":"DifferentialPrivacyColumnList", + "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.

" + } + }, + "documentation":"

Specifies the unique identifier for your users.

" + }, + "DifferentialPrivacyParameters":{ + "type":"structure", + "required":["sensitivityParameters"], + "members":{ + "sensitivityParameters":{ + "shape":"DifferentialPrivacySensitivityParametersList", + "documentation":"

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

" + } + }, + "documentation":"

An array that contains the sensitivity parameters.

" + }, + "DifferentialPrivacyPreviewAggregation":{ + "type":"structure", + "required":[ + "type", + "maxCount" + ], + "members":{ + "type":{ + "shape":"DifferentialPrivacyAggregationType", + "documentation":"

The type of aggregation function.

" + }, + "maxCount":{ + "shape":"DifferentialPrivacyPreviewAggregationMaxCountInteger", + "documentation":"

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

" + } + }, + "documentation":"

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

" + }, + "DifferentialPrivacyPreviewAggregationList":{ + "type":"list", + "member":{"shape":"DifferentialPrivacyPreviewAggregation"} + }, + "DifferentialPrivacyPreviewAggregationMaxCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "DifferentialPrivacyPreviewParametersInput":{ + "type":"structure", + "required":[ + "epsilon", + "usersNoisePerQuery" + ], + "members":{ + "epsilon":{ + "shape":"Epsilon", + "documentation":"

The epsilon value that you want to preview.

" + }, + "usersNoisePerQuery":{ + "shape":"UsersNoisePerQuery", + "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.

" + } + }, + "documentation":"

The epsilon and noise parameters that you want to preview.

" + }, + "DifferentialPrivacyPrivacyBudget":{ + "type":"structure", + "required":[ + "aggregations", + "epsilon" + ], + "members":{ + "aggregations":{ + "shape":"DifferentialPrivacyPrivacyBudgetAggregationList", + "documentation":"

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

" + }, + "epsilon":{ + "shape":"Epsilon", + "documentation":"

The epsilon value that you configured.

" + } + }, + "documentation":"

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

" + }, + "DifferentialPrivacyPrivacyBudgetAggregation":{ + "type":"structure", + "required":[ + "type", + "maxCount", + "remainingCount" + ], + "members":{ + "type":{ + "shape":"DifferentialPrivacyAggregationType", + "documentation":"

The different types of aggregation functions that you can perform.

" + }, + "maxCount":{ + "shape":"DifferentialPrivacyPrivacyBudgetAggregationMaxCountInteger", + "documentation":"

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

" + }, + "remainingCount":{ + "shape":"DifferentialPrivacyPrivacyBudgetAggregationRemainingCountInteger", + "documentation":"

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

" + } + }, + "documentation":"

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

" + }, + "DifferentialPrivacyPrivacyBudgetAggregationList":{ + "type":"list", + "member":{"shape":"DifferentialPrivacyPrivacyBudgetAggregation"} + }, + "DifferentialPrivacyPrivacyBudgetAggregationMaxCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "DifferentialPrivacyPrivacyBudgetAggregationRemainingCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "DifferentialPrivacyPrivacyImpact":{ + "type":"structure", + "required":["aggregations"], + "members":{ + "aggregations":{ + "shape":"DifferentialPrivacyPreviewAggregationList", + "documentation":"

The number of aggregation functions that you can perform.

" + } + }, + "documentation":"

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

" + }, + "DifferentialPrivacySensitivityParameters":{ + "type":"structure", + "required":[ + "aggregationType", + "aggregationExpression", + "userContributionLimit" + ], + "members":{ + "aggregationType":{ + "shape":"DifferentialPrivacyAggregationType", + "documentation":"

The type of aggregation function that was run.

" + }, + "aggregationExpression":{ + "shape":"DifferentialPrivacyAggregationExpression", + "documentation":"

The aggregation expression that was run.

" + }, + "userContributionLimit":{ + "shape":"DifferentialPrivacySensitivityParametersUserContributionLimitInteger", + "documentation":"

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

" + }, + "minColumnValue":{ + "shape":"Float", + "documentation":"

The lower bound of the aggregation expression.

" + }, + "maxColumnValue":{ + "shape":"Float", + "documentation":"

The upper bound of the aggregation expression.

" + } + }, + "documentation":"

Provides the sensitivity parameters.

" + }, + "DifferentialPrivacySensitivityParametersList":{ + "type":"list", + "member":{"shape":"DifferentialPrivacySensitivityParameters"} + }, + "DifferentialPrivacySensitivityParametersUserContributionLimitInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "DifferentialPrivacyTemplateParametersInput":{ + "type":"structure", + "required":[ + "epsilon", + "usersNoisePerQuery" + ], + "members":{ + "epsilon":{ + "shape":"Epsilon", + "documentation":"

The epsilon value that you want to use.

" + }, + "usersNoisePerQuery":{ + "shape":"UsersNoisePerQuery", + "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.

" + } + }, + "documentation":"

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

" + }, + "DifferentialPrivacyTemplateParametersOutput":{ + "type":"structure", + "required":[ + "epsilon", + "usersNoisePerQuery" + ], + "members":{ + "epsilon":{ + "shape":"Epsilon", + "documentation":"

The epsilon value that you specified.

" + }, + "usersNoisePerQuery":{ + "shape":"UsersNoisePerQuery", + "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.

" + } + }, + "documentation":"

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

" + }, + "DifferentialPrivacyTemplateUpdateParameters":{ + "type":"structure", + "members":{ + "epsilon":{ + "shape":"Epsilon", + "documentation":"

The updated epsilon value that you want to use.

" + }, + "usersNoisePerQuery":{ + "shape":"UsersNoisePerQuery", + "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.

" + } + }, + "documentation":"

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

" + }, "DisplayName":{ "type":"string", "max":100, @@ -2646,6 +3800,12 @@ "type":"double", "box":true }, + "Epsilon":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, "FilterableMemberStatus":{ "type":"string", "enum":[ @@ -2653,6 +3813,10 @@ "ACTIVE" ] }, + "Float":{ + "type":"float", + "box":true + }, "GetAnalysisTemplateInput":{ "type":"structure", "required":[ @@ -2674,66 +3838,159 @@ } } }, - "GetAnalysisTemplateOutput":{ + "GetAnalysisTemplateOutput":{ + "type":"structure", + "required":["analysisTemplate"], + "members":{ + "analysisTemplate":{ + "shape":"AnalysisTemplate", + "documentation":"

The analysis template.

" + } + } + }, + "GetCollaborationAnalysisTemplateInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "analysisTemplateArn" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "analysisTemplateArn":{ + "shape":"AnalysisTemplateArn", + "documentation":"

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

", + "location":"uri", + "locationName":"analysisTemplateArn" + } + } + }, + "GetCollaborationAnalysisTemplateOutput":{ + "type":"structure", + "required":["collaborationAnalysisTemplate"], + "members":{ + "collaborationAnalysisTemplate":{ + "shape":"CollaborationAnalysisTemplate", + "documentation":"

The analysis template within a collaboration.

" + } + } + }, + "GetCollaborationConfiguredAudienceModelAssociationInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "configuredAudienceModelAssociationIdentifier" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "configuredAudienceModelAssociationIdentifier":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"configuredAudienceModelAssociationIdentifier" + } + } + }, + "GetCollaborationConfiguredAudienceModelAssociationOutput":{ + "type":"structure", + "required":["collaborationConfiguredAudienceModelAssociation"], + "members":{ + "collaborationConfiguredAudienceModelAssociation":{ + "shape":"CollaborationConfiguredAudienceModelAssociation", + "documentation":"

The metadata of the configured audience model association.

" + } + } + }, + "GetCollaborationInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"

The identifier for the collaboration.

", + "location":"uri", + "locationName":"collaborationIdentifier" + } + } + }, + "GetCollaborationOutput":{ "type":"structure", - "required":["analysisTemplate"], + "required":["collaboration"], "members":{ - "analysisTemplate":{ - "shape":"AnalysisTemplate", - "documentation":"

The analysis template.

" + "collaboration":{ + "shape":"Collaboration", + "documentation":"

The entire collaboration for this identifier.

" } } }, - "GetCollaborationAnalysisTemplateInput":{ + "GetCollaborationPrivacyBudgetTemplateInput":{ "type":"structure", "required":[ "collaborationIdentifier", - "analysisTemplateArn" + "privacyBudgetTemplateIdentifier" ], "members":{ "collaborationIdentifier":{ "shape":"CollaborationIdentifier", - "documentation":"

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

", + "documentation":"

A unique identifier for one of your collaborations.

", "location":"uri", "locationName":"collaborationIdentifier" }, - "analysisTemplateArn":{ - "shape":"AnalysisTemplateArn", - "documentation":"

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

", + "privacyBudgetTemplateIdentifier":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

A unique identifier for one of your privacy budget templates.

", "location":"uri", - "locationName":"analysisTemplateArn" + "locationName":"privacyBudgetTemplateIdentifier" } } }, - "GetCollaborationAnalysisTemplateOutput":{ + "GetCollaborationPrivacyBudgetTemplateOutput":{ "type":"structure", - "required":["collaborationAnalysisTemplate"], + "required":["collaborationPrivacyBudgetTemplate"], "members":{ - "collaborationAnalysisTemplate":{ - "shape":"CollaborationAnalysisTemplate", - "documentation":"

The analysis template within a collaboration.

" + "collaborationPrivacyBudgetTemplate":{ + "shape":"CollaborationPrivacyBudgetTemplate", + "documentation":"

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

" } } }, - "GetCollaborationInput":{ + "GetConfiguredAudienceModelAssociationInput":{ "type":"structure", - "required":["collaborationIdentifier"], + "required":[ + "configuredAudienceModelAssociationIdentifier", + "membershipIdentifier" + ], "members":{ - "collaborationIdentifier":{ - "shape":"CollaborationIdentifier", - "documentation":"

The identifier for the collaboration.

", + "configuredAudienceModelAssociationIdentifier":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"

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

", "location":"uri", - "locationName":"collaborationIdentifier" + "locationName":"configuredAudienceModelAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"membershipIdentifier" } } }, - "GetCollaborationOutput":{ + "GetConfiguredAudienceModelAssociationOutput":{ "type":"structure", - "required":["collaboration"], + "required":["configuredAudienceModelAssociation"], "members":{ - "collaboration":{ - "shape":"Collaboration", - "documentation":"

The entire collaboration for this identifier.

" + "configuredAudienceModelAssociation":{ + "shape":"ConfiguredAudienceModelAssociation", + "documentation":"

Information about the configured audience model association that you requested.

" } } }, @@ -2843,6 +4100,37 @@ } } }, + "GetPrivacyBudgetTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "privacyBudgetTemplateIdentifier" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "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.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "privacyBudgetTemplateIdentifier":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

A unique identifier for your privacy budget template.

", + "location":"uri", + "locationName":"privacyBudgetTemplateIdentifier" + } + } + }, + "GetPrivacyBudgetTemplateOutput":{ + "type":"structure", + "required":["privacyBudgetTemplate"], + "members":{ + "privacyBudgetTemplate":{ + "shape":"PrivacyBudgetTemplate", + "documentation":"

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

" + } + } + }, "GetProtectedQueryInput":{ "type":"structure", "required":[ @@ -3082,6 +4370,129 @@ } } }, + "ListCollaborationConfiguredAudienceModelAssociationsInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListCollaborationConfiguredAudienceModelAssociationsOutput":{ + "type":"structure", + "required":["collaborationConfiguredAudienceModelAssociationSummaries"], + "members":{ + "collaborationConfiguredAudienceModelAssociationSummaries":{ + "shape":"CollaborationConfiguredAudienceModelAssociationSummaryList", + "documentation":"

The metadata of the configured audience model association within a collaboration.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + } + } + }, + "ListCollaborationPrivacyBudgetTemplatesInput":{ + "type":"structure", + "required":["collaborationIdentifier"], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"

A unique identifier for one of your collaborations.

", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListCollaborationPrivacyBudgetTemplatesOutput":{ + "type":"structure", + "required":["collaborationPrivacyBudgetTemplateSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + }, + "collaborationPrivacyBudgetTemplateSummaries":{ + "shape":"CollaborationPrivacyBudgetTemplateSummaryList", + "documentation":"

An array that summarizes the collaboration privacy budget templates. The summary includes collaboration information, creation information, the privacy budget type.

" + } + } + }, + "ListCollaborationPrivacyBudgetsInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "privacyBudgetType" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"

A unique identifier for one of your collaborations.

", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"

Specifies the type of the privacy budget.

", + "location":"querystring", + "locationName":"privacyBudgetType" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListCollaborationPrivacyBudgetsOutput":{ + "type":"structure", + "required":["collaborationPrivacyBudgetSummaries"], + "members":{ + "collaborationPrivacyBudgetSummaries":{ + "shape":"CollaborationPrivacyBudgetSummaryList", + "documentation":"

Summaries of the collaboration privacy budgets.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + } + } + }, "ListCollaborationsInput":{ "type":"structure", "members":{ @@ -3119,6 +4530,44 @@ } } }, + "ListConfiguredAudienceModelAssociationsInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListConfiguredAudienceModelAssociationsOutput":{ + "type":"structure", + "required":["configuredAudienceModelAssociationSummaries"], + "members":{ + "configuredAudienceModelAssociationSummaries":{ + "shape":"ConfiguredAudienceModelAssociationSummaryList", + "documentation":"

Summaries of the configured audience model associations that you requested.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value provided to access the next page of results.

" + } + } + }, "ListConfiguredTableAssociationsInput":{ "type":"structure", "required":["membershipIdentifier"], @@ -3245,21 +4694,106 @@ "shape":"MembershipStatus", "documentation":"

A filter which will return only memberships in the specified status.

", "location":"querystring", - "locationName":"status" + "locationName":"status" + } + } + }, + "ListMembershipsOutput":{ + "type":"structure", + "required":["membershipSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + }, + "membershipSummaries":{ + "shape":"MembershipSummaryList", + "documentation":"

The list of memberships returned from the ListMemberships operation.

" + } + } + }, + "ListPrivacyBudgetTemplatesInput":{ + "type":"structure", + "required":["membershipIdentifier"], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "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.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListPrivacyBudgetTemplatesOutput":{ + "type":"structure", + "required":["privacyBudgetTemplateSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + }, + "privacyBudgetTemplateSummaries":{ + "shape":"PrivacyBudgetTemplateSummaryList", + "documentation":"

An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.

" + } + } + }, + "ListPrivacyBudgetsInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "privacyBudgetType" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "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.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"

The privacy budget type.

", + "location":"querystring", + "locationName":"privacyBudgetType" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", + "location":"querystring", + "locationName":"maxResults" } } }, - "ListMembershipsOutput":{ + "ListPrivacyBudgetsOutput":{ "type":"structure", - "required":["membershipSummaries"], + "required":["privacyBudgetSummaries"], "members":{ + "privacyBudgetSummaries":{ + "shape":"PrivacyBudgetSummaryList", + "documentation":"

An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.

" + }, "nextToken":{ "shape":"PaginationToken", "documentation":"

The token value retrieved from a previous call to access the next page of results.

" - }, - "membershipSummaries":{ - "shape":"MembershipSummaryList", - "documentation":"

The list of memberships returned from the ListMemberships operation.

" } } }, @@ -3764,6 +5298,311 @@ }, "documentation":"

An object representing the collaboration member's payment responsibilities set by the collaboration creator.

" }, + "PreviewPrivacyImpactInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "parameters" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

A unique identifier for one of your memberships for a collaboration. Accepts a membership ID.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "parameters":{ + "shape":"PreviewPrivacyImpactParametersInput", + "documentation":"

Specifies the desired epsilon and noise parameters to preview.

" + } + } + }, + "PreviewPrivacyImpactOutput":{ + "type":"structure", + "required":["privacyImpact"], + "members":{ + "privacyImpact":{ + "shape":"PrivacyImpact", + "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.

" + } + } + }, + "PreviewPrivacyImpactParametersInput":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyPreviewParametersInput", + "documentation":"

An array that specifies the epsilon and noise parameters.

" + } + }, + "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.

", + "union":true + }, + "PrivacyBudget":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyPrivacyBudget", + "documentation":"

An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.

" + } + }, + "documentation":"

The epsilon parameter value and number of each aggregation function that you can perform.

", + "union":true + }, + "PrivacyBudgetSummary":{ + "type":"structure", + "required":[ + "id", + "privacyBudgetTemplateId", + "privacyBudgetTemplateArn", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "type", + "createTime", + "updateTime", + "budget" + ], + "members":{ + "id":{ + "shape":"UUID", + "documentation":"

The unique identifier of the privacy budget.

" + }, + "privacyBudgetTemplateId":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

The unique identifier of the privacy budget template.

" + }, + "privacyBudgetTemplateArn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"

The ARN of the privacy budget template.

" + }, + "membershipId":{ + "shape":"MembershipIdentifier", + "documentation":"

The identifier for a membership resource.

" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"

The Amazon Resource Name (ARN) of the member who created the privacy budget summary.

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"

The ARN of the collaboration that contains this privacy budget.

" + }, + "type":{ + "shape":"PrivacyBudgetType", + "documentation":"

Specifies the type of the privacy budget.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the privacy budget was created.

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "budget":{ + "shape":"PrivacyBudget", + "documentation":"

The provided privacy budget.

" + } + }, + "documentation":"

An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.

" + }, + "PrivacyBudgetSummaryList":{ + "type":"list", + "member":{"shape":"PrivacyBudgetSummary"} + }, + "PrivacyBudgetTemplate":{ + "type":"structure", + "required":[ + "id", + "arn", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "createTime", + "updateTime", + "privacyBudgetType", + "autoRefresh", + "parameters" + ], + "members":{ + "id":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

The unique identifier of the privacy budget template.

" + }, + "arn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"

The ARN of the privacy budget template.

" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"

The identifier for a membership resource.

" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"

The Amazon Resource Name (ARN) of the member who created the privacy budget template.

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"

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

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the privacy budget template was created.

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"

Specifies the type of the privacy budget template.

" + }, + "autoRefresh":{ + "shape":"PrivacyBudgetTemplateAutoRefresh", + "documentation":"

How often the privacy budget refreshes.

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.

" + }, + "parameters":{ + "shape":"PrivacyBudgetTemplateParametersOutput", + "documentation":"

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

" + } + }, + "documentation":"

An object that defines the privacy budget template.

" + }, + "PrivacyBudgetTemplateArn":{ + "type":"string", + "max":100, + "min":0, + "pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:privacybudgettemplate/[\\d\\w-]+" + }, + "PrivacyBudgetTemplateAutoRefresh":{ + "type":"string", + "enum":[ + "CALENDAR_MONTH", + "NONE" + ] + }, + "PrivacyBudgetTemplateIdentifier":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "PrivacyBudgetTemplateParametersInput":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyTemplateParametersInput", + "documentation":"

An object that specifies the epsilon and noise parameters.

" + } + }, + "documentation":"

The epsilon and noise parameters that you want to use for the privacy budget template.

", + "union":true + }, + "PrivacyBudgetTemplateParametersOutput":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyTemplateParametersOutput", + "documentation":"

The epsilon and noise parameters.

" + } + }, + "documentation":"

The epsilon and noise parameters that were used in the privacy budget template.

", + "union":true + }, + "PrivacyBudgetTemplateSummary":{ + "type":"structure", + "required":[ + "id", + "arn", + "membershipId", + "membershipArn", + "collaborationId", + "collaborationArn", + "privacyBudgetType", + "createTime", + "updateTime" + ], + "members":{ + "id":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

The unique identifier of the privacy budget template.

" + }, + "arn":{ + "shape":"PrivacyBudgetTemplateArn", + "documentation":"

The ARN of the privacy budget template.

" + }, + "membershipId":{ + "shape":"UUID", + "documentation":"

The identifier for a membership resource.

" + }, + "membershipArn":{ + "shape":"MembershipArn", + "documentation":"

The Amazon Resource Name (ARN) of the member who created the privacy budget template.

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

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

" + }, + "collaborationArn":{ + "shape":"CollaborationArn", + "documentation":"

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

" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"

The type of the privacy budget template.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the privacy budget template was created.

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

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

" + } + }, + "documentation":"

A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.

" + }, + "PrivacyBudgetTemplateSummaryList":{ + "type":"list", + "member":{"shape":"PrivacyBudgetTemplateSummary"} + }, + "PrivacyBudgetTemplateUpdateParameters":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyTemplateUpdateParameters", + "documentation":"

An object that specifies the new values for the epsilon and noise parameters.

" + } + }, + "documentation":"

The epsilon and noise parameters that you want to update in the privacy budget template.

", + "union":true + }, + "PrivacyBudgetType":{ + "type":"string", + "enum":["DIFFERENTIAL_PRIVACY"] + }, + "PrivacyImpact":{ + "type":"structure", + "members":{ + "differentialPrivacy":{ + "shape":"DifferentialPrivacyPrivacyImpact", + "documentation":"

An object that lists the number and type of aggregation functions you can perform.

" + } + }, + "documentation":"

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

", + "union":true + }, "ProtectedQuery":{ "type":"structure", "required":[ @@ -3813,6 +5652,10 @@ "error":{ "shape":"ProtectedQueryError", "documentation":"

An error thrown by the protected query.

" + }, + "differentialPrivacy":{ + "shape":"DifferentialPrivacyParameters", + "documentation":"

The sensitivity parameters of the differential privacy results of the protected query.

" } }, "documentation":"

The parameters for an Clean Rooms protected query.

" @@ -4512,6 +6355,45 @@ } } }, + "UpdateConfiguredAudienceModelAssociationInput":{ + "type":"structure", + "required":[ + "configuredAudienceModelAssociationIdentifier", + "membershipIdentifier" + ], + "members":{ + "configuredAudienceModelAssociationIdentifier":{ + "shape":"ConfiguredAudienceModelAssociationIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"configuredAudienceModelAssociationIdentifier" + }, + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

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

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

A new description for the configured audience model association.

" + }, + "name":{ + "shape":"ConfiguredAudienceModelAssociationName", + "documentation":"

A new name for the configured audience model association.

" + } + } + }, + "UpdateConfiguredAudienceModelAssociationOutput":{ + "type":"structure", + "required":["configuredAudienceModelAssociation"], + "members":{ + "configuredAudienceModelAssociation":{ + "shape":"ConfiguredAudienceModelAssociation", + "documentation":"

Details about the configured audience model association that you updated.

" + } + } + }, "UpdateConfiguredTableAnalysisRuleInput":{ "type":"structure", "required":[ @@ -4644,6 +6526,46 @@ "membership":{"shape":"Membership"} } }, + "UpdatePrivacyBudgetTemplateInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "privacyBudgetTemplateIdentifier", + "privacyBudgetType" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "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.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "privacyBudgetTemplateIdentifier":{ + "shape":"PrivacyBudgetTemplateIdentifier", + "documentation":"

A unique identifier for your privacy budget template that you want to update.

", + "location":"uri", + "locationName":"privacyBudgetTemplateIdentifier" + }, + "privacyBudgetType":{ + "shape":"PrivacyBudgetType", + "documentation":"

Specifies the type of the privacy budget template.

" + }, + "parameters":{ + "shape":"PrivacyBudgetTemplateUpdateParameters", + "documentation":"

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

" + } + } + }, + "UpdatePrivacyBudgetTemplateOutput":{ + "type":"structure", + "required":["privacyBudgetTemplate"], + "members":{ + "privacyBudgetTemplate":{ + "shape":"PrivacyBudgetTemplate", + "documentation":"

Summary of the privacy budget template.

" + } + } + }, "UpdateProtectedQueryInput":{ "type":"structure", "required":[ @@ -4680,6 +6602,12 @@ } } }, + "UsersNoisePerQuery":{ + "type":"integer", + "box":true, + "max":100, + "min":10 + }, "ValidationException":{ "type":"structure", "members":{ diff --git a/botocore/data/cleanroomsml/2023-09-06/endpoint-rule-set-1.json b/botocore/data/cleanroomsml/2023-09-06/endpoint-rule-set-1.json new file mode 100644 index 0000000000..cc569be814 --- /dev/null +++ b/botocore/data/cleanroomsml/2023-09-06/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "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" + } + ] +} \ No newline at end of file diff --git a/botocore/data/cleanroomsml/2023-09-06/paginators-1.json b/botocore/data/cleanroomsml/2023-09-06/paginators-1.json new file mode 100644 index 0000000000..c3394f11c6 --- /dev/null +++ b/botocore/data/cleanroomsml/2023-09-06/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListAudienceExportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "audienceExportJobs" + }, + "ListAudienceGenerationJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "audienceGenerationJobs" + }, + "ListAudienceModels": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "audienceModels" + }, + "ListConfiguredAudienceModels": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "configuredAudienceModels" + }, + "ListTrainingDatasets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "trainingDatasets" + } + } +} diff --git a/botocore/data/cleanroomsml/2023-09-06/service-2.json b/botocore/data/cleanroomsml/2023-09-06/service-2.json new file mode 100644 index 0000000000..ae37b72eef --- /dev/null +++ b/botocore/data/cleanroomsml/2023-09-06/service-2.json @@ -0,0 +1,2219 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2023-09-06", + "endpointPrefix":"cleanrooms-ml", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"cleanrooms-ml", + "serviceId":"CleanRoomsML", + "signatureVersion":"v4", + "signingName":"cleanrooms-ml", + "uid":"cleanroomsml-2023-09-06" + }, + "operations":{ + "CreateAudienceModel":{ + "name":"CreateAudienceModel", + "http":{ + "method":"POST", + "requestUri":"/audience-model", + "responseCode":200 + }, + "input":{"shape":"CreateAudienceModelRequest"}, + "output":{"shape":"CreateAudienceModelResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "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.

", + "idempotent":true + }, + "CreateConfiguredAudienceModel":{ + "name":"CreateConfiguredAudienceModel", + "http":{ + "method":"POST", + "requestUri":"/configured-audience-model", + "responseCode":200 + }, + "input":{"shape":"CreateConfiguredAudienceModelRequest"}, + "output":{"shape":"CreateConfiguredAudienceModelResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Defines the information necessary to create a configured audience model.

", + "idempotent":true + }, + "CreateTrainingDataset":{ + "name":"CreateTrainingDataset", + "http":{ + "method":"POST", + "requestUri":"/training-dataset", + "responseCode":200 + }, + "input":{"shape":"CreateTrainingDatasetRequest"}, + "output":{"shape":"CreateTrainingDatasetResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "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.

", + "idempotent":true + }, + "DeleteAudienceGenerationJob":{ + "name":"DeleteAudienceGenerationJob", + "http":{ + "method":"DELETE", + "requestUri":"/audience-generation-job/{audienceGenerationJobArn}", + "responseCode":200 + }, + "input":{"shape":"DeleteAudienceGenerationJobRequest"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes the specified audience generation job, and removes all data associated with the job.

", + "idempotent":true + }, + "DeleteAudienceModel":{ + "name":"DeleteAudienceModel", + "http":{ + "method":"DELETE", + "requestUri":"/audience-model/{audienceModelArn}", + "responseCode":200 + }, + "input":{"shape":"DeleteAudienceModelRequest"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "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.

", + "idempotent":true + }, + "DeleteConfiguredAudienceModel":{ + "name":"DeleteConfiguredAudienceModel", + "http":{ + "method":"DELETE", + "requestUri":"/configured-audience-model/{configuredAudienceModelArn}", + "responseCode":200 + }, + "input":{"shape":"DeleteConfiguredAudienceModelRequest"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "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.

", + "idempotent":true + }, + "DeleteConfiguredAudienceModelPolicy":{ + "name":"DeleteConfiguredAudienceModelPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/configured-audience-model/{configuredAudienceModelArn}/policy", + "responseCode":200 + }, + "input":{"shape":"DeleteConfiguredAudienceModelPolicyRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes the specified configured audience model policy.

", + "idempotent":true + }, + "DeleteTrainingDataset":{ + "name":"DeleteTrainingDataset", + "http":{ + "method":"DELETE", + "requestUri":"/training-dataset/{trainingDatasetArn}", + "responseCode":200 + }, + "input":{"shape":"DeleteTrainingDatasetRequest"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "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.

", + "idempotent":true + }, + "GetAudienceGenerationJob":{ + "name":"GetAudienceGenerationJob", + "http":{ + "method":"GET", + "requestUri":"/audience-generation-job/{audienceGenerationJobArn}", + "responseCode":200 + }, + "input":{"shape":"GetAudienceGenerationJobRequest"}, + "output":{"shape":"GetAudienceGenerationJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about an audience generation job.

" + }, + "GetAudienceModel":{ + "name":"GetAudienceModel", + "http":{ + "method":"GET", + "requestUri":"/audience-model/{audienceModelArn}", + "responseCode":200 + }, + "input":{"shape":"GetAudienceModelRequest"}, + "output":{"shape":"GetAudienceModelResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about an audience model

" + }, + "GetConfiguredAudienceModel":{ + "name":"GetConfiguredAudienceModel", + "http":{ + "method":"GET", + "requestUri":"/configured-audience-model/{configuredAudienceModelArn}", + "responseCode":200 + }, + "input":{"shape":"GetConfiguredAudienceModelRequest"}, + "output":{"shape":"GetConfiguredAudienceModelResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a specified configured audience model.

" + }, + "GetConfiguredAudienceModelPolicy":{ + "name":"GetConfiguredAudienceModelPolicy", + "http":{ + "method":"GET", + "requestUri":"/configured-audience-model/{configuredAudienceModelArn}/policy", + "responseCode":200 + }, + "input":{"shape":"GetConfiguredAudienceModelPolicyRequest"}, + "output":{"shape":"GetConfiguredAudienceModelPolicyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a configured audience model policy.

" + }, + "GetTrainingDataset":{ + "name":"GetTrainingDataset", + "http":{ + "method":"GET", + "requestUri":"/training-dataset/{trainingDatasetArn}", + "responseCode":200 + }, + "input":{"shape":"GetTrainingDatasetRequest"}, + "output":{"shape":"GetTrainingDatasetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a training dataset.

" + }, + "ListAudienceExportJobs":{ + "name":"ListAudienceExportJobs", + "http":{ + "method":"GET", + "requestUri":"/audience-export-job", + "responseCode":200 + }, + "input":{"shape":"ListAudienceExportJobsRequest"}, + "output":{"shape":"ListAudienceExportJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns a list of the audience export jobs.

" + }, + "ListAudienceGenerationJobs":{ + "name":"ListAudienceGenerationJobs", + "http":{ + "method":"GET", + "requestUri":"/audience-generation-job", + "responseCode":200 + }, + "input":{"shape":"ListAudienceGenerationJobsRequest"}, + "output":{"shape":"ListAudienceGenerationJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns a list of audience generation jobs.

" + }, + "ListAudienceModels":{ + "name":"ListAudienceModels", + "http":{ + "method":"GET", + "requestUri":"/audience-model", + "responseCode":200 + }, + "input":{"shape":"ListAudienceModelsRequest"}, + "output":{"shape":"ListAudienceModelsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns a list of audience models.

" + }, + "ListConfiguredAudienceModels":{ + "name":"ListConfiguredAudienceModels", + "http":{ + "method":"GET", + "requestUri":"/configured-audience-model", + "responseCode":200 + }, + "input":{"shape":"ListConfiguredAudienceModelsRequest"}, + "output":{"shape":"ListConfiguredAudienceModelsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns a list of the configured audience models.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns a list of tags for a provided resource.

" + }, + "ListTrainingDatasets":{ + "name":"ListTrainingDatasets", + "http":{ + "method":"GET", + "requestUri":"/training-dataset", + "responseCode":200 + }, + "input":{"shape":"ListTrainingDatasetsRequest"}, + "output":{"shape":"ListTrainingDatasetsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns a list of training datasets.

" + }, + "PutConfiguredAudienceModelPolicy":{ + "name":"PutConfiguredAudienceModelPolicy", + "http":{ + "method":"PUT", + "requestUri":"/configured-audience-model/{configuredAudienceModelArn}/policy", + "responseCode":200 + }, + "input":{"shape":"PutConfiguredAudienceModelPolicyRequest"}, + "output":{"shape":"PutConfiguredAudienceModelPolicyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Create or update the resource policy for a configured audience model.

", + "idempotent":true + }, + "StartAudienceExportJob":{ + "name":"StartAudienceExportJob", + "http":{ + "method":"POST", + "requestUri":"/audience-export-job", + "responseCode":200 + }, + "input":{"shape":"StartAudienceExportJobRequest"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Export an audience of a specified size after you have generated an audience.

", + "idempotent":true + }, + "StartAudienceGenerationJob":{ + "name":"StartAudienceGenerationJob", + "http":{ + "method":"POST", + "requestUri":"/audience-generation-job", + "responseCode":200 + }, + "input":{"shape":"StartAudienceGenerationJobRequest"}, + "output":{"shape":"StartAudienceGenerationJobResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Information necessary to start the audience generation job.

", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Adds metadata tags to a specified resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes metadata tags from a specified resource.

", + "idempotent":true + }, + "UpdateConfiguredAudienceModel":{ + "name":"UpdateConfiguredAudienceModel", + "http":{ + "method":"PATCH", + "requestUri":"/configured-audience-model/{configuredAudienceModelArn}", + "responseCode":200 + }, + "input":{"shape":"UpdateConfiguredAudienceModelRequest"}, + "output":{"shape":"UpdateConfiguredAudienceModelResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "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.

", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

You do not have sufficient access to perform this action.

", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^[0-9]{12}$" + }, + "AudienceDestination":{ + "type":"structure", + "required":["s3Destination"], + "members":{ + "s3Destination":{ + "shape":"S3ConfigMap", + "documentation":"

The Amazon S3 bucket and path for the configured audience.

" + } + }, + "documentation":"

Defines the Amazon S3 bucket where the configured audience is stored.

" + }, + "AudienceExportJobList":{ + "type":"list", + "member":{"shape":"AudienceExportJobSummary"} + }, + "AudienceExportJobStatus":{ + "type":"string", + "enum":[ + "CREATE_PENDING", + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE" + ] + }, + "AudienceExportJobSummary":{ + "type":"structure", + "required":[ + "audienceGenerationJobArn", + "audienceSize", + "createTime", + "name", + "status", + "updateTime" + ], + "members":{ + "audienceGenerationJobArn":{ + "shape":"AudienceGenerationJobArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience generation job that was exported.

" + }, + "audienceSize":{"shape":"AudienceSize"}, + "createTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The time at which the audience export job was created.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the audience export job.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the audience export job.

" + }, + "outputLocation":{ + "shape":"S3Path", + "documentation":"

The Amazon S3 bucket where the audience export is stored.

" + }, + "status":{ + "shape":"AudienceExportJobStatus", + "documentation":"

The status of the audience export job.

" + }, + "statusDetails":{"shape":"StatusDetails"}, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The most recent time at which the audience export job was updated.

" + } + }, + "documentation":"

Provides information about the audience export job.

" + }, + "AudienceGenerationJobArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-generation-job/[-a-zA-Z0-9_/.]+$" + }, + "AudienceGenerationJobDataSource":{ + "type":"structure", + "required":[ + "dataSource", + "roleArn" + ], + "members":{ + "dataSource":{ + "shape":"S3ConfigMap", + "documentation":"

The Amazon S3 bucket where the training data for the configured audience is stored.

" + }, + "roleArn":{ + "shape":"IamRoleArn", + "documentation":"

The ARN of the IAM role that can read the Amazon S3 bucket where the training data is stored.

" + } + }, + "documentation":"

Defines the Amazon S3 bucket where the training data for the configured audience is stored.

" + }, + "AudienceGenerationJobList":{ + "type":"list", + "member":{"shape":"AudienceGenerationJobSummary"} + }, + "AudienceGenerationJobStatus":{ + "type":"string", + "enum":[ + "CREATE_PENDING", + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_PENDING", + "DELETE_IN_PROGRESS", + "DELETE_FAILED" + ] + }, + "AudienceGenerationJobSummary":{ + "type":"structure", + "required":[ + "audienceGenerationJobArn", + "configuredAudienceModelArn", + "createTime", + "name", + "status", + "updateTime" + ], + "members":{ + "audienceGenerationJobArn":{ + "shape":"AudienceGenerationJobArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience generation job.

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

The identifier of the collaboration that contains this audience generation job.

" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

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

" + }, + "createTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The time at which the audience generation job was created.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the audience generation job.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the audience generation job.

" + }, + "startedBy":{ + "shape":"AccountId", + "documentation":"

The AWS Account that submitted the job.

" + }, + "status":{ + "shape":"AudienceGenerationJobStatus", + "documentation":"

The status of the audience generation job.

" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The most recent time at which the audience generation job was updated.

" + } + }, + "documentation":"

Provides information about the configured audience generation job.

" + }, + "AudienceModelArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-model/[-a-zA-Z0-9_/.]+$" + }, + "AudienceModelList":{ + "type":"list", + "member":{"shape":"AudienceModelSummary"} + }, + "AudienceModelMetric":{ + "type":"structure", + "required":[ + "forTopKItemPredictions", + "type", + "value" + ], + "members":{ + "forTopKItemPredictions":{ + "shape":"Integer", + "documentation":"

The number of users that were used to generate these model metrics.

" + }, + "type":{ + "shape":"AudienceModelMetricType", + "documentation":"

The audience model metric.

" + }, + "value":{ + "shape":"Double", + "documentation":"

The value of the audience model metric

" + } + }, + "documentation":"

The audience model metrics.

" + }, + "AudienceModelMetricType":{ + "type":"string", + "enum":[ + "NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN", + "MEAN_RECIPROCAL_RANK", + "PRECISION", + "RECALL" + ] + }, + "AudienceModelMetrics":{ + "type":"list", + "member":{"shape":"AudienceModelMetric"} + }, + "AudienceModelStatus":{ + "type":"string", + "enum":[ + "CREATE_PENDING", + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_PENDING", + "DELETE_IN_PROGRESS", + "DELETE_FAILED" + ] + }, + "AudienceModelSummary":{ + "type":"structure", + "required":[ + "audienceModelArn", + "createTime", + "name", + "status", + "trainingDatasetArn", + "updateTime" + ], + "members":{ + "audienceModelArn":{ + "shape":"AudienceModelArn", + "documentation":"

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

" + }, + "createTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The time at which the audience model was created.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the audience model.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the audience model.

" + }, + "status":{ + "shape":"AudienceModelStatus", + "documentation":"

The status of the audience model.

" + }, + "trainingDatasetArn":{ + "shape":"TrainingDatasetArn", + "documentation":"

The Amazon Resource Name (ARN) of the training dataset that was used for the audience model.

" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

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

" + } + }, + "documentation":"

Information about the audience model.

" + }, + "AudienceQualityMetrics":{ + "type":"structure", + "required":["relevanceMetrics"], + "members":{ + "relevanceMetrics":{ + "shape":"RelevanceMetrics", + "documentation":"

The relevance scores of the generated audience.

" + } + }, + "documentation":"

Metrics that describe the quality of the generated audience.

" + }, + "AudienceSize":{ + "type":"structure", + "required":[ + "type", + "value" + ], + "members":{ + "type":{ + "shape":"AudienceSizeType", + "documentation":"

Whether the audience size is defined in absolute terms or as a percentage. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

" + }, + "value":{ + "shape":"AudienceSizeValue", + "documentation":"

Specify an audience size value.

" + } + }, + "documentation":"

The size of the generated audience. Must match one of the sizes in the configured audience model.

" + }, + "AudienceSizeBins":{ + "type":"list", + "member":{"shape":"AudienceSizeValue"}, + "max":25, + "min":1 + }, + "AudienceSizeConfig":{ + "type":"structure", + "required":[ + "audienceSizeBins", + "audienceSizeType" + ], + "members":{ + "audienceSizeBins":{ + "shape":"AudienceSizeBins", + "documentation":"

An array of the different audience output sizes.

" + }, + "audienceSizeType":{ + "shape":"AudienceSizeType", + "documentation":"

Whether the audience output sizes are defined as an absolute number or a percentage.

" + } + }, + "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 AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

" + }, + "AudienceSizeType":{ + "type":"string", + "enum":[ + "ABSOLUTE", + "PERCENTAGE" + ] + }, + "AudienceSizeValue":{ + "type":"integer", + "box":true, + "max":20000000, + "min":1 + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ColumnName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + }, + "ColumnSchema":{ + "type":"structure", + "required":[ + "columnName", + "columnTypes" + ], + "members":{ + "columnName":{ + "shape":"ColumnName", + "documentation":"

The name of a column.

" + }, + "columnTypes":{ + "shape":"ColumnTypeList", + "documentation":"

The data type of column.

" + } + }, + "documentation":"

Metadata for a column.

" + }, + "ColumnType":{ + "type":"string", + "enum":[ + "USER_ID", + "ITEM_ID", + "TIMESTAMP", + "CATEGORICAL_FEATURE", + "NUMERICAL_FEATURE" + ] + }, + "ColumnTypeList":{ + "type":"list", + "member":{"shape":"ColumnType"}, + "max":1, + "min":1 + }, + "ConfiguredAudienceModelArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+$" + }, + "ConfiguredAudienceModelList":{ + "type":"list", + "member":{"shape":"ConfiguredAudienceModelSummary"} + }, + "ConfiguredAudienceModelOutputConfig":{ + "type":"structure", + "required":[ + "destination", + "roleArn" + ], + "members":{ + "destination":{"shape":"AudienceDestination"}, + "roleArn":{ + "shape":"IamRoleArn", + "documentation":"

The ARN of the IAM role that can write the Amazon S3 bucket.

" + } + }, + "documentation":"

Configuration information necessary for the configure audience model output.

" + }, + "ConfiguredAudienceModelStatus":{ + "type":"string", + "enum":["ACTIVE"] + }, + "ConfiguredAudienceModelSummary":{ + "type":"structure", + "required":[ + "audienceModelArn", + "configuredAudienceModelArn", + "createTime", + "name", + "outputConfig", + "status", + "updateTime" + ], + "members":{ + "audienceModelArn":{ + "shape":"AudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.

" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model that you are interested in.

" + }, + "createTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The time at which the configured audience model was created.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the configured audience model.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the configured audience model.

" + }, + "outputConfig":{ + "shape":"ConfiguredAudienceModelOutputConfig", + "documentation":"

The output configuration of the configured audience model.

" + }, + "status":{ + "shape":"ConfiguredAudienceModelStatus", + "documentation":"

The status of the configured audience model.

" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

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

" + } + }, + "documentation":"

Information about the configured audience model.

" + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

A resource with that name already exists in this region.

", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateAudienceModelRequest":{ + "type":"structure", + "required":[ + "name", + "trainingDatasetArn" + ], + "members":{ + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the audience model.

" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "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.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the audience model resource.

" + }, + "tags":{ + "shape":"TagMap", + "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.

The following basic restrictions apply to tags:

" + }, + "trainingDataEndTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The end date and time of the training window.

" + }, + "trainingDataStartTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The start date and time of the training window.

" + }, + "trainingDatasetArn":{ + "shape":"TrainingDatasetArn", + "documentation":"

The Amazon Resource Name (ARN) of the training dataset for this audience model.

" + } + } + }, + "CreateAudienceModelResponse":{ + "type":"structure", + "required":["audienceModelArn"], + "members":{ + "audienceModelArn":{ + "shape":"AudienceModelArn", + "documentation":"

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

" + } + } + }, + "CreateConfiguredAudienceModelRequest":{ + "type":"structure", + "required":[ + "audienceModelArn", + "name", + "outputConfig", + "sharedAudienceMetrics" + ], + "members":{ + "audienceModelArn":{ + "shape":"AudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.

" + }, + "audienceSizeConfig":{ + "shape":"AudienceSizeConfig", + "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 AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

" + }, + "childResourceTagOnCreatePolicy":{ + "shape":"TagOnCreatePolicy", + "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.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the configured audience model.

" + }, + "minMatchingSeedSize":{ + "shape":"MinMatchingSeedSize", + "documentation":"

The minimum number of users from the seed audience that must match with users in the training data of the audience model.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the configured audience model.

" + }, + "outputConfig":{ + "shape":"ConfiguredAudienceModelOutputConfig", + "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.

" + }, + "sharedAudienceMetrics":{ + "shape":"MetricsList", + "documentation":"

Whether audience metrics are shared.

" + }, + "tags":{ + "shape":"TagMap", + "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.

The following basic restrictions apply to tags:

" + } + } + }, + "CreateConfiguredAudienceModelResponse":{ + "type":"structure", + "required":["configuredAudienceModelArn"], + "members":{ + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

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

" + } + } + }, + "CreateTrainingDatasetRequest":{ + "type":"structure", + "required":[ + "name", + "roleArn", + "trainingData" + ], + "members":{ + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the training dataset.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the training dataset. This name must be unique in your account and region.

" + }, + "roleArn":{ + "shape":"IamRoleArn", + "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.

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.

" + }, + "tags":{ + "shape":"TagMap", + "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.

The following basic restrictions apply to tags:

" + }, + "trainingData":{ + "shape":"CreateTrainingDatasetRequestTrainingDataList", + "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.

" + } + } + }, + "CreateTrainingDatasetRequestTrainingDataList":{ + "type":"list", + "member":{"shape":"Dataset"}, + "max":1, + "min":1 + }, + "CreateTrainingDatasetResponse":{ + "type":"structure", + "required":["trainingDatasetArn"], + "members":{ + "trainingDatasetArn":{ + "shape":"TrainingDatasetArn", + "documentation":"

The Amazon Resource Name (ARN) of the training dataset resource.

" + } + } + }, + "DataSource":{ + "type":"structure", + "required":["glueDataSource"], + "members":{ + "glueDataSource":{ + "shape":"GlueDataSource", + "documentation":"

A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.

" + } + }, + "documentation":"

Defines information about the Glue data source that contains the training data.

" + }, + "Dataset":{ + "type":"structure", + "required":[ + "inputConfig", + "type" + ], + "members":{ + "inputConfig":{ + "shape":"DatasetInputConfig", + "documentation":"

A DatasetInputConfig object that defines the data source and schema mapping.

" + }, + "type":{ + "shape":"DatasetType", + "documentation":"

What type of information is found in the dataset.

" + } + }, + "documentation":"

Defines where the training dataset is located, what type of data it contains, and how to access the data.

" + }, + "DatasetInputConfig":{ + "type":"structure", + "required":[ + "dataSource", + "schema" + ], + "members":{ + "dataSource":{ + "shape":"DataSource", + "documentation":"

A DataSource object that specifies the Glue data source for the training data.

" + }, + "schema":{ + "shape":"DatasetInputConfigSchemaList", + "documentation":"

The schema information for the training data.

" + } + }, + "documentation":"

Defines the Glue data source and schema mapping information.

" + }, + "DatasetInputConfigSchemaList":{ + "type":"list", + "member":{"shape":"ColumnSchema"}, + "max":100, + "min":1 + }, + "DatasetList":{ + "type":"list", + "member":{"shape":"Dataset"} + }, + "DatasetType":{ + "type":"string", + "enum":["INTERACTIONS"] + }, + "DeleteAudienceGenerationJobRequest":{ + "type":"structure", + "required":["audienceGenerationJobArn"], + "members":{ + "audienceGenerationJobArn":{ + "shape":"AudienceGenerationJobArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience generation job that you want to delete.

", + "location":"uri", + "locationName":"audienceGenerationJobArn" + } + } + }, + "DeleteAudienceModelRequest":{ + "type":"structure", + "required":["audienceModelArn"], + "members":{ + "audienceModelArn":{ + "shape":"AudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience model that you want to delete.

", + "location":"uri", + "locationName":"audienceModelArn" + } + } + }, + "DeleteConfiguredAudienceModelPolicyRequest":{ + "type":"structure", + "required":["configuredAudienceModelArn"], + "members":{ + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.

", + "location":"uri", + "locationName":"configuredAudienceModelArn" + } + } + }, + "DeleteConfiguredAudienceModelRequest":{ + "type":"structure", + "required":["configuredAudienceModelArn"], + "members":{ + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model that you want to delete.

", + "location":"uri", + "locationName":"configuredAudienceModelArn" + } + } + }, + "DeleteTrainingDatasetRequest":{ + "type":"structure", + "required":["trainingDatasetArn"], + "members":{ + "trainingDatasetArn":{ + "shape":"TrainingDatasetArn", + "documentation":"

The Amazon Resource Name (ARN) of the training dataset that you want to delete.

", + "location":"uri", + "locationName":"trainingDatasetArn" + } + } + }, + "Double":{ + "type":"double", + "box":true + }, + "GetAudienceGenerationJobRequest":{ + "type":"structure", + "required":["audienceGenerationJobArn"], + "members":{ + "audienceGenerationJobArn":{ + "shape":"AudienceGenerationJobArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience generation job that you are interested in.

", + "location":"uri", + "locationName":"audienceGenerationJobArn" + } + } + }, + "GetAudienceGenerationJobResponse":{ + "type":"structure", + "required":[ + "audienceGenerationJobArn", + "configuredAudienceModelArn", + "createTime", + "name", + "status", + "updateTime" + ], + "members":{ + "audienceGenerationJobArn":{ + "shape":"AudienceGenerationJobArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience generation job.

" + }, + "collaborationId":{ + "shape":"UUID", + "documentation":"

The identifier of the collaboration that this audience generation job is associated with.

" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.

" + }, + "createTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The time at which the audience generation job was created.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the audience generation job.

" + }, + "includeSeedInOutput":{ + "shape":"Boolean", + "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.

" + }, + "metrics":{ + "shape":"AudienceQualityMetrics", + "documentation":"

The relevance scores for different audience sizes.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the audience generation job.

" + }, + "seedAudience":{ + "shape":"AudienceGenerationJobDataSource", + "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.

" + }, + "startedBy":{ + "shape":"AccountId", + "documentation":"

The AWS account that started this audience generation job.

" + }, + "status":{ + "shape":"AudienceGenerationJobStatus", + "documentation":"

The status of the audience generation job.

" + }, + "statusDetails":{ + "shape":"StatusDetails", + "documentation":"

Details about the status of the audience generation job.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The tags that are associated to this audience generation job.

" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The most recent time at which the audience generation job was updated.

" + } + } + }, + "GetAudienceModelRequest":{ + "type":"structure", + "required":["audienceModelArn"], + "members":{ + "audienceModelArn":{ + "shape":"AudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience model that you are interested in.

", + "location":"uri", + "locationName":"audienceModelArn" + } + } + }, + "GetAudienceModelResponse":{ + "type":"structure", + "required":[ + "audienceModelArn", + "createTime", + "name", + "status", + "trainingDatasetArn", + "updateTime" + ], + "members":{ + "audienceModelArn":{ + "shape":"AudienceModelArn", + "documentation":"

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

" + }, + "createTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The time at which the audience model was created.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the audience model.

" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"

The KMS key ARN used for the audience model.

" + }, + "metrics":{ + "shape":"AudienceModelMetrics", + "documentation":"

Accuracy metrics for the model.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the audience model.

" + }, + "status":{ + "shape":"AudienceModelStatus", + "documentation":"

The status of the audience model.

" + }, + "statusDetails":{ + "shape":"StatusDetails", + "documentation":"

Details about the status of the audience model.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The tags that are assigned to the audience model.

" + }, + "trainingDataEndTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The end date specified for the training window.

" + }, + "trainingDataStartTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The start date specified for the training window.

" + }, + "trainingDatasetArn":{ + "shape":"TrainingDatasetArn", + "documentation":"

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

" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

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

" + } + } + }, + "GetConfiguredAudienceModelPolicyRequest":{ + "type":"structure", + "required":["configuredAudienceModelArn"], + "members":{ + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model that you are interested in.

", + "location":"uri", + "locationName":"configuredAudienceModelArn" + } + } + }, + "GetConfiguredAudienceModelPolicyResponse":{ + "type":"structure", + "required":[ + "configuredAudienceModelArn", + "configuredAudienceModelPolicy", + "policyHash" + ], + "members":{ + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

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

" + }, + "configuredAudienceModelPolicy":{ + "shape":"ResourcePolicy", + "documentation":"

The configured audience model policy. This is a JSON IAM resource policy.

" + }, + "policyHash":{ + "shape":"Hash", + "documentation":"

A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

" + } + } + }, + "GetConfiguredAudienceModelRequest":{ + "type":"structure", + "required":["configuredAudienceModelArn"], + "members":{ + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model that you are interested in.

", + "location":"uri", + "locationName":"configuredAudienceModelArn" + } + } + }, + "GetConfiguredAudienceModelResponse":{ + "type":"structure", + "required":[ + "audienceModelArn", + "configuredAudienceModelArn", + "createTime", + "name", + "outputConfig", + "sharedAudienceMetrics", + "status", + "updateTime" + ], + "members":{ + "audienceModelArn":{ + "shape":"AudienceModelArn", + "documentation":"

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

" + }, + "audienceSizeConfig":{ + "shape":"AudienceSizeConfig", + "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 AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

" + }, + "childResourceTagOnCreatePolicy":{ + "shape":"TagOnCreatePolicy", + "documentation":"

Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.

" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

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

" + }, + "createTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The time at which the configured audience model was created.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the configured audience model.

" + }, + "minMatchingSeedSize":{ + "shape":"MinMatchingSeedSize", + "documentation":"

The minimum number of users from the seed audience that must match with users in the training data of the audience model.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the configured audience model.

" + }, + "outputConfig":{ + "shape":"ConfiguredAudienceModelOutputConfig", + "documentation":"

The output configuration of the configured audience model

" + }, + "sharedAudienceMetrics":{ + "shape":"MetricsList", + "documentation":"

Whether audience metrics are shared.

" + }, + "status":{ + "shape":"ConfiguredAudienceModelStatus", + "documentation":"

The status of the configured audience model.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The tags that are associated to this configured audience model.

" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

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

" + } + } + }, + "GetTrainingDatasetRequest":{ + "type":"structure", + "required":["trainingDatasetArn"], + "members":{ + "trainingDatasetArn":{ + "shape":"TrainingDatasetArn", + "documentation":"

The Amazon Resource Name (ARN) of the training dataset that you are interested in.

", + "location":"uri", + "locationName":"trainingDatasetArn" + } + } + }, + "GetTrainingDatasetResponse":{ + "type":"structure", + "required":[ + "createTime", + "name", + "roleArn", + "status", + "trainingData", + "trainingDatasetArn", + "updateTime" + ], + "members":{ + "createTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The time at which the training dataset was created.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the training dataset.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the training dataset.

" + }, + "roleArn":{ + "shape":"IamRoleArn", + "documentation":"

The IAM role used to read the training data.

" + }, + "status":{ + "shape":"TrainingDatasetStatus", + "documentation":"

The status of the training dataset.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The tags that are assigned to this training dataset.

" + }, + "trainingData":{ + "shape":"DatasetList", + "documentation":"

Metadata about the requested training data.

" + }, + "trainingDatasetArn":{ + "shape":"TrainingDatasetArn", + "documentation":"

The Amazon Resource Name (ARN) of the training dataset.

" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The most recent time at which the training dataset was updated.

" + } + } + }, + "GlueDataSource":{ + "type":"structure", + "required":[ + "databaseName", + "tableName" + ], + "members":{ + "catalogId":{ + "shape":"AccountId", + "documentation":"

The Glue catalog that contains the training data.

" + }, + "databaseName":{ + "shape":"GlueDatabaseName", + "documentation":"

The Glue database that contains the training data.

" + }, + "tableName":{ + "shape":"GlueTableName", + "documentation":"

The Glue table that contains the training data.

" + } + }, + "documentation":"

Defines the Glue data source that contains the training data.

" + }, + "GlueDatabaseName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$" + }, + "GlueTableName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + }, + "Hash":{ + "type":"string", + "max":128, + "min":64, + "pattern":"^[0-9a-f]+$" + }, + "IamRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$" + }, + "Integer":{ + "type":"integer", + "box":true + }, + "KmsKeyArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+$" + }, + "ListAudienceExportJobsRequest":{ + "type":"structure", + "members":{ + "audienceGenerationJobArn":{ + "shape":"AudienceGenerationJobArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience generation job that you are interested in.

", + "location":"querystring", + "locationName":"audienceGenerationJobArn" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAudienceExportJobsResponse":{ + "type":"structure", + "required":["audienceExportJobs"], + "members":{ + "audienceExportJobs":{ + "shape":"AudienceExportJobList", + "documentation":"

The audience export jobs that match the request.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + } + } + }, + "ListAudienceGenerationJobsRequest":{ + "type":"structure", + "members":{ + "collaborationId":{ + "shape":"UUID", + "documentation":"

The identifier of the collaboration that contains the audience generation jobs that you are interested in.

", + "location":"querystring", + "locationName":"collaborationId" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.

", + "location":"querystring", + "locationName":"configuredAudienceModelArn" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAudienceGenerationJobsResponse":{ + "type":"structure", + "required":["audienceGenerationJobs"], + "members":{ + "audienceGenerationJobs":{ + "shape":"AudienceGenerationJobList", + "documentation":"

The audience generation jobs that match the request.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + } + } + }, + "ListAudienceModelsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAudienceModelsResponse":{ + "type":"structure", + "required":["audienceModels"], + "members":{ + "audienceModels":{ + "shape":"AudienceModelList", + "documentation":"

The audience models that match the request.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + } + } + }, + "ListConfiguredAudienceModelsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListConfiguredAudienceModelsResponse":{ + "type":"structure", + "required":["configuredAudienceModels"], + "members":{ + "configuredAudienceModels":{ + "shape":"ConfiguredAudienceModelList", + "documentation":"

The configured audience models.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"TaggableArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource that you are interested in.

", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"

The tags that are associated with the resource.

" + } + } + }, + "ListTrainingDatasetsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of the results that is returned per call.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListTrainingDatasetsResponse":{ + "type":"structure", + "required":["trainingDatasets"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" + }, + "trainingDatasets":{ + "shape":"TrainingDatasetList", + "documentation":"

The training datasets that match the request.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MetricsList":{ + "type":"list", + "member":{"shape":"SharedAudienceMetrics"}, + "max":1, + "min":1 + }, + "MinMatchingSeedSize":{ + "type":"integer", + "box":true, + "max":500000, + "min":25 + }, + "NameString":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + }, + "NextToken":{ + "type":"string", + "max":10240, + "min":1 + }, + "PolicyExistenceCondition":{ + "type":"string", + "enum":[ + "POLICY_MUST_EXIST", + "POLICY_MUST_NOT_EXIST" + ] + }, + "PutConfiguredAudienceModelPolicyRequest":{ + "type":"structure", + "required":[ + "configuredAudienceModelArn", + "configuredAudienceModelPolicy" + ], + "members":{ + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.

", + "location":"uri", + "locationName":"configuredAudienceModelArn" + }, + "configuredAudienceModelPolicy":{ + "shape":"ResourcePolicy", + "documentation":"

The IAM resource policy.

" + }, + "policyExistenceCondition":{ + "shape":"PolicyExistenceCondition", + "documentation":"

Use this to prevent unexpected concurrent modification of the policy.

" + }, + "previousPolicyHash":{ + "shape":"Hash", + "documentation":"

A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

" + } + } + }, + "PutConfiguredAudienceModelPolicyResponse":{ + "type":"structure", + "required":[ + "configuredAudienceModelPolicy", + "policyHash" + ], + "members":{ + "configuredAudienceModelPolicy":{ + "shape":"ResourcePolicy", + "documentation":"

The IAM resource policy.

" + }, + "policyHash":{ + "shape":"Hash", + "documentation":"

A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

" + } + } + }, + "RelevanceMetric":{ + "type":"structure", + "required":["audienceSize"], + "members":{ + "audienceSize":{"shape":"AudienceSize"}, + "score":{ + "shape":"Double", + "documentation":"

The relevance score of the generated audience.

" + } + }, + "documentation":"

The relevance score of a generated audience.

" + }, + "RelevanceMetrics":{ + "type":"list", + "member":{"shape":"RelevanceMetric"} + }, + "ResourceDescription":{ + "type":"string", + "max":255, + "min":0, + "pattern":"^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The resource you are requesting does not exist.

", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourcePolicy":{ + "type":"string", + "max":20480, + "min":1 + }, + "S3ConfigMap":{ + "type":"structure", + "required":["s3Uri"], + "members":{ + "s3Uri":{ + "shape":"S3Path", + "documentation":"

The Amazon S3 location URI.

" + } + }, + "documentation":"

Provides information about an Amazon S3 bucket and path.

" + }, + "S3Path":{ + "type":"string", + "max":1285, + "min":1, + "pattern":"^s3://.+$" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

You have exceeded your service quota.

", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SharedAudienceMetrics":{ + "type":"string", + "enum":[ + "ALL", + "NONE" + ] + }, + "StartAudienceExportJobRequest":{ + "type":"structure", + "required":[ + "audienceGenerationJobArn", + "audienceSize", + "name" + ], + "members":{ + "audienceGenerationJobArn":{ + "shape":"AudienceGenerationJobArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience generation job that you want to export.

" + }, + "audienceSize":{"shape":"AudienceSize"}, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the audience export job.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the audience export job.

" + } + } + }, + "StartAudienceGenerationJobRequest":{ + "type":"structure", + "required":[ + "configuredAudienceModelArn", + "name", + "seedAudience" + ], + "members":{ + "collaborationId":{ + "shape":"UUID", + "documentation":"

The identifier of the collaboration that contains the audience generation job.

" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the audience generation job.

" + }, + "includeSeedInOutput":{ + "shape":"Boolean", + "documentation":"

Whether the seed audience is included in the audience generation output.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the audience generation job.

" + }, + "seedAudience":{ + "shape":"AudienceGenerationJobDataSource", + "documentation":"

The seed audience that is used to generate the audience.

" + }, + "tags":{ + "shape":"TagMap", + "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.

The following basic restrictions apply to tags:

" + } + } + }, + "StartAudienceGenerationJobResponse":{ + "type":"structure", + "required":["audienceGenerationJobArn"], + "members":{ + "audienceGenerationJobArn":{ + "shape":"AudienceGenerationJobArn", + "documentation":"

The Amazon Resource Name (ARN) of the audience generation job.

" + } + } + }, + "StatusDetails":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "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.

" + }, + "statusCode":{ + "shape":"String", + "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.

" + } + }, + "documentation":"

Details about the status of a resource.

" + }, + "String":{"type":"string"}, + "SyntheticTimestamp_date_time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:).{1,128}$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagOnCreatePolicy":{ + "type":"string", + "enum":[ + "FROM_PARENT_RESOURCE", + "NONE" + ] + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"TaggableArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to assign tags.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "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.

The following basic restrictions apply to tags:

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TaggableArn":{ + "type":"string", + "max":2048, + "min":20, + "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_/.]+$" + }, + "TrainingDatasetArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:training-dataset/[-a-zA-Z0-9_/.]+$" + }, + "TrainingDatasetList":{ + "type":"list", + "member":{"shape":"TrainingDatasetSummary"} + }, + "TrainingDatasetStatus":{ + "type":"string", + "enum":["ACTIVE"] + }, + "TrainingDatasetSummary":{ + "type":"structure", + "required":[ + "createTime", + "name", + "status", + "trainingDatasetArn", + "updateTime" + ], + "members":{ + "createTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The time at which the training dataset was created.

" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The description of the training dataset.

" + }, + "name":{ + "shape":"NameString", + "documentation":"

The name of the training dataset.

" + }, + "status":{ + "shape":"TrainingDatasetStatus", + "documentation":"

The status of the training dataset.

" + }, + "trainingDatasetArn":{ + "shape":"TrainingDatasetArn", + "documentation":"

The Amazon Resource Name (ARN) of the training dataset.

" + }, + "updateTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"

The most recent time at which the training dataset was updated.

" + } + }, + "documentation":"

Provides information about the training dataset.

" + }, + "UUID":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"TaggableArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeys", + "documentation":"

The key values of tags that you want to remove.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateConfiguredAudienceModelRequest":{ + "type":"structure", + "required":["configuredAudienceModelArn"], + "members":{ + "audienceModelArn":{ + "shape":"AudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the new audience model that you want to use.

" + }, + "audienceSizeConfig":{ + "shape":"AudienceSizeConfig", + "documentation":"

The new audience size configuration.

" + }, + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model that you want to update.

", + "location":"uri", + "locationName":"configuredAudienceModelArn" + }, + "description":{ + "shape":"ResourceDescription", + "documentation":"

The new description of the configured audience model.

" + }, + "minMatchingSeedSize":{ + "shape":"MinMatchingSeedSize", + "documentation":"

The minimum number of users from the seed audience that must match with users in the training data of the audience model.

" + }, + "outputConfig":{ + "shape":"ConfiguredAudienceModelOutputConfig", + "documentation":"

The new output configuration.

" + }, + "sharedAudienceMetrics":{ + "shape":"MetricsList", + "documentation":"

The new value for whether to share audience metrics.

" + } + } + }, + "UpdateConfiguredAudienceModelResponse":{ + "type":"structure", + "required":["configuredAudienceModelArn"], + "members":{ + "configuredAudienceModelArn":{ + "shape":"ConfiguredAudienceModelArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured audience model that was updated.

" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The request parameters for this request are incorrect.

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"

API Reference for Amazon Web Services Clean Rooms ML.

" +} diff --git a/botocore/data/opensearch/2021-01-01/service-2.json b/botocore/data/opensearch/2021-01-01/service-2.json index 44ad6f9793..a4bdddf130 100644 --- a/botocore/data/opensearch/2021-01-01/service-2.json +++ b/botocore/data/opensearch/2021-01-01/service-2.json @@ -25,6 +25,25 @@ ], "documentation":"

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

" }, + "AddDataSource":{ + "name":"AddDataSource", + "http":{ + "method":"POST", + "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource" + }, + "input":{"shape":"AddDataSourceRequest"}, + "output":{"shape":"AddDataSourceResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"DisabledOperationException"}, + {"shape":"DependencyFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Adds the data source on the domain.

" + }, "AddTags":{ "name":"AddTags", "http":{ @@ -164,6 +183,24 @@ ], "documentation":"

Creates an Amazon OpenSearch Service-managed VPC endpoint.

" }, + "DeleteDataSource":{ + "name":"DeleteDataSource", + "http":{ + "method":"DELETE", + "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}" + }, + "input":{"shape":"DeleteDataSourceRequest"}, + "output":{"shape":"DeleteDataSourceResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"DisabledOperationException"}, + {"shape":"DependencyFailureException"} + ], + "documentation":"

Deletes the data source.

" + }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ @@ -519,6 +556,24 @@ ], "documentation":"

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

" }, + "GetDataSource":{ + "name":"GetDataSource", + "http":{ + "method":"GET", + "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}" + }, + "input":{"shape":"GetDataSourceRequest"}, + "output":{"shape":"GetDataSourceResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"DisabledOperationException"}, + {"shape":"DependencyFailureException"} + ], + "documentation":"

Describes the data source details.

" + }, "GetDomainMaintenanceStatus":{ "name":"GetDomainMaintenanceStatus", "http":{ @@ -587,6 +642,24 @@ ], "documentation":"

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

" }, + "ListDataSources":{ + "name":"ListDataSources", + "http":{ + "method":"GET", + "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource" + }, + "input":{"shape":"ListDataSourcesRequest"}, + "output":{"shape":"ListDataSourcesResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"DisabledOperationException"}, + {"shape":"DependencyFailureException"} + ], + "documentation":"

A list of the data source details of the domain.

" + }, "ListDomainMaintenances":{ "name":"ListDomainMaintenances", "http":{ @@ -860,6 +933,24 @@ ], "documentation":"

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

" }, + "UpdateDataSource":{ + "name":"UpdateDataSource", + "http":{ + "method":"PUT", + "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}" + }, + "input":{"shape":"UpdateDataSourceRequest"}, + "output":{"shape":"UpdateDataSourceResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"DisabledOperationException"}, + {"shape":"DependencyFailureException"} + ], + "documentation":"

Updates the data source on the domain.

" + }, "UpdateDomainConfig":{ "name":"UpdateDomainConfig", "http":{ @@ -1059,6 +1150,45 @@ "JVM_YOUNG_GEN_TUNING" ] }, + "AddDataSourceRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Name", + "DataSourceType" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain.

", + "location":"uri", + "locationName":"DomainName" + }, + "Name":{ + "shape":"DataSourceName", + "documentation":"

The name of the data source.

" + }, + "DataSourceType":{ + "shape":"DataSourceType", + "documentation":"

The type of data source.

" + }, + "Description":{ + "shape":"DataSourceDescription", + "documentation":"

A description of the data source.

" + } + }, + "documentation":"

Container for the parameters to the AddDataSource operation.

" + }, + "AddDataSourceResponse":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

A message associated with the data source.

" + } + }, + "documentation":"

The result of an AddDataSource operation.

" + }, "AddTagsRequest":{ "type":"structure", "required":[ @@ -2060,6 +2190,82 @@ }, "documentation":"

Cross-cluster search specific connection properties.

" }, + "DataSourceDescription":{ + "type":"string", + "max":1000, + "pattern":"^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" + }, + "DataSourceDetails":{ + "type":"structure", + "members":{ + "DataSourceType":{ + "shape":"DataSourceType", + "documentation":"

The type of data source.

" + }, + "Name":{ + "shape":"DataSourceName", + "documentation":"

The name of the data source.

" + }, + "Description":{ + "shape":"DataSourceDescription", + "documentation":"

A description of the data source.

" + } + }, + "documentation":"

Details about the data sources.

" + }, + "DataSourceList":{ + "type":"list", + "member":{"shape":"DataSourceDetails"} + }, + "DataSourceName":{ + "type":"string", + "max":80, + "min":3, + "pattern":"[a-z][a-z0-9_]+" + }, + "DataSourceType":{ + "type":"structure", + "members":{ + "S3GlueDataCatalog":{ + "shape":"S3GlueDataCatalog", + "documentation":"

The data source for the AWS S3 Glue Data Catalog.

" + } + }, + "documentation":"

Information about the data source.

", + "union":true + }, + "DeleteDataSourceRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Name" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain.

", + "location":"uri", + "locationName":"DomainName" + }, + "Name":{ + "shape":"DataSourceName", + "documentation":"

The name of the data source.

", + "location":"uri", + "locationName":"DataSourceName" + } + }, + "documentation":"

Container for the parameters to the DeleteDataSource operation.

" + }, + "DeleteDataSourceResponse":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

A message associated with the initiated request.

" + } + }, + "documentation":"

The result of a GetDataSource operation.

" + }, "DeleteDomainRequest":{ "type":"structure", "required":["DomainName"], @@ -2877,7 +3083,7 @@ }, "TLSSecurityPolicy":{ "shape":"TLSSecurityPolicy", - "documentation":"

Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

Can be one of the following values:

" + "documentation":"

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:

" }, "CustomEndpointEnabled":{ "shape":"Boolean", @@ -3500,6 +3706,46 @@ }, "documentation":"

Container for the response returned by the GetCompatibleVersions operation.

" }, + "GetDataSourceRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Name" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain.

", + "location":"uri", + "locationName":"DomainName" + }, + "Name":{ + "shape":"DataSourceName", + "documentation":"

The name of the data source.

", + "location":"uri", + "locationName":"DataSourceName" + } + }, + "documentation":"

Container for the parameters to the GetDataSource operation.

" + }, + "GetDataSourceResponse":{ + "type":"structure", + "members":{ + "DataSourceType":{ + "shape":"DataSourceType", + "documentation":"

The type of data source.

" + }, + "Name":{ + "shape":"DataSourceName", + "documentation":"

The name of the data source.

" + }, + "Description":{ + "shape":"DataSourceDescription", + "documentation":"

A description of the data source.

" + } + }, + "documentation":"

The result of a GetDataSource operation.

" + }, "GetDomainMaintenanceStatusRequest":{ "type":"structure", "required":[ @@ -3908,6 +4154,29 @@ "value":{"shape":"Limits"}, "documentation":"

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

" }, + "ListDataSourcesRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain.

", + "location":"uri", + "locationName":"DomainName" + } + }, + "documentation":"

Container for the parameters to the ListDataSources operation.

" + }, + "ListDataSourcesResponse":{ + "type":"structure", + "members":{ + "DataSources":{ + "shape":"DataSourceList", + "documentation":"

A list of the data sources.

" + } + }, + "documentation":"

The result of a ListDataSources operation.

" + }, "ListDomainMaintenancesRequest":{ "type":"structure", "required":["DomainName"], @@ -5236,6 +5505,16 @@ "max":63, "min":3 }, + "S3GlueDataCatalog":{ + "type":"structure", + "members":{ + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The role ARN for the AWS S3 Glue Data Catalog.

" + } + }, + "documentation":"

Information about the AWS S3 Glue Data Catalog.

" + }, "S3Key":{ "type":"string", "max":1024, @@ -5740,6 +6019,47 @@ "min":0 }, "UncompressedPluginSizeInBytes":{"type":"long"}, + "UpdateDataSourceRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Name", + "DataSourceType" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain.

", + "location":"uri", + "locationName":"DomainName" + }, + "Name":{ + "shape":"DataSourceName", + "documentation":"

The name of the data source.

", + "location":"uri", + "locationName":"DataSourceName" + }, + "DataSourceType":{ + "shape":"DataSourceType", + "documentation":"

The type of data source.

" + }, + "Description":{ + "shape":"DataSourceDescription", + "documentation":"

A description of the data source.

" + } + }, + "documentation":"

Container for the parameters to the UpdateDataSource operation.

" + }, + "UpdateDataSourceResponse":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

A message associated with the data source.

" + } + }, + "documentation":"

The result of an UpdateDataSource operation.

" + }, "UpdateDomainConfigRequest":{ "type":"structure", "required":["DomainName"], diff --git a/botocore/data/opensearchserverless/2021-11-01/service-2.json b/botocore/data/opensearchserverless/2021-11-01/service-2.json index 3729f2d13c..5b734fd1e7 100644 --- a/botocore/data/opensearchserverless/2021-11-01/service-2.json +++ b/botocore/data/opensearchserverless/2021-11-01/service-2.json @@ -847,6 +847,10 @@ "shape":"CollectionName", "documentation":"

The name of the collection.

" }, + "standbyReplicas":{ + "shape":"StandbyReplicas", + "documentation":"

Details about an OpenSearch Serverless collection.

" + }, "status":{ "shape":"CollectionStatus", "documentation":"

The current status of the collection.

" @@ -1059,6 +1063,10 @@ "shape":"CollectionName", "documentation":"

The name of the collection.

" }, + "standbyReplicas":{ + "shape":"StandbyReplicas", + "documentation":"

Creates details about an OpenSearch Serverless collection.

" + }, "status":{ "shape":"CollectionStatus", "documentation":"

The current status of the collection.

" @@ -1087,6 +1095,10 @@ "shape":"CollectionName", "documentation":"

Name of the collection.

" }, + "standbyReplicas":{ + "shape":"StandbyReplicas", + "documentation":"

Indicates whether standby replicas should be used for a collection.

" + }, "tags":{ "shape":"Tags", "documentation":"

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

" @@ -2407,6 +2419,13 @@ "documentation":"

Thrown when you attempt to create more resources than the service allows based on service quotas.

", "exception":true }, + "StandbyReplicas":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "String":{"type":"string"}, "SubnetId":{ "type":"string", diff --git a/botocore/data/sagemaker-runtime/2017-05-13/endpoint-rule-set-1.json b/botocore/data/sagemaker-runtime/2017-05-13/endpoint-rule-set-1.json index 6abcf0015e..9798eec2b6 100644 --- a/botocore/data/sagemaker-runtime/2017-05-13/endpoint-rule-set-1.json +++ b/botocore/data/sagemaker-runtime/2017-05-13/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,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": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,18 +212,17 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ - "aws", { "fn": "getAttr", "argv": [ @@ -236,7 +231,8 @@ }, "name" ] - } + }, + "aws" ] } ], @@ -252,7 +248,6 @@ { "fn": "stringEquals", "argv": [ - "aws-us-gov", { "fn": "getAttr", "argv": [ @@ -261,7 +256,8 @@ }, "name" ] - } + }, + "aws-us-gov" ] } ], @@ -281,14 +277,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -302,7 +300,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -322,7 +319,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -333,14 +329,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -351,9 +349,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/botocore/data/sagemaker-runtime/2017-05-13/service-2.json b/botocore/data/sagemaker-runtime/2017-05-13/service-2.json index 8d5630c55a..55bdb9d6f1 100644 --- a/botocore/data/sagemaker-runtime/2017-05-13/service-2.json +++ b/botocore/data/sagemaker-runtime/2017-05-13/service-2.json @@ -62,7 +62,7 @@ {"shape":"ModelStreamError"}, {"shape":"InternalStreamFailure"} ], - "documentation":"

Invokes a model at the specified endpoint to return the inference response as a stream. The inference stream provides the response payload incrementally as a series of parts. Before you can get an inference stream, you must have access to a model that's deployed using Amazon SageMaker hosting services, and the container for that model must support inference streaming.

For more information that can help you use this API, see the following sections in the Amazon SageMaker Developer Guide:

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpointWithResponseStream are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

" + "documentation":"

Invokes a model at the specified endpoint to return the inference response as a stream. The inference stream provides the response payload incrementally as a series of parts. Before you can get an inference stream, you must have access to a model that's deployed using Amazon SageMaker hosting services, and the container for that model must support inference streaming.

For more information that can help you use this API, see the following sections in the Amazon SageMaker Developer Guide:

Before you can use this operation, your IAM permissions must allow the 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 Reference.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpointWithResponseStream are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

" } }, "shapes":{ @@ -94,6 +94,11 @@ "max":1024, "pattern":"\\p{ASCII}*" }, + "InferenceComponentHeader":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + }, "InferenceId":{ "type":"string", "max":64, @@ -285,6 +290,12 @@ "documentation":"

An optional JMESPath expression used to override the EnableExplanations parameter of the ClarifyExplainerConfig API. See the EnableExplanations section in the developer guide for more information.

", "location":"header", "locationName":"X-Amzn-SageMaker-Enable-Explanations" + }, + "InferenceComponentName":{ + "shape":"InferenceComponentHeader", + "documentation":"

If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.

", + "location":"header", + "locationName":"X-Amzn-SageMaker-Inference-Component" } }, "payload":"Body" @@ -370,6 +381,12 @@ "documentation":"

An identifier that you assign to your request.

", "location":"header", "locationName":"X-Amzn-SageMaker-Inference-Id" + }, + "InferenceComponentName":{ + "shape":"InferenceComponentHeader", + "documentation":"

If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke for a streaming response.

", + "location":"header", + "locationName":"X-Amzn-SageMaker-Inference-Component" } }, "payload":"Body" diff --git a/botocore/data/sagemaker/2017-07-24/paginators-1.json b/botocore/data/sagemaker/2017-07-24/paginators-1.json index c7af276317..95b87ccd71 100644 --- a/botocore/data/sagemaker/2017-07-24/paginators-1.json +++ b/botocore/data/sagemaker/2017-07-24/paginators-1.json @@ -413,6 +413,24 @@ "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ResourceCatalogs" + }, + "ListClusterNodes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ClusterNodeSummaries" + }, + "ListClusters": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ClusterSummaries" + }, + "ListInferenceComponents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InferenceComponents" } } } diff --git a/botocore/data/sagemaker/2017-07-24/service-2.json b/botocore/data/sagemaker/2017-07-24/service-2.json index d6f2a462f1..c71a2e26b3 100644 --- a/botocore/data/sagemaker/2017-07-24/service-2.json +++ b/botocore/data/sagemaker/2017-07-24/service-2.json @@ -36,7 +36,7 @@ }, "input":{"shape":"AddTagsInput"}, "output":{"shape":"AddTagsOutput"}, - "documentation":"

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

" + "documentation":"

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

" }, "AssociateTrialComponent":{ "name":"AssociateTrialComponent", @@ -97,7 +97,7 @@ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], - "documentation":"

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

" + "documentation":"

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

" }, "CreateAppImageConfig":{ "name":"CreateAppImageConfig", @@ -153,6 +153,20 @@ ], "documentation":"

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

" }, + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterRequest"}, + "output":{"shape":"CreateClusterResponse"}, + "errors":[ + {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceInUse"} + ], + "documentation":"

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

" + }, "CreateCodeRepository":{ "name":"CreateCodeRepository", "http":{ @@ -229,7 +243,7 @@ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], - "documentation":"

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully.

For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.

" + "documentation":"

Creates a Domain. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All traffic between the domain and the EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully.

For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.

" }, "CreateEdgeDeploymentPlan":{ "name":"CreateEdgeDeploymentPlan", @@ -406,6 +420,19 @@ ], "documentation":"

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.

" }, + "CreateInferenceComponent":{ + "name":"CreateInferenceComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInferenceComponentInput"}, + "output":{"shape":"CreateInferenceComponentOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

" + }, "CreateInferenceExperiment":{ "name":"CreateInferenceExperiment", "http":{ @@ -624,7 +651,7 @@ "errors":[ {"shape":"ResourceNotFound"} ], - "documentation":"

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to SageMaker Studio Through an Interface VPC Endpoint .

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 are directed to the Amazon Web Services console sign-in page.

" + "documentation":"

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

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 are directed to the Amazon Web Services console sign-in page.

" }, "CreatePresignedNotebookInstanceUrl":{ "name":"CreatePresignedNotebookInstanceUrl", @@ -689,7 +716,7 @@ "errors":[ {"shape":"ResourceInUse"} ], - "documentation":"

Creates a new Studio Lifecycle Configuration.

" + "documentation":"

Creates a new Amazon SageMaker Studio Lifecycle Configuration.

" }, "CreateTrainingJob":{ "name":"CreateTrainingJob", @@ -760,7 +787,7 @@ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], - "documentation":"

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

" + "documentation":"

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

" }, "CreateWorkforce":{ "name":"CreateWorkforce", @@ -859,6 +886,20 @@ ], "documentation":"

Deletes an association.

" }, + "DeleteCluster":{ + "name":"DeleteCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterRequest"}, + "output":{"shape":"DeleteClusterResponse"}, + "errors":[ + {"shape":"ResourceNotFound"}, + {"shape":"ConflictException"} + ], + "documentation":"

Delete a SageMaker HyperPod cluster.

" + }, "DeleteCodeRepository":{ "name":"DeleteCodeRepository", "http":{ @@ -1066,6 +1107,15 @@ ], "documentation":"

Deletes a version of a SageMaker image. The container image the version represents isn't deleted.

" }, + "DeleteInferenceComponent":{ + "name":"DeleteInferenceComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInferenceComponentInput"}, + "documentation":"

Deletes an inference component.

" + }, "DeleteInferenceExperiment":{ "name":"DeleteInferenceExperiment", "http":{ @@ -1250,7 +1300,7 @@ {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"} ], - "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.

" + "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.

" }, "DeleteTags":{ "name":"DeleteTags", @@ -1260,7 +1310,7 @@ }, "input":{"shape":"DeleteTagsInput"}, "output":{"shape":"DeleteTagsOutput"}, - "documentation":"

Deletes the specified tags from an SageMaker resource.

To list a resource's tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API.

" + "documentation":"

Deletes the specified tags from an SageMaker resource.

To list a resource's tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.

" }, "DeleteTrial":{ "name":"DeleteTrial", @@ -1421,6 +1471,32 @@ ], "documentation":"

Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.

" }, + "DescribeCluster":{ + "name":"DescribeCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterRequest"}, + "output":{"shape":"DescribeClusterResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

Retrieves information of a SageMaker HyperPod cluster.

" + }, + "DescribeClusterNode":{ + "name":"DescribeClusterNode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterNodeRequest"}, + "output":{"shape":"DescribeClusterNodeResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

" + }, "DescribeCodeRepository":{ "name":"DescribeCodeRepository", "http":{ @@ -1685,6 +1761,16 @@ ], "documentation":"

Describes a version of a SageMaker image.

" }, + "DescribeInferenceComponent":{ + "name":"DescribeInferenceComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInferenceComponentInput"}, + "output":{"shape":"DescribeInferenceComponentOutput"}, + "documentation":"

Returns information about an inference component.

" + }, "DescribeInferenceExperiment":{ "name":"DescribeInferenceExperiment", "http":{ @@ -1951,7 +2037,7 @@ "errors":[ {"shape":"ResourceNotFound"} ], - "documentation":"

Describes the Studio Lifecycle Configuration.

" + "documentation":"

Describes the Amazon SageMaker Studio Lifecycle Configuration.

" }, "DescribeSubscribedWorkteam":{ "name":"DescribeSubscribedWorkteam", @@ -2267,6 +2353,29 @@ ], "documentation":"

List the candidates created for the job.

" }, + "ListClusterNodes":{ + "name":"ListClusterNodes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListClusterNodesRequest"}, + "output":{"shape":"ListClusterNodesResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

" + }, + "ListClusters":{ + "name":"ListClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListClustersRequest"}, + "output":{"shape":"ListClustersResponse"}, + "documentation":"

Retrieves the list of SageMaker HyperPod clusters.

" + }, "ListCodeRepositories":{ "name":"ListCodeRepositories", "http":{ @@ -2489,6 +2598,16 @@ "output":{"shape":"ListImagesResponse"}, "documentation":"

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

" }, + "ListInferenceComponents":{ + "name":"ListInferenceComponents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInferenceComponentsInput"}, + "output":{"shape":"ListInferenceComponentsOutput"}, + "documentation":"

Lists the inference components in your account and their properties.

" + }, "ListInferenceExperiments":{ "name":"ListInferenceExperiments", "http":{ @@ -2834,7 +2953,7 @@ "errors":[ {"shape":"ResourceInUse"} ], - "documentation":"

Lists the Studio Lifecycle Configurations in your Amazon Web Services Account.

" + "documentation":"

Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

" }, "ListSubscribedWorkteams":{ "name":"ListSubscribedWorkteams", @@ -3310,6 +3429,21 @@ ], "documentation":"

Updates an artifact.

" }, + "UpdateCluster":{ + "name":"UpdateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateClusterRequest"}, + "output":{"shape":"UpdateClusterResponse"}, + "errors":[ + {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceNotFound"}, + {"shape":"ConflictException"} + ], + "documentation":"

Update a SageMaker HyperPod cluster.

" + }, "UpdateCodeRepository":{ "name":"UpdateCodeRepository", "http":{ @@ -3476,6 +3610,32 @@ ], "documentation":"

Updates the properties of a SageMaker image version.

" }, + "UpdateInferenceComponent":{ + "name":"UpdateInferenceComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateInferenceComponentInput"}, + "output":{"shape":"UpdateInferenceComponentOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

Updates an inference component.

" + }, + "UpdateInferenceComponentRuntimeConfig":{ + "name":"UpdateInferenceComponentRuntimeConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateInferenceComponentRuntimeConfigInput"}, + "output":{"shape":"UpdateInferenceComponentRuntimeConfigOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

Runtime settings for a model that is deployed with an inference component.

" + }, "UpdateInferenceExperiment":{ "name":"UpdateInferenceExperiment", "http":{ @@ -5066,7 +5226,7 @@ }, "MaxRuntimePerTrainingJobInSeconds":{ "shape":"MaxRuntimePerTrainingJobInSeconds", - "documentation":"

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

" + "documentation":"

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).

" }, "MaxAutoMLJobRuntimeInSeconds":{ "shape":"MaxAutoMLJobRuntimeInSeconds", @@ -6551,6 +6711,342 @@ "min":1, "pattern":"^[a-zA-Z0-9-]+$" }, + "ClusterArn":{ + "type":"string", + "max":256, + "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$" + }, + "ClusterInstanceCount":{ + "type":"integer", + "min":1 + }, + "ClusterInstanceGroupDetails":{ + "type":"structure", + "members":{ + "CurrentCount":{ + "shape":"ClusterNonNegativeInstanceCount", + "documentation":"

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

" + }, + "TargetCount":{ + "shape":"ClusterInstanceCount", + "documentation":"

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

" + }, + "InstanceGroupName":{ + "shape":"ClusterInstanceGroupName", + "documentation":"

The name of the instance group of a SageMaker HyperPod cluster.

" + }, + "InstanceType":{ + "shape":"ClusterInstanceType", + "documentation":"

The instance type of the instance group of a SageMaker HyperPod cluster.

" + }, + "LifeCycleConfig":{ + "shape":"ClusterLifeCycleConfig", + "documentation":"

Details of LifeCycle configuration for the instance group.

" + }, + "ExecutionRole":{ + "shape":"RoleArn", + "documentation":"

The execution role for the instance group to assume.

" + }, + "ThreadsPerCore":{ + "shape":"ClusterThreadsPerCore", + "documentation":"

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "documentation":"

Details of an instance group in a SageMaker HyperPod cluster.

" + }, + "ClusterInstanceGroupDetailsList":{ + "type":"list", + "member":{"shape":"ClusterInstanceGroupDetails"} + }, + "ClusterInstanceGroupName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + }, + "ClusterInstanceGroupSpecification":{ + "type":"structure", + "required":[ + "InstanceCount", + "InstanceGroupName", + "InstanceType", + "LifeCycleConfig", + "ExecutionRole" + ], + "members":{ + "InstanceCount":{ + "shape":"ClusterInstanceCount", + "documentation":"

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

" + }, + "InstanceGroupName":{ + "shape":"ClusterInstanceGroupName", + "documentation":"

Specifies the name of the instance group.

" + }, + "InstanceType":{ + "shape":"ClusterInstanceType", + "documentation":"

Specifies the instance type of the instance group.

" + }, + "LifeCycleConfig":{ + "shape":"ClusterLifeCycleConfig", + "documentation":"

Specifies the LifeCycle configuration for the instance group.

" + }, + "ExecutionRole":{ + "shape":"RoleArn", + "documentation":"

Specifies an IAM execution role to be assumed by the instance group.

" + }, + "ThreadsPerCore":{ + "shape":"ClusterThreadsPerCore", + "documentation":"

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "documentation":"

The specifications of an instance group that you need to define.

" + }, + "ClusterInstanceGroupSpecifications":{ + "type":"list", + "member":{"shape":"ClusterInstanceGroupSpecification"}, + "max":5, + "min":1 + }, + "ClusterInstanceStatus":{ + "type":"string", + "enum":[ + "Running", + "Failure", + "Pending", + "ShuttingDown", + "SystemUpdating" + ] + }, + "ClusterInstanceStatusDetails":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"ClusterInstanceStatus", + "documentation":"

The status of an instance in a SageMaker HyperPod cluster.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The message from an instance in a SageMaker HyperPod cluster.

" + } + }, + "documentation":"

Details of an instance in a SageMaker HyperPod cluster.

" + }, + "ClusterInstanceType":{ + "type":"string", + "enum":[ + "ml.p4d.24xlarge", + "ml.p4de.24xlarge", + "ml.p5.48xlarge", + "ml.trn1.32xlarge", + "ml.trn1n.32xlarge", + "ml.g5.xlarge", + "ml.g5.2xlarge", + "ml.g5.4xlarge", + "ml.g5.8xlarge", + "ml.g5.12xlarge", + "ml.g5.16xlarge", + "ml.g5.24xlarge", + "ml.g5.48xlarge", + "ml.c5.large", + "ml.c5.xlarge", + "ml.c5.2xlarge", + "ml.c5.4xlarge", + "ml.c5.9xlarge", + "ml.c5.12xlarge", + "ml.c5.18xlarge", + "ml.c5.24xlarge", + "ml.c5n.large", + "ml.c5n.2xlarge", + "ml.c5n.4xlarge", + "ml.c5n.9xlarge", + "ml.c5n.18xlarge", + "ml.m5.large", + "ml.m5.xlarge", + "ml.m5.2xlarge", + "ml.m5.4xlarge", + "ml.m5.8xlarge", + "ml.m5.12xlarge", + "ml.m5.16xlarge", + "ml.m5.24xlarge", + "ml.t3.medium", + "ml.t3.large", + "ml.t3.xlarge", + "ml.t3.2xlarge" + ] + }, + "ClusterLifeCycleConfig":{ + "type":"structure", + "required":[ + "SourceS3Uri", + "OnCreate" + ], + "members":{ + "SourceS3Uri":{ + "shape":"S3Uri", + "documentation":"

An Amazon S3 bucket path where your LifeCycle scripts are stored.

" + }, + "OnCreate":{ + "shape":"ClusterLifeCycleConfigFileName", + "documentation":"

The directory of the LifeCycle script under SourceS3Uri. This LifeCycle script runs during cluster creation.

" + } + }, + "documentation":"

The LifeCycle configuration for a SageMaker HyperPod cluster.

" + }, + "ClusterLifeCycleConfigFileName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[\\S\\s]+$" + }, + "ClusterName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + }, + "ClusterNameOrArn":{ + "type":"string", + "max":256, + "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})$" + }, + "ClusterNodeDetails":{ + "type":"structure", + "members":{ + "InstanceGroupName":{ + "shape":"ClusterInstanceGroupName", + "documentation":"

The instance group name in which the instance is.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "InstanceStatus":{ + "shape":"ClusterInstanceStatusDetails", + "documentation":"

The status of the instance.

" + }, + "InstanceType":{ + "shape":"ClusterInstanceType", + "documentation":"

The type of the instance.

" + }, + "LaunchTime":{ + "shape":"Timestamp", + "documentation":"

The time when the instance is launched.

" + }, + "LifeCycleConfig":{ + "shape":"ClusterLifeCycleConfig", + "documentation":"

The LifeCycle configuration applied to the instance.

" + }, + "ThreadsPerCore":{ + "shape":"ClusterThreadsPerCore", + "documentation":"

The number of threads per CPU core you specified under CreateCluster.

" + } + }, + "documentation":"

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

" + }, + "ClusterNodeId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z][-a-zA-Z0-9]*$" + }, + "ClusterNodeSummaries":{ + "type":"list", + "member":{"shape":"ClusterNodeSummary"} + }, + "ClusterNodeSummary":{ + "type":"structure", + "required":[ + "InstanceGroupName", + "InstanceId", + "InstanceType", + "LaunchTime", + "InstanceStatus" + ], + "members":{ + "InstanceGroupName":{ + "shape":"ClusterInstanceGroupName", + "documentation":"

The name of the instance group in which the instance is.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "InstanceType":{ + "shape":"ClusterInstanceType", + "documentation":"

The type of the instance.

" + }, + "LaunchTime":{ + "shape":"Timestamp", + "documentation":"

The time when the instance is launched.

" + }, + "InstanceStatus":{ + "shape":"ClusterInstanceStatusDetails", + "documentation":"

The status of the instance.

" + } + }, + "documentation":"

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

" + }, + "ClusterNonNegativeInstanceCount":{ + "type":"integer", + "min":0 + }, + "ClusterSortBy":{ + "type":"string", + "enum":[ + "CREATION_TIME", + "NAME" + ] + }, + "ClusterStatus":{ + "type":"string", + "enum":[ + "Creating", + "Deleting", + "Failed", + "InService", + "RollingBack", + "SystemUpdating", + "Updating" + ] + }, + "ClusterSummaries":{ + "type":"list", + "member":{"shape":"ClusterSummary"} + }, + "ClusterSummary":{ + "type":"structure", + "required":[ + "ClusterArn", + "ClusterName", + "CreationTime", + "ClusterStatus" + ], + "members":{ + "ClusterArn":{ + "shape":"ClusterArn", + "documentation":"

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

" + }, + "ClusterName":{ + "shape":"ClusterName", + "documentation":"

The name of the SageMaker HyperPod cluster.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time when the SageMaker HyperPod cluster is created.

" + }, + "ClusterStatus":{ + "shape":"ClusterStatus", + "documentation":"

The status of the SageMaker HyperPod cluster.

" + } + }, + "documentation":"

Lists a summary of the properties of a SageMaker HyperPod cluster.

" + }, + "ClusterThreadsPerCore":{ + "type":"integer", + "max":2, + "min":1 + }, "CodeRepositories":{ "type":"list", "member":{"shape":"CodeRepository"}, @@ -7458,6 +7954,38 @@ } } }, + "CreateClusterRequest":{ + "type":"structure", + "required":[ + "ClusterName", + "InstanceGroups" + ], + "members":{ + "ClusterName":{ + "shape":"ClusterName", + "documentation":"

The name for the new SageMaker HyperPod cluster.

" + }, + "InstanceGroups":{ + "shape":"ClusterInstanceGroupSpecifications", + "documentation":"

The instance groups to be created in the SageMaker HyperPod cluster.

" + }, + "VpcConfig":{"shape":"VpcConfig"}, + "Tags":{ + "shape":"TagList", + "documentation":"

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

" + } + } + }, + "CreateClusterResponse":{ + "type":"structure", + "required":["ClusterArn"], + "members":{ + "ClusterArn":{ + "shape":"ClusterArn", + "documentation":"

The Amazon Resource Name (ARN) of the cluster.

" + } + } + }, "CreateCodeRepositoryInput":{ "type":"structure", "required":[ @@ -7696,11 +8224,11 @@ }, "SubnetIds":{ "shape":"Subnets", - "documentation":"

The VPC subnets that Studio uses for communication.

" + "documentation":"

The VPC subnets that the domain uses for communication.

" }, "VpcId":{ "shape":"VpcId", - "documentation":"

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

" + "documentation":"

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

" }, "Tags":{ "shape":"TagList", @@ -7708,7 +8236,7 @@ }, "AppNetworkAccessType":{ "shape":"AppNetworkAccessType", - "documentation":"

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

" + "documentation":"

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

" }, "HomeEfsFileSystemKmsKeyId":{ "shape":"KmsKeyId", @@ -7884,6 +8412,15 @@ "ShadowProductionVariants":{ "shape":"ProductionVariantList", "documentation":"

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

" + }, + "ExecutionRoleArn":{ + "shape":"RoleArn", + "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 Roles.

To be able to pass this role to Amazon SageMaker, the caller of this action must have the iam:PassRole permission.

" + }, + "VpcConfig":{"shape":"VpcConfig"}, + "EnableNetworkIsolation":{ + "shape":"Boolean", + "documentation":"

Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

" } } }, @@ -8286,6 +8823,52 @@ } } }, + "CreateInferenceComponentInput":{ + "type":"structure", + "required":[ + "InferenceComponentName", + "EndpointName", + "VariantName", + "Specification", + "RuntimeConfig" + ], + "members":{ + "InferenceComponentName":{ + "shape":"InferenceComponentName", + "documentation":"

A unique name to assign to the inference component.

" + }, + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

The name of an existing endpoint where you host the inference component.

" + }, + "VariantName":{ + "shape":"VariantName", + "documentation":"

The name of an existing production variant where you host the inference component.

" + }, + "Specification":{ + "shape":"InferenceComponentSpecification", + "documentation":"

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

" + }, + "RuntimeConfig":{ + "shape":"InferenceComponentRuntimeConfig", + "documentation":"

Runtime settings for a model that is deployed with an inference component.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

" + } + } + }, + "CreateInferenceComponentOutput":{ + "type":"structure", + "required":["InferenceComponentArn"], + "members":{ + "InferenceComponentArn":{ + "shape":"InferenceComponentArn", + "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" + } + } + }, "CreateInferenceExperimentRequest":{ "type":"structure", "required":[ @@ -8655,10 +9238,7 @@ }, "CreateModelInput":{ "type":"structure", - "required":[ - "ModelName", - "ExecutionRoleArn" - ], + "required":["ModelName"], "members":{ "ModelName":{ "shape":"ModelName", @@ -9098,6 +9678,10 @@ "SpaceName":{ "shape":"SpaceName", "documentation":"

The name of the space.

" + }, + "LandingUri":{ + "shape":"LandingUri", + "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:

" } } }, @@ -9281,11 +9865,11 @@ "members":{ "StudioLifecycleConfigName":{ "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Studio Lifecycle Configuration to create.

" + "documentation":"

The name of the Amazon SageMaker Studio Lifecycle Configuration to create.

" }, "StudioLifecycleConfigContent":{ "shape":"StudioLifecycleConfigContent", - "documentation":"

The content of your Studio Lifecycle Configuration script. This content must be base64 encoded.

" + "documentation":"

The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.

" }, "StudioLifecycleConfigAppType":{ "shape":"StudioLifecycleConfigAppType", @@ -9392,6 +9976,10 @@ "RetryStrategy":{ "shape":"RetryStrategy", "documentation":"

The number of times to retry the job when the job fails due to an InternalServerError.

" + }, + "InfraCheckConfig":{ + "shape":"InfraCheckConfig", + "documentation":"

Contains information about the infrastructure health check configuration for the training job.

" } } }, @@ -10251,6 +10839,26 @@ } } }, + "DeleteClusterRequest":{ + "type":"structure", + "required":["ClusterName"], + "members":{ + "ClusterName":{ + "shape":"ClusterNameOrArn", + "documentation":"

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

" + } + } + }, + "DeleteClusterResponse":{ + "type":"structure", + "required":["ClusterArn"], + "members":{ + "ClusterArn":{ + "shape":"ClusterArn", + "documentation":"

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

" + } + } + }, "DeleteCodeRepositoryInput":{ "type":"structure", "required":["CodeRepositoryName"], @@ -10495,6 +11103,16 @@ "members":{ } }, + "DeleteInferenceComponentInput":{ + "type":"structure", + "required":["InferenceComponentName"], + "members":{ + "InferenceComponentName":{ + "shape":"InferenceComponentName", + "documentation":"

The name of the inference component to delete.

" + } + } + }, "DeleteInferenceExperimentRequest":{ "type":"structure", "required":["Name"], @@ -10685,7 +11303,7 @@ "members":{ "StudioLifecycleConfigName":{ "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Studio Lifecycle Configuration to delete.

" + "documentation":"

The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.

" } } }, @@ -11469,6 +12087,78 @@ } } }, + "DescribeClusterNodeRequest":{ + "type":"structure", + "required":[ + "ClusterName", + "NodeId" + ], + "members":{ + "ClusterName":{ + "shape":"ClusterNameOrArn", + "documentation":"

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.

" + }, + "NodeId":{ + "shape":"ClusterNodeId", + "documentation":"

The ID of the instance.

" + } + } + }, + "DescribeClusterNodeResponse":{ + "type":"structure", + "required":["NodeDetails"], + "members":{ + "NodeDetails":{ + "shape":"ClusterNodeDetails", + "documentation":"

The details of the instance.

" + } + } + }, + "DescribeClusterRequest":{ + "type":"structure", + "required":["ClusterName"], + "members":{ + "ClusterName":{ + "shape":"ClusterNameOrArn", + "documentation":"

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

" + } + } + }, + "DescribeClusterResponse":{ + "type":"structure", + "required":[ + "ClusterArn", + "ClusterStatus", + "InstanceGroups" + ], + "members":{ + "ClusterArn":{ + "shape":"ClusterArn", + "documentation":"

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

" + }, + "ClusterName":{ + "shape":"ClusterName", + "documentation":"

The name of the SageMaker HyperPod cluster.

" + }, + "ClusterStatus":{ + "shape":"ClusterStatus", + "documentation":"

The status of the SageMaker HyperPod cluster.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time when the SageMaker Cluster is created.

" + }, + "FailureMessage":{ + "shape":"String", + "documentation":"

The failure message of the SageMaker HyperPod cluster.

" + }, + "InstanceGroups":{ + "shape":"ClusterInstanceGroupDetailsList", + "documentation":"

The instance groups of the SageMaker HyperPod cluster.

" + }, + "VpcConfig":{"shape":"VpcConfig"} + } + }, "DescribeCodeRepositoryInput":{ "type":"structure", "required":["CodeRepositoryName"], @@ -11915,7 +12605,7 @@ }, "AppNetworkAccessType":{ "shape":"AppNetworkAccessType", - "documentation":"

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

" + "documentation":"

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

" }, "HomeEfsFileSystemKmsKeyId":{ "shape":"KmsKeyId", @@ -11925,7 +12615,7 @@ }, "SubnetIds":{ "shape":"Subnets", - "documentation":"

The VPC subnets that Studio uses for communication.

" + "documentation":"

The VPC subnets that the domain uses for communication.

" }, "Url":{ "shape":"String1024", @@ -11933,7 +12623,7 @@ }, "VpcId":{ "shape":"VpcId", - "documentation":"

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

" + "documentation":"

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

" }, "KmsKeyId":{ "shape":"KmsKeyId", @@ -12162,6 +12852,15 @@ "ShadowProductionVariants":{ "shape":"ProductionVariantList", "documentation":"

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

" + }, + "ExecutionRoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.

" + }, + "VpcConfig":{"shape":"VpcConfig"}, + "EnableNetworkIsolation":{ + "shape":"Boolean", + "documentation":"

Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

" } } }, @@ -12952,6 +13651,73 @@ } } }, + "DescribeInferenceComponentInput":{ + "type":"structure", + "required":["InferenceComponentName"], + "members":{ + "InferenceComponentName":{ + "shape":"InferenceComponentName", + "documentation":"

The name of the inference component.

" + } + } + }, + "DescribeInferenceComponentOutput":{ + "type":"structure", + "required":[ + "InferenceComponentName", + "InferenceComponentArn", + "EndpointName", + "EndpointArn", + "CreationTime", + "LastModifiedTime" + ], + "members":{ + "InferenceComponentName":{ + "shape":"InferenceComponentName", + "documentation":"

The name of the inference component.

" + }, + "InferenceComponentArn":{ + "shape":"InferenceComponentArn", + "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" + }, + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

The name of the endpoint that hosts the inference component.

" + }, + "EndpointArn":{ + "shape":"EndpointArn", + "documentation":"

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

" + }, + "VariantName":{ + "shape":"VariantName", + "documentation":"

The name of the production variant that hosts the inference component.

" + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

If the inference component status is Failed, the reason for the failure.

" + }, + "Specification":{ + "shape":"InferenceComponentSpecificationSummary", + "documentation":"

Details about the resources that are deployed with this inference component.

" + }, + "RuntimeConfig":{ + "shape":"InferenceComponentRuntimeConfigSummary", + "documentation":"

Details about the runtime settings for the model that is deployed with the inference component.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time when the inference component was created.

" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

The time when the inference component was last updated.

" + }, + "InferenceComponentStatus":{ + "shape":"InferenceComponentStatus", + "documentation":"

The status of the inference component.

" + } + } + }, "DescribeInferenceExperimentRequest":{ "type":"structure", "required":["Name"], @@ -13526,7 +14292,6 @@ "type":"structure", "required":[ "ModelName", - "ExecutionRoleArn", "CreationTime", "ModelArn" ], @@ -14363,6 +15128,10 @@ "SpaceSettings":{ "shape":"SpaceSettings", "documentation":"

A collection of space settings.

" + }, + "Url":{ + "shape":"String1024", + "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.

The following application types are supported:

" } } }, @@ -14372,7 +15141,7 @@ "members":{ "StudioLifecycleConfigName":{ "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Studio Lifecycle Configuration to describe.

" + "documentation":"

The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.

" } } }, @@ -14385,19 +15154,19 @@ }, "StudioLifecycleConfigName":{ "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Studio Lifecycle Configuration that is described.

" + "documentation":"

The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.

" }, "CreationTime":{ "shape":"Timestamp", - "documentation":"

The creation time of the Studio Lifecycle Configuration.

" + "documentation":"

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

" }, "LastModifiedTime":{ "shape":"Timestamp", - "documentation":"

This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

" + "documentation":"

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

" }, "StudioLifecycleConfigContent":{ "shape":"StudioLifecycleConfigContent", - "documentation":"

The content of your Studio Lifecycle Configuration script.

" + "documentation":"

The content of your Amazon SageMaker Studio Lifecycle Configuration script.

" }, "StudioLifecycleConfigAppType":{ "shape":"StudioLifecycleConfigAppType", @@ -14597,6 +15366,10 @@ "WarmPoolStatus":{ "shape":"WarmPoolStatus", "documentation":"

The status of the warm pool associated with the training job.

" + }, + "InfraCheckConfig":{ + "shape":"InfraCheckConfig", + "documentation":"

Contains information about the infrastructure health check configuration for the training job.

" } } }, @@ -15962,6 +16735,7 @@ "pattern":"\\d+" }, "EnableCapture":{"type":"boolean"}, + "EnableInfraCheck":{"type":"boolean"}, "EnableIotRoleAlias":{"type":"boolean"}, "EnableSagemakerServicecatalogPortfolioInput":{ "type":"structure", @@ -18853,6 +19627,12 @@ }, "documentation":"

A version of a SageMaker Image. A version represents an existing container image.

" }, + "ImageVersionAlias":{ + "type":"string", + "max":128, + "min":1, + "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-]+)*))?$)" + }, "ImageVersionArn":{ "type":"string", "max":256, @@ -18968,6 +19748,234 @@ } } }, + "InferenceComponentArn":{ + "type":"string", + "max":2048, + "min":20 + }, + "InferenceComponentComputeResourceRequirements":{ + "type":"structure", + "required":["MinMemoryRequiredInMb"], + "members":{ + "NumberOfCpuCoresRequired":{ + "shape":"NumberOfCpuCores", + "documentation":"

The number of CPU cores to allocate to run a model that you assign to an inference component.

" + }, + "NumberOfAcceleratorDevicesRequired":{ + "shape":"NumberOfAcceleratorDevices", + "documentation":"

The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.

" + }, + "MinMemoryRequiredInMb":{ + "shape":"MemoryInMb", + "documentation":"

The minimum MB of memory to allocate to run a model that you assign to an inference component.

" + }, + "MaxMemoryRequiredInMb":{ + "shape":"MemoryInMb", + "documentation":"

The maximum MB of memory to allocate to run a model that you assign to an inference component.

" + } + }, + "documentation":"

Defines the compute resources to allocate to run a model that you assign to an inference component. These resources include CPU cores, accelerators, and memory.

" + }, + "InferenceComponentContainerSpecification":{ + "type":"structure", + "members":{ + "Image":{ + "shape":"ContainerImage", + "documentation":"

The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

" + }, + "ArtifactUrl":{ + "shape":"Url", + "documentation":"

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

" + }, + "Environment":{ + "shape":"EnvironmentMap", + "documentation":"

The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.

" + } + }, + "documentation":"

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

" + }, + "InferenceComponentContainerSpecificationSummary":{ + "type":"structure", + "members":{ + "DeployedImage":{"shape":"DeployedImage"}, + "ArtifactUrl":{ + "shape":"Url", + "documentation":"

The Amazon S3 path where the model artifacts are stored.

" + }, + "Environment":{ + "shape":"EnvironmentMap", + "documentation":"

The environment variables to set in the Docker container.

" + } + }, + "documentation":"

Details about the resources that are deployed with this inference component.

" + }, + "InferenceComponentCopyCount":{ + "type":"integer", + "min":0 + }, + "InferenceComponentName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + }, + "InferenceComponentNameContains":{ + "type":"string", + "max":63, + "pattern":"[a-zA-Z0-9-]+" + }, + "InferenceComponentRuntimeConfig":{ + "type":"structure", + "required":["CopyCount"], + "members":{ + "CopyCount":{ + "shape":"InferenceComponentCopyCount", + "documentation":"

The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.

" + } + }, + "documentation":"

Runtime settings for a model that is deployed with an inference component.

" + }, + "InferenceComponentRuntimeConfigSummary":{ + "type":"structure", + "members":{ + "DesiredCopyCount":{ + "shape":"InferenceComponentCopyCount", + "documentation":"

The number of runtime copies of the model container that you requested to deploy with the inference component.

" + }, + "CurrentCopyCount":{ + "shape":"InferenceComponentCopyCount", + "documentation":"

The number of runtime copies of the model container that are currently deployed.

" + } + }, + "documentation":"

Details about the runtime settings for the model that is deployed with the inference component.

" + }, + "InferenceComponentSortKey":{ + "type":"string", + "enum":[ + "Name", + "CreationTime", + "Status" + ] + }, + "InferenceComponentSpecification":{ + "type":"structure", + "required":["ComputeResourceRequirements"], + "members":{ + "ModelName":{ + "shape":"ModelName", + "documentation":"

The name of an existing SageMaker model object in your account that you want to deploy with the inference component.

" + }, + "Container":{ + "shape":"InferenceComponentContainerSpecification", + "documentation":"

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

" + }, + "StartupParameters":{ + "shape":"InferenceComponentStartupParameters", + "documentation":"

Settings that take effect while the model container starts up.

" + }, + "ComputeResourceRequirements":{ + "shape":"InferenceComponentComputeResourceRequirements", + "documentation":"

The compute resources allocated to run the model assigned to the inference component.

" + } + }, + "documentation":"

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

" + }, + "InferenceComponentSpecificationSummary":{ + "type":"structure", + "members":{ + "ModelName":{ + "shape":"ModelName", + "documentation":"

The name of the SageMaker model object that is deployed with the inference component.

" + }, + "Container":{ + "shape":"InferenceComponentContainerSpecificationSummary", + "documentation":"

Details about the container that provides the runtime environment for the model that is deployed with the inference component.

" + }, + "StartupParameters":{ + "shape":"InferenceComponentStartupParameters", + "documentation":"

Settings that take effect while the model container starts up.

" + }, + "ComputeResourceRequirements":{ + "shape":"InferenceComponentComputeResourceRequirements", + "documentation":"

The compute resources allocated to run the model assigned to the inference component.

" + } + }, + "documentation":"

Details about the resources that are deployed with this inference component.

" + }, + "InferenceComponentStartupParameters":{ + "type":"structure", + "members":{ + "ModelDataDownloadTimeoutInSeconds":{ + "shape":"ProductionVariantModelDataDownloadTimeoutInSeconds", + "documentation":"

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.

" + }, + "ContainerStartupHealthCheckTimeoutInSeconds":{ + "shape":"ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", + "documentation":"

The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

" + } + }, + "documentation":"

Settings that take effect while the model container starts up.

" + }, + "InferenceComponentStatus":{ + "type":"string", + "enum":[ + "InService", + "Creating", + "Updating", + "Failed", + "Deleting" + ] + }, + "InferenceComponentSummary":{ + "type":"structure", + "required":[ + "CreationTime", + "InferenceComponentArn", + "InferenceComponentName", + "EndpointArn", + "EndpointName", + "VariantName", + "LastModifiedTime" + ], + "members":{ + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time when the inference component was created.

" + }, + "InferenceComponentArn":{ + "shape":"InferenceComponentArn", + "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" + }, + "InferenceComponentName":{ + "shape":"InferenceComponentName", + "documentation":"

The name of the inference component.

" + }, + "EndpointArn":{ + "shape":"EndpointArn", + "documentation":"

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

" + }, + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

The name of the endpoint that hosts the inference component.

" + }, + "VariantName":{ + "shape":"VariantName", + "documentation":"

The name of the production variant that hosts the inference component.

" + }, + "InferenceComponentStatus":{ + "shape":"InferenceComponentStatus", + "documentation":"

The status of the inference component.

" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

The time when the inference component was last updated.

" + } + }, + "documentation":"

A summary of the properties of an inference component.

" + }, + "InferenceComponentSummaryList":{ + "type":"list", + "member":{"shape":"InferenceComponentSummary"} + }, "InferenceExecutionConfig":{ "type":"structure", "required":["Mode"], @@ -19317,6 +20325,16 @@ "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" }, + "InfraCheckConfig":{ + "type":"structure", + "members":{ + "EnableInfraCheck":{ + "shape":"EnableInfraCheck", + "documentation":"

Enables an infrastructure health check.

" + } + }, + "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 connectivity.

" + }, "InitialInstanceCount":{ "type":"integer", "min":1 @@ -20076,6 +21094,10 @@ }, "documentation":"

Metadata for a Lambda step.

" }, + "LandingUri":{ + "type":"string", + "max":1023 + }, "LastModifiedTime":{"type":"timestamp"}, "LastUpdateStatus":{ "type":"structure", @@ -20617,6 +21639,111 @@ } } }, + "ListClusterNodesRequest":{ + "type":"structure", + "required":["ClusterName"], + "members":{ + "ClusterName":{ + "shape":"ClusterNameOrArn", + "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.

" + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

" + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

" + }, + "InstanceGroupNameContains":{ + "shape":"ClusterInstanceGroupName", + "documentation":"

A filter that returns the instance groups whose name contain a specified string.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of nodes to return in the response.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

" + }, + "SortBy":{ + "shape":"ClusterSortBy", + "documentation":"

The field by which to sort results. The default value is CREATION_TIME.

" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

The sort order for results. The default value is Ascending.

" + } + } + }, + "ListClusterNodesResponse":{ + "type":"structure", + "required":[ + "NextToken", + "ClusterNodeSummaries" + ], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The next token specified for listing instances in a SageMaker HyperPod cluster.

" + }, + "ClusterNodeSummaries":{ + "shape":"ClusterNodeSummaries", + "documentation":"

The summaries of listed instances in a SageMaker HyperPod cluster

" + } + } + }, + "ListClustersRequest":{ + "type":"structure", + "members":{ + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

" + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

Set the maximum number of SageMaker HyperPod clusters to list.

" + }, + "NameContains":{ + "shape":"NameContains", + "documentation":"

Set the maximum number of instances to print in the list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Set the next token to retrieve the list of SageMaker HyperPod clusters.

" + }, + "SortBy":{ + "shape":"ClusterSortBy", + "documentation":"

The field by which to sort results. The default value is CREATION_TIME.

" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

The sort order for results. The default value is Ascending.

" + } + } + }, + "ListClustersResponse":{ + "type":"structure", + "required":[ + "NextToken", + "ClusterSummaries" + ], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the result of the previous ListClusters request was truncated, the response includes a NextToken. To retrieve the next set of clusters, use the token in the next request.

" + }, + "ClusterSummaries":{ + "shape":"ClusterSummaries", + "documentation":"

The summaries of listed SageMaker HyperPod clusters.

" + } + } + }, "ListCodeRepositoriesInput":{ "type":"structure", "members":{ @@ -21755,6 +22882,73 @@ } } }, + "ListInferenceComponentsInput":{ + "type":"structure", + "members":{ + "SortBy":{ + "shape":"InferenceComponentSortKey", + "documentation":"

The field by which to sort the inference components in the response. The default is CreationTime.

" + }, + "SortOrder":{ + "shape":"OrderKey", + "documentation":"

The sort order for results. The default is Descending.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of inference components to return in the response. This value defaults to 10.

" + }, + "NameContains":{ + "shape":"InferenceComponentNameContains", + "documentation":"

Filters the results to only those inference components with a name that contains the specified string.

" + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the results to only those inference components that were created before the specified time.

" + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the results to only those inference components that were created after the specified time.

" + }, + "LastModifiedTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the results to only those inference components that were updated before the specified time.

" + }, + "LastModifiedTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the results to only those inference components that were updated after the specified time.

" + }, + "StatusEquals":{ + "shape":"InferenceComponentStatus", + "documentation":"

Filters the results to only those inference components with the specified status.

" + }, + "EndpointNameEquals":{ + "shape":"EndpointName", + "documentation":"

An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

" + }, + "VariantNameEquals":{ + "shape":"VariantName", + "documentation":"

A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

" + } + } + }, + "ListInferenceComponentsOutput":{ + "type":"structure", + "required":["InferenceComponents"], + "members":{ + "InferenceComponents":{ + "shape":"InferenceComponentSummaryList", + "documentation":"

A list of inference components and their properties that matches any of the filters you specified in the request.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The token to use in a subsequent request to get the next set of results following a truncated response.

" + } + } + }, "ListInferenceExperimentsRequest":{ "type":"structure", "members":{ @@ -23895,6 +25089,21 @@ "min":1, "pattern":"^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" }, + "ManagedInstanceScalingMaxInstanceCount":{ + "type":"integer", + "min":1 + }, + "ManagedInstanceScalingMinInstanceCount":{ + "type":"integer", + "min":1 + }, + "ManagedInstanceScalingStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "MaxAutoMLJobRuntimeInSeconds":{ "type":"integer", "min":1 @@ -24013,6 +25222,10 @@ "max":10, "min":1 }, + "MemoryInMb":{ + "type":"integer", + "min":128 + }, "MetadataProperties":{ "type":"structure", "members":{ @@ -26801,6 +28014,14 @@ "type":"string", "pattern":"arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*" }, + "NumberOfAcceleratorDevices":{ + "type":"float", + "min":1 + }, + "NumberOfCpuCores":{ + "type":"float", + "min":0.25 + }, "NumberOfHumanWorkersPerDataObject":{ "type":"integer", "max":9, @@ -27346,6 +28567,14 @@ "DesiredServerlessConfig":{ "shape":"ProductionVariantServerlessConfig", "documentation":"

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

" + }, + "ManagedInstanceScaling":{ + "shape":"ProductionVariantManagedInstanceScaling", + "documentation":"

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

" + }, + "RoutingConfig":{ + "shape":"ProductionVariantRoutingConfig", + "documentation":"

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

" } }, "documentation":"

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

" @@ -28306,10 +29535,7 @@ }, "ProductionVariant":{ "type":"structure", - "required":[ - "VariantName", - "ModelName" - ], + "required":["VariantName"], "members":{ "VariantName":{ "shape":"VariantName", @@ -28358,6 +29584,14 @@ "EnableSSMAccess":{ "shape":"ProductionVariantSSMAccess", "documentation":"

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

" + }, + "ManagedInstanceScaling":{ + "shape":"ProductionVariantManagedInstanceScaling", + "documentation":"

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

" + }, + "RoutingConfig":{ + "shape":"ProductionVariantRoutingConfig", + "documentation":"

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

" } }, "documentation":"

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.

" @@ -28552,11 +29786,40 @@ "max":10, "min":1 }, + "ProductionVariantManagedInstanceScaling":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ManagedInstanceScalingStatus", + "documentation":"

Indicates whether managed instance scaling is enabled.

" + }, + "MinInstanceCount":{ + "shape":"ManagedInstanceScalingMinInstanceCount", + "documentation":"

The minimum number of instances that the endpoint must retain when it scales down to accommodate a decrease in traffic.

" + }, + "MaxInstanceCount":{ + "shape":"ManagedInstanceScalingMaxInstanceCount", + "documentation":"

The maximum number of instances that the endpoint can provision when it scales up to accommodate an increase in traffic.

" + } + }, + "documentation":"

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

" + }, "ProductionVariantModelDataDownloadTimeoutInSeconds":{ "type":"integer", "max":3600, "min":60 }, + "ProductionVariantRoutingConfig":{ + "type":"structure", + "required":["RoutingStrategy"], + "members":{ + "RoutingStrategy":{ + "shape":"RoutingStrategy", + "documentation":"

Sets how the endpoint routes incoming traffic:

" + } + }, + "documentation":"

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

" + }, "ProductionVariantSSMAccess":{"type":"boolean"}, "ProductionVariantServerlessConfig":{ "type":"structure", @@ -28658,6 +29921,14 @@ "DesiredServerlessConfig":{ "shape":"ProductionVariantServerlessConfig", "documentation":"

The serverless configuration requested for the endpoint update.

" + }, + "ManagedInstanceScaling":{ + "shape":"ProductionVariantManagedInstanceScaling", + "documentation":"

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

" + }, + "RoutingConfig":{ + "shape":"ProductionVariantRoutingConfig", + "documentation":"

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

" } }, "documentation":"

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

" @@ -30105,6 +31376,10 @@ "shape":"ImageVersionArn", "documentation":"

The ARN of the image version created on the instance.

" }, + "SageMakerImageVersionAlias":{ + "shape":"ImageVersionAlias", + "documentation":"

The SageMakerImageVersionAlias.

" + }, "InstanceType":{ "shape":"AppInstanceType", "documentation":"

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

" @@ -30243,6 +31518,13 @@ "Disabled" ] }, + "RoutingStrategy":{ + "type":"string", + "enum":[ + "LEAST_OUTSTANDING_REQUESTS", + "RANDOM" + ] + }, "RuleConfigurationName":{ "type":"string", "max":256, @@ -30917,7 +32199,7 @@ "documentation":"

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

" } }, - "documentation":"

Specifies options for sharing SageMaker Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.

" + "documentation":"

Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.

" }, "ShuffleConfig":{ "type":"structure", @@ -31643,22 +32925,22 @@ }, "StudioLifecycleConfigName":{ "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Studio Lifecycle Configuration.

" + "documentation":"

The name of the Amazon SageMaker Studio Lifecycle Configuration.

" }, "CreationTime":{ "shape":"Timestamp", - "documentation":"

The creation time of the Studio Lifecycle Configuration.

" + "documentation":"

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

" }, "LastModifiedTime":{ "shape":"Timestamp", - "documentation":"

This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

" + "documentation":"

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

" }, "StudioLifecycleConfigAppType":{ "shape":"StudioLifecycleConfigAppType", "documentation":"

The App type to which the Lifecycle Configuration is attached.

" } }, - "documentation":"

Details of the Studio Lifecycle Configuration.

" + "documentation":"

Details of the Amazon SageMaker Studio Lifecycle Configuration.

" }, "StudioLifecycleConfigName":{ "type":"string", @@ -31677,6 +32959,13 @@ "type":"list", "member":{"shape":"StudioLifecycleConfigDetails"} }, + "StudioWebPortal":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "SubnetId":{ "type":"string", "max":32, @@ -32057,13 +33346,37 @@ }, "documentation":"

The collection of settings used by an AutoML job V2 for the text classification problem type.

" }, + "TextGenerationHyperParameterKey":{ + "type":"string", + "max":32, + "pattern":"^[a-zA-Z0-9._-]+$" + }, + "TextGenerationHyperParameterValue":{ + "type":"string", + "max":16, + "pattern":"^[a-zA-Z0-9._-]+$" + }, + "TextGenerationHyperParameters":{ + "type":"map", + "key":{"shape":"TextGenerationHyperParameterKey"}, + "value":{"shape":"TextGenerationHyperParameterValue"}, + "max":30, + "min":0 + }, "TextGenerationJobConfig":{ "type":"structure", "members":{ - "CompletionCriteria":{"shape":"AutoMLJobCompletionCriteria"}, + "CompletionCriteria":{ + "shape":"AutoMLJobCompletionCriteria", + "documentation":"

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h (259200s).

" + }, "BaseModelName":{ "shape":"BaseModelName", - "documentation":"

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no BaseModelName is provided, the default model used is Falcon-7B-Instruct.

" + "documentation":"

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no BaseModelName is provided, the default model used is Falcon7BInstruct.

" + }, + "TextGenerationHyperParameters":{ + "shape":"TextGenerationHyperParameters", + "documentation":"

The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see Optimize the learning process of your text generation models with hyperparameters.

Here is an example where all four hyperparameters are configured.

{ \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\", \"learningRateWarmupSteps\": \"10\" }

" } }, "documentation":"

The collection of settings used by an AutoML job V2 for the text generation problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

" @@ -33738,6 +35051,33 @@ } } }, + "UpdateClusterRequest":{ + "type":"structure", + "required":[ + "ClusterName", + "InstanceGroups" + ], + "members":{ + "ClusterName":{ + "shape":"ClusterNameOrArn", + "documentation":"

Specify the name of the SageMaker HyperPod cluster you want to update.

" + }, + "InstanceGroups":{ + "shape":"ClusterInstanceGroupSpecifications", + "documentation":"

Specify the instance groups to update.

" + } + } + }, + "UpdateClusterResponse":{ + "type":"structure", + "required":["ClusterArn"], + "members":{ + "ClusterArn":{ + "shape":"ClusterArn", + "documentation":"

The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

" + } + } + }, "UpdateCodeRepositoryInput":{ "type":"structure", "required":["CodeRepositoryName"], @@ -33862,6 +35202,14 @@ "AppSecurityGroupManagement":{ "shape":"AppSecurityGroupManagement", "documentation":"

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

" + }, + "SubnetIds":{ + "shape":"Subnets", + "documentation":"

The VPC subnets that Studio uses for communication.

If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

" + }, + "AppNetworkAccessType":{ + "shape":"AppNetworkAccessType", + "documentation":"

Specifies the VPC used for non-EFS traffic.

This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

" } } }, @@ -34158,6 +35506,61 @@ } } }, + "UpdateInferenceComponentInput":{ + "type":"structure", + "required":["InferenceComponentName"], + "members":{ + "InferenceComponentName":{ + "shape":"InferenceComponentName", + "documentation":"

The name of the inference component.

" + }, + "Specification":{ + "shape":"InferenceComponentSpecification", + "documentation":"

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

" + }, + "RuntimeConfig":{ + "shape":"InferenceComponentRuntimeConfig", + "documentation":"

Runtime settings for a model that is deployed with an inference component.

" + } + } + }, + "UpdateInferenceComponentOutput":{ + "type":"structure", + "required":["InferenceComponentArn"], + "members":{ + "InferenceComponentArn":{ + "shape":"InferenceComponentArn", + "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" + } + } + }, + "UpdateInferenceComponentRuntimeConfigInput":{ + "type":"structure", + "required":[ + "InferenceComponentName", + "DesiredRuntimeConfig" + ], + "members":{ + "InferenceComponentName":{ + "shape":"InferenceComponentName", + "documentation":"

The name of the inference component to update.

" + }, + "DesiredRuntimeConfig":{ + "shape":"InferenceComponentRuntimeConfig", + "documentation":"

Runtime settings for a model that is deployed with an inference component.

" + } + } + }, + "UpdateInferenceComponentRuntimeConfigOutput":{ + "type":"structure", + "required":["InferenceComponentArn"], + "members":{ + "InferenceComponentArn":{ + "shape":"InferenceComponentArn", + "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" + } + } + }, "UpdateInferenceExperimentRequest":{ "type":"structure", "required":["Name"], @@ -34863,11 +36266,11 @@ }, "SecurityGroups":{ "shape":"SecurityGroupIds", - "documentation":"

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

" + "documentation":"

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

" }, "SharingSettings":{ "shape":"SharingSettings", - "documentation":"

Specifies options for sharing SageMaker Studio notebooks.

" + "documentation":"

Specifies options for sharing Amazon SageMaker Studio notebooks.

" }, "JupyterServerAppSettings":{ "shape":"JupyterServerAppSettings", @@ -34892,9 +36295,17 @@ "CanvasAppSettings":{ "shape":"CanvasAppSettings", "documentation":"

The Canvas app settings.

" + }, + "DefaultLandingUri":{ + "shape":"LandingUri", + "documentation":"

The default experience that the user is directed to when accessing the domain. The supported values are:

" + }, + "StudioWebPortal":{ + "shape":"StudioWebPortal", + "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.

" } }, - "documentation":"

A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

" + "documentation":"

A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

" }, "UsersPerStep":{ "type":"integer", @@ -35030,14 +36441,14 @@ "members":{ "SecurityGroupIds":{ "shape":"VpcSecurityGroupIds", - "documentation":"

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" + "documentation":"

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" }, "Subnets":{ "shape":"Subnets", "documentation":"

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

" } }, - "documentation":"

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.

" + "documentation":"

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

" }, "VpcId":{ "type":"string", diff --git a/botocore/data/sts/2011-06-15/service-2.json b/botocore/data/sts/2011-06-15/service-2.json index 9c0543ec90..eeb8724f58 100644 --- a/botocore/data/sts/2011-06-15/service-2.json +++ b/botocore/data/sts/2011-06-15/service-2.json @@ -206,7 +206,7 @@ }, "ProvidedContexts":{ "shape":"ProvidedContextsListType", - "documentation":"

A list of previously acquired trusted context assertions in the format of a JSON array. The trusted context assertion is signed and encrypted by Amazon Web Services STS.

The following is an example of a ProvidedContext value that includes a single trusted context assertion and the ARN of the context provider from which the trusted context assertion was generated.

[{\"ProviderArn\":\"arn:aws:iam::aws:contextProvider/identitycenter\",\"ContextAssertion\":\"trusted-context-assertion\"}]

" + "documentation":"

A list of previously acquired trusted context assertions in the format of a JSON array. The trusted context assertion is signed and encrypted by Amazon Web Services STS.

The following is an example of a ProvidedContext value that includes a single trusted context assertion and the ARN of the context provider from which the trusted context assertion was generated.

[{\"ProviderArn\":\"arn:aws:iam::aws:contextProvider/IdentityCenter\",\"ContextAssertion\":\"trusted-context-assertion\"}]

" } } }, diff --git a/docs/source/conf.py b/docs/source/conf.py index 45d5a39f85..917dcd4c3a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.33' # The full version, including alpha/beta/rc tags. -release = '1.33.2' +release = '1.33.3' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/tests/functional/endpoint-rules/cleanroomsml/endpoint-tests-1.json b/tests/functional/endpoint-rules/cleanroomsml/endpoint-tests-1.json new file mode 100644 index 0000000000..3d35e84b64 --- /dev/null +++ b/tests/functional/endpoint-rules/cleanroomsml/endpoint-tests-1.json @@ -0,0 +1,314 @@ +{ + "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" +} \ No newline at end of file diff --git a/tests/functional/endpoint-rules/opensearchserverless/endpoint-tests-1.json b/tests/functional/endpoint-rules/opensearchserverless/endpoint-tests-1.json index 944c804cc5..b93eb3e970 100644 --- a/tests/functional/endpoint-rules/opensearchserverless/endpoint-tests-1.json +++ b/tests/functional/endpoint-rules/opensearchserverless/endpoint-tests-1.json @@ -308,6 +308,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"