Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "You don't have authorization to perform the requested action.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#AgentUpdateStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "STAGING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STAGING" - } - }, - "STAGED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STAGED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] }, - "com.amazonaws.ecs#AmazonEC2ContainerServiceV20141113": { - "type": "service", - "version": "2014-11-13", - "operations": [ - { - "target": "com.amazonaws.ecs#CreateCapacityProvider" - }, - { - "target": "com.amazonaws.ecs#CreateCluster" - }, - { - "target": "com.amazonaws.ecs#CreateService" - }, - { - "target": "com.amazonaws.ecs#CreateTaskSet" - }, - { - "target": "com.amazonaws.ecs#DeleteAccountSetting" - }, - { - "target": "com.amazonaws.ecs#DeleteAttributes" - }, - { - "target": "com.amazonaws.ecs#DeleteCapacityProvider" - }, - { - "target": "com.amazonaws.ecs#DeleteCluster" - }, - { - "target": "com.amazonaws.ecs#DeleteService" - }, - { - "target": "com.amazonaws.ecs#DeleteTaskDefinitions" - }, - { - "target": "com.amazonaws.ecs#DeleteTaskSet" - }, - { - "target": "com.amazonaws.ecs#DeregisterContainerInstance" - }, - { - "target": "com.amazonaws.ecs#DeregisterTaskDefinition" - }, - { - "target": "com.amazonaws.ecs#DescribeCapacityProviders" - }, - { - "target": "com.amazonaws.ecs#DescribeClusters" - }, - { - "target": "com.amazonaws.ecs#DescribeContainerInstances" - }, - { - "target": "com.amazonaws.ecs#DescribeServiceDeployments" - }, - { - "target": "com.amazonaws.ecs#DescribeServiceRevisions" - }, - { - "target": "com.amazonaws.ecs#DescribeServices" - }, - { - "target": "com.amazonaws.ecs#DescribeTaskDefinition" - }, - { - "target": "com.amazonaws.ecs#DescribeTasks" - }, - { - "target": "com.amazonaws.ecs#DescribeTaskSets" - }, - { - "target": "com.amazonaws.ecs#DiscoverPollEndpoint" - }, - { - "target": "com.amazonaws.ecs#ExecuteCommand" - }, - { - "target": "com.amazonaws.ecs#GetTaskProtection" - }, - { - "target": "com.amazonaws.ecs#ListAccountSettings" - }, - { - "target": "com.amazonaws.ecs#ListAttributes" - }, - { - "target": "com.amazonaws.ecs#ListClusters" - }, - { - "target": "com.amazonaws.ecs#ListContainerInstances" - }, - { - "target": "com.amazonaws.ecs#ListServiceDeployments" - }, - { - "target": "com.amazonaws.ecs#ListServices" - }, - { - "target": "com.amazonaws.ecs#ListServicesByNamespace" - }, - { - "target": "com.amazonaws.ecs#ListTagsForResource" - }, - { - "target": "com.amazonaws.ecs#ListTaskDefinitionFamilies" - }, - { - "target": "com.amazonaws.ecs#ListTaskDefinitions" - }, - { - "target": "com.amazonaws.ecs#ListTasks" - }, - { - "target": "com.amazonaws.ecs#PutAccountSetting" - }, - { - "target": "com.amazonaws.ecs#PutAccountSettingDefault" - }, - { - "target": "com.amazonaws.ecs#PutAttributes" - }, - { - "target": "com.amazonaws.ecs#PutClusterCapacityProviders" - }, - { - "target": "com.amazonaws.ecs#RegisterContainerInstance" - }, - { - "target": "com.amazonaws.ecs#RegisterTaskDefinition" - }, - { - "target": "com.amazonaws.ecs#RunTask" - }, - { - "target": "com.amazonaws.ecs#StartTask" - }, - { - "target": "com.amazonaws.ecs#StopTask" - }, - { - "target": "com.amazonaws.ecs#SubmitAttachmentStateChanges" - }, - { - "target": "com.amazonaws.ecs#SubmitContainerStateChange" - }, - { - "target": "com.amazonaws.ecs#SubmitTaskStateChange" - }, - { - "target": "com.amazonaws.ecs#TagResource" - }, - { - "target": "com.amazonaws.ecs#UntagResource" - }, - { - "target": "com.amazonaws.ecs#UpdateCapacityProvider" - }, - { - "target": "com.amazonaws.ecs#UpdateCluster" - }, - { - "target": "com.amazonaws.ecs#UpdateClusterSettings" - }, - { - "target": "com.amazonaws.ecs#UpdateContainerAgent" - }, - { - "target": "com.amazonaws.ecs#UpdateContainerInstancesState" - }, - { - "target": "com.amazonaws.ecs#UpdateService" - }, - { - "target": "com.amazonaws.ecs#UpdateServicePrimaryTaskSet" - }, - { - "target": "com.amazonaws.ecs#UpdateTaskProtection" + "shapes": { + "com.amazonaws.ecs#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "You don't have authorization to perform the requested action.
", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.ecs#UpdateTaskSet" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "ECS", - "arnNamespace": "ecs", - "cloudFormationName": "ECS", - "cloudTrailEventSource": "ecs.amazonaws.com", - "endpointPrefix": "ecs" - }, - "aws.auth#sigv4": { - "name": "ecs" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes\n\t\t\tit easy to run, stop, and manage Docker containers. You can host your cluster on a\n\t\t\tserverless infrastructure that's managed by Amazon ECS by launching your services or tasks on\n\t\t\tFargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)\n\t\t\tor External (on-premises) instances that you manage.
\nAmazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls. This makes it easy to get the state of your cluster from a centralized service,\n\t\t\tand gives you access to many familiar Amazon EC2 features.
\nYou can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. With Amazon ECS, you\n\t\t\tdon't need to operate your own cluster management and configuration management systems.\n\t\t\tYou also don't need to worry about scaling your management infrastructure.
", - "smithy.api#title": "Amazon EC2 Container Service", - "smithy.api#xmlNamespace": { - "uri": "http://ecs.amazonaws.com/doc/2014-11-13/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "com.amazonaws.ecs#AgentUpdateStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "STAGING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STAGING" + } + }, + "STAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STAGED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] } - ], - "rules": [ + } + }, + "com.amazonaws.ecs#AmazonEC2ContainerServiceV20141113": { + "type": "service", + "version": "2014-11-13", + "operations": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.ecs#CreateCapacityProvider" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.ecs#CreateCluster" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ + "target": "com.amazonaws.ecs#CreateService" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.ecs#CreateTaskSet" + }, { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "target": "com.amazonaws.ecs#DeleteAccountSetting" + }, + { + "target": "com.amazonaws.ecs#DeleteAttributes" + }, + { + "target": "com.amazonaws.ecs#DeleteCapacityProvider" + }, + { + "target": "com.amazonaws.ecs#DeleteCluster" + }, + { + "target": "com.amazonaws.ecs#DeleteService" + }, + { + "target": "com.amazonaws.ecs#DeleteTaskDefinitions" + }, + { + "target": "com.amazonaws.ecs#DeleteTaskSet" + }, + { + "target": "com.amazonaws.ecs#DeregisterContainerInstance" + }, + { + "target": "com.amazonaws.ecs#DeregisterTaskDefinition" + }, + { + "target": "com.amazonaws.ecs#DescribeCapacityProviders" + }, + { + "target": "com.amazonaws.ecs#DescribeClusters" + }, + { + "target": "com.amazonaws.ecs#DescribeContainerInstances" + }, + { + "target": "com.amazonaws.ecs#DescribeServiceDeployments" + }, + { + "target": "com.amazonaws.ecs#DescribeServiceRevisions" + }, + { + "target": "com.amazonaws.ecs#DescribeServices" + }, + { + "target": "com.amazonaws.ecs#DescribeTaskDefinition" + }, + { + "target": "com.amazonaws.ecs#DescribeTasks" + }, + { + "target": "com.amazonaws.ecs#DescribeTaskSets" + }, + { + "target": "com.amazonaws.ecs#DiscoverPollEndpoint" + }, + { + "target": "com.amazonaws.ecs#ExecuteCommand" + }, + { + "target": "com.amazonaws.ecs#GetTaskProtection" + }, + { + "target": "com.amazonaws.ecs#ListAccountSettings" + }, + { + "target": "com.amazonaws.ecs#ListAttributes" + }, + { + "target": "com.amazonaws.ecs#ListClusters" + }, + { + "target": "com.amazonaws.ecs#ListContainerInstances" + }, + { + "target": "com.amazonaws.ecs#ListServiceDeployments" + }, + { + "target": "com.amazonaws.ecs#ListServices" + }, + { + "target": "com.amazonaws.ecs#ListServicesByNamespace" + }, + { + "target": "com.amazonaws.ecs#ListTagsForResource" + }, + { + "target": "com.amazonaws.ecs#ListTaskDefinitionFamilies" + }, + { + "target": "com.amazonaws.ecs#ListTaskDefinitions" + }, + { + "target": "com.amazonaws.ecs#ListTasks" + }, + { + "target": "com.amazonaws.ecs#PutAccountSetting" + }, + { + "target": "com.amazonaws.ecs#PutAccountSettingDefault" + }, + { + "target": "com.amazonaws.ecs#PutAttributes" + }, + { + "target": "com.amazonaws.ecs#PutClusterCapacityProviders" + }, + { + "target": "com.amazonaws.ecs#RegisterContainerInstance" + }, + { + "target": "com.amazonaws.ecs#RegisterTaskDefinition" + }, + { + "target": "com.amazonaws.ecs#RunTask" + }, + { + "target": "com.amazonaws.ecs#StartTask" + }, + { + "target": "com.amazonaws.ecs#StopTask" + }, + { + "target": "com.amazonaws.ecs#SubmitAttachmentStateChanges" + }, + { + "target": "com.amazonaws.ecs#SubmitContainerStateChange" + }, + { + "target": "com.amazonaws.ecs#SubmitTaskStateChange" + }, + { + "target": "com.amazonaws.ecs#TagResource" + }, + { + "target": "com.amazonaws.ecs#UntagResource" + }, + { + "target": "com.amazonaws.ecs#UpdateCapacityProvider" + }, + { + "target": "com.amazonaws.ecs#UpdateCluster" + }, + { + "target": "com.amazonaws.ecs#UpdateClusterSettings" + }, + { + "target": "com.amazonaws.ecs#UpdateContainerAgent" + }, + { + "target": "com.amazonaws.ecs#UpdateContainerInstancesState" + }, + { + "target": "com.amazonaws.ecs#UpdateService" + }, + { + "target": "com.amazonaws.ecs#UpdateServicePrimaryTaskSet" + }, + { + "target": "com.amazonaws.ecs#UpdateTaskProtection" + }, + { + "target": "com.amazonaws.ecs#UpdateTaskSet" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "ECS", + "arnNamespace": "ecs", + "cloudFormationName": "ECS", + "cloudTrailEventSource": "ecs.amazonaws.com", + "endpointPrefix": "ecs" + }, + "aws.auth#sigv4": { + "name": "ecs" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes\n\t\t\tit easy to run, stop, and manage Docker containers. You can host your cluster on a\n\t\t\tserverless infrastructure that's managed by Amazon ECS by launching your services or tasks on\n\t\t\tFargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)\n\t\t\tor External (on-premises) instances that you manage.
\nAmazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls. This makes it easy to get the state of your cluster from a centralized service,\n\t\t\tand gives you access to many familiar Amazon EC2 features.
\nYou can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. With Amazon ECS, you\n\t\t\tdon't need to operate your own cluster management and configuration management systems.\n\t\t\tYou also don't need to worry about scaling your management infrastructure.
", + "smithy.api#title": "Amazon EC2 Container Service", + "smithy.api#xmlNamespace": { + "uri": "http://ecs.amazonaws.com/doc/2014-11-13/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "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": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + ], + "rules": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "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": {} }, - "supportsDualStack" - ] + "type": "endpoint" } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ecs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + ], + "type": "tree" + }, + { + "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": [], + "endpoint": { + "url": "https://ecs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ecs-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "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": [], + "endpoint": { + "url": "https://ecs.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://ecs.{Region}.{PartitionResult#dnsSuffix}", + "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" + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - ], - "type": "tree" - }, - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecs.af-south-1.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecs.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ecs-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecs.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecs.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecs.ap-northeast-3.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecs.ap-south-1.amazonaws.com" } - ] + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ecs.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecs.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://ecs.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ecs-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ecs-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://ecs-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://ecs.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ecs-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 disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-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://ecs-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-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ecs.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-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://ecs-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 custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.ecs#ApplicationProtocol": { - "type": "enum", - "members": { - "HTTP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "http" - } - }, - "HTTP2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "http2" - } - }, - "GRPC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "grpc" - } - } - } - }, - "com.amazonaws.ecs#AssignPublicIp": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.ecs#Attachment": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The unique identifier for the attachment.
" - } - }, - "type": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The type of the attachment, such as ElasticNetworkInterface,\n\t\t\t\tService Connect, and AmazonElasticBlockStorage.
The status of the attachment. Valid values are PRECREATED,\n\t\t\t\tCREATED, ATTACHING, ATTACHED,\n\t\t\t\tDETACHING, DETACHED, DELETED, and\n\t\t\t\tFAILED.
Details of the attachment.
\nFor elastic network interfaces, this includes the network interface ID, the MAC\n\t\t\taddress, the subnet ID, and the private IPv4 address.
\nFor Service Connect services, this includes portName,\n\t\t\t\tclientAliases, discoveryName, and\n\t\t\t\tingressPortOverride.
For Elastic Block Storage, this includes roleArn,\n\t\t\t\tdeleteOnTermination, volumeName, volumeId,\n\t\t\tand statusReason (only when the attachment fails to create or\n\t\t\tattach).
An object representing a container instance or task attachment.
" - } - }, - "com.amazonaws.ecs#AttachmentDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#KeyValuePair" - } - }, - "com.amazonaws.ecs#AttachmentStateChange": { - "type": "structure", - "members": { - "attachmentArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the attachment.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the attachment.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing a change in state for a task attachment.
" - } - }, - "com.amazonaws.ecs#AttachmentStateChanges": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#AttachmentStateChange" - } - }, - "com.amazonaws.ecs#Attachments": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Attachment" - } - }, - "com.amazonaws.ecs#Attribute": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the attribute. The name must contain between 1 and 128\n\t\t\tcharacters. The name may contain letters (uppercase and lowercase), numbers, hyphens\n\t\t\t(-), underscores (_), forward slashes (/), back slashes (\\), or periods (.).
The value of the attribute. The value must contain between 1 and 128\n\t\t\tcharacters. It can contain letters (uppercase and lowercase), numbers, hyphens (-),\n\t\t\tunderscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\\),\n\t\t\tcolons (:), or spaces. The value can't start or end with a space.
The type of the target to attach the attribute with. This parameter is required if you\n\t\t\tuse the short form ID for a resource instead of the full ARN.
" - } - }, - "targetId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID of the target. You can specify the short form ID for a resource or the full\n\t\t\tAmazon Resource Name (ARN).
" - } - } - }, - "traits": { - "smithy.api#documentation": "An attribute is a name-value pair that's associated with an Amazon ECS object. Use\n\t\t\tattributes to extend the Amazon ECS data model by adding custom metadata to your resources.\n\t\t\tFor more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#AttributeLimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "You can apply up to 10 custom attributes for each resource. You can view the\n\t\t\tattributes of a resource with ListAttributes.\n\t\t\tYou can remove existing attributes on a resource with DeleteAttributes.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#Attributes": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Attribute" - } - }, - "com.amazonaws.ecs#AutoScalingGroupProvider": { - "type": "structure", - "members": { - "autoScalingGroupArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group\n\t\t\tname.
", - "smithy.api#required": {} - } - }, - "managedScaling": { - "target": "com.amazonaws.ecs#ManagedScaling", - "traits": { - "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
" - } - }, - "managedTerminationProtection": { - "target": "com.amazonaws.ecs#ManagedTerminationProtection", - "traits": { - "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is off.
\nWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an\n\t\t\tAuto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from\n\t\t\ttermination when the Auto Scaling group scales in.
" - } - }, - "managedDraining": { - "target": "com.amazonaws.ecs#ManagedDraining", - "traits": { - "smithy.api#documentation": "The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details of the Auto Scaling group for the capacity provider.
" - } - }, - "com.amazonaws.ecs#AutoScalingGroupProviderUpdate": { - "type": "structure", - "members": { - "managedScaling": { - "target": "com.amazonaws.ecs#ManagedScaling", - "traits": { - "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
" - } - }, - "managedTerminationProtection": { - "target": "com.amazonaws.ecs#ManagedTerminationProtection", - "traits": { - "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.
\nWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an\n\t\t\tAuto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions on. For more information, see Instance Protection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from\n\t\t\ttermination when the Auto Scaling group scales in.
" - } - }, - "managedDraining": { - "target": "com.amazonaws.ecs#ManagedDraining", - "traits": { - "smithy.api#documentation": "The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details of the Auto Scaling group capacity provider to update.
" - } - }, - "com.amazonaws.ecs#AvailabilityZoneRebalancing": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.ecs#AwsVpcConfiguration": { - "type": "structure", - "members": { - "subnets": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The IDs of the subnets associated with the task or service. There's a limit of 16\n\t\t\tsubnets that can be specified.
\nAll specified subnets must be from the same VPC.
\nThe IDs of the security groups associated with the task or service. If you don't\n\t\t\tspecify a security group, the default security group for the VPC is used. There's a\n\t\t\tlimit of 5 security groups that can be specified.
\nAll specified security groups must be from the same VPC.
\nWhether the task's elastic network interface receives a public IP address. The default\n\t\t\tvalue is ENABLED.
An object representing the networking details for a task or service. For example\n\t\t\t\tawsVpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}.
Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Your Amazon Web Services account was blocked. For more information, contact \n\t\t\t\tAmazon Web Services Support.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.ecs#BoxedBoolean": { - "type": "boolean" - }, - "com.amazonaws.ecs#BoxedInteger": { - "type": "integer" - }, - "com.amazonaws.ecs#CPUArchitecture": { - "type": "enum", - "members": { - "X86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "X86_64" - } - }, - "ARM64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARM64" - } - } - } - }, - "com.amazonaws.ecs#CapacityProvider": { - "type": "structure", - "members": { - "capacityProviderArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the capacity provider.
" - } - }, - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the capacity provider.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#CapacityProviderStatus", - "traits": { - "smithy.api#documentation": "The current status of the capacity provider. Only capacity providers in an\n\t\t\t\tACTIVE state can be used in a cluster. When a capacity provider is\n\t\t\tsuccessfully deleted, it has an INACTIVE status.
The Auto Scaling group settings for the capacity provider.
" - } - }, - "updateStatus": { - "target": "com.amazonaws.ecs#CapacityProviderUpdateStatus", - "traits": { - "smithy.api#documentation": "The update status of the capacity provider. The following are the possible states that\n\t\t\tis returned.
\nThe capacity provider is in the process of being deleted.
\nThe capacity provider was successfully deleted and has an\n\t\t\t\t\t\t\tINACTIVE status.
The capacity provider can't be deleted. The update status reason provides\n\t\t\t\t\t\tfurther details about why the delete failed.
\nThe update status reason. This provides further details about the update status for\n\t\t\tthe capacity provider.
" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The details for a capacity provider.
" - } - }, - "com.amazonaws.ecs#CapacityProviderField": { - "type": "enum", - "members": { - "TAGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TAGS" - } - } - } - }, - "com.amazonaws.ecs#CapacityProviderFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#CapacityProviderField" - } - }, - "com.amazonaws.ecs#CapacityProviderStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - } - } - }, - "com.amazonaws.ecs#CapacityProviderStrategy": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#CapacityProviderStrategyItem" - } - }, - "com.amazonaws.ecs#CapacityProviderStrategyItem": { - "type": "structure", - "members": { - "capacityProvider": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name of the capacity provider.
", - "smithy.api#required": {} - } - }, - "weight": { - "target": "com.amazonaws.ecs#CapacityProviderStrategyItemWeight", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\t\tweight value is taken into consideration after the base\n\t\t\tvalue, if defined, is satisfied.
If no weight value is specified, the default value of 0 is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0 can't be used to place\n\t\t\ttasks. If you specify multiple capacity providers in a strategy that all have a weight\n\t\t\tof 0, any RunTask or CreateService actions using\n\t\t\tthe capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of 1, then when the\n\t\t\t\tbase is satisfied, the tasks will be split evenly across the two\n\t\t\tcapacity providers. Using that same logic, if you specify a weight of 1 for\n\t\t\t\tcapacityProviderA and a weight of 4 for\n\t\t\t\tcapacityProviderB, then for every one task that's run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.
The base value designates how many tasks, at a minimum, to run on\n\t\t\tthe specified capacity provider. Only one capacity provider in a capacity provider\n\t\t\tstrategy can have a base defined. If no value is specified, the\n\t\t\tdefault value of 0 is used.
The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTaskor CreateCluster APIs or as the default capacity provider strategy for a\n\t\t\tcluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider\n\t\t\twith a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateClusterCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate\n\t\t\tthat's discounted compared to the FARGATE price. FARGATE_SPOT\n\t\t\truns tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are\n\t\t\tinterrupted with a two-minute warning. FARGATE_SPOT supports Linux tasks\n\t\t\twith the X86_64 architecture on platform version 1.3.0 or later.\n\t\t\t\tFARGATE_SPOT supports Linux tasks with the ARM64 architecture on\n\t\t\tplatform version 1.4.0 or later.
A capacity provider strategy can contain a maximum of 20 capacity providers.
" - } - }, - "com.amazonaws.ecs#CapacityProviderStrategyItemBase": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100000 - } - } - }, - "com.amazonaws.ecs#CapacityProviderStrategyItemWeight": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.ecs#CapacityProviderUpdateStatus": { - "type": "enum", - "members": { - "DELETE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_IN_PROGRESS" - } - }, - "DELETE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_COMPLETE" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - }, - "UPDATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_COMPLETE" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - } - } - }, - "com.amazonaws.ecs#CapacityProviders": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#CapacityProvider" - } - }, - "com.amazonaws.ecs#ClientException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "These errors are usually caused by a client action. This client action might be using\n\t\t\tan action or resource on behalf of a user that doesn't have permissions to use the\n\t\t\taction or resource. Or, it might be specifying an identifier that isn't valid.
\nThe following list includes additional causes for the error:
\nThe RunTask could not be processed because you use managed\n\t\t\t\t\tscaling and there is a capacity error because the quota of tasks in the\n\t\t\t\t\t\tPROVISIONING per cluster has been reached. For information\n\t\t\t\t\tabout the service quotas, see Amazon ECS\n\t\t\t\t\t\tservice quotas.
The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN\n\t\t\tformat, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" - } - }, - "clusterName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "A user-generated string that you use to identify your cluster.
" - } - }, - "configuration": { - "target": "com.amazonaws.ecs#ClusterConfiguration", - "traits": { - "smithy.api#documentation": "The execute command configuration for the cluster.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the cluster. The following are the possible states that are\n\t\t\treturned.
\nThe cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.
\nThe cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being created.
\nThe cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being deleted.
\nThe cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider have failed to create.
\nThe cluster has been deleted. Clusters with an INACTIVE\n\t\t\t\t\t\tstatus may remain discoverable in your account for a period of time.\n\t\t\t\t\t\tHowever, this behavior is subject to change in the future. We don't\n\t\t\t\t\t\trecommend that you rely on INACTIVE clusters persisting.
The number of container instances registered into the cluster. This includes container\n\t\t\tinstances in both ACTIVE and DRAINING status.
The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The number of services that are running on the cluster in an ACTIVE\n\t\t\tstate. You can view these services with PListServices.
Additional information about your clusters that are separated by launch type. They\n\t\t\tinclude the following:
\nrunningEC2TasksCount
\nRunningFargateTasksCount
\npendingEC2TasksCount
\npendingFargateTasksCount
\nactiveEC2ServiceCount
\nactiveFargateServiceCount
\ndrainingEC2ServiceCount
\ndrainingFargateServiceCount
\nThe metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights\n\t\t\tis on or off for a cluster.
" - } - }, - "capacityProviders": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The capacity providers associated with the cluster.
" - } - }, - "defaultCapacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", - "traits": { - "smithy.api#documentation": "The default capacity provider strategy for the cluster. When services or tasks are run\n\t\t\tin the cluster with no launch type or capacity provider strategy specified, the default\n\t\t\tcapacity provider strategy is used.
" - } - }, - "attachments": { - "target": "com.amazonaws.ecs#Attachments", - "traits": { - "smithy.api#documentation": "The resources attached to a cluster. When using a capacity provider with a cluster,\n\t\t\tthe capacity provider and associated resources are returned as cluster\n\t\t\tattachments.
" - } - }, - "attachmentsStatus": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that are returned.
\nThe available capacity providers for the cluster are updating.
\nThe capacity providers have successfully updated.
\nThe capacity provider updates failed.
\nUse this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A regional grouping of one or more container instances where you can run task\n\t\t\trequests. Each account receives a default cluster the first time you use the Amazon ECS\n\t\t\tservice, but you may also create other clusters. Clusters may contain more than one\n\t\t\tinstance type simultaneously.
" - } - }, - "com.amazonaws.ecs#ClusterConfiguration": { - "type": "structure", - "members": { - "executeCommandConfiguration": { - "target": "com.amazonaws.ecs#ExecuteCommandConfiguration", - "traits": { - "smithy.api#documentation": "The details of the execute command configuration.
" - } - }, - "managedStorageConfiguration": { - "target": "com.amazonaws.ecs#ManagedStorageConfiguration", - "traits": { - "smithy.api#documentation": "The details of the managed storage configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The execute command and managed storage configuration for the cluster.
" - } - }, - "com.amazonaws.ecs#ClusterContainsContainerInstancesException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "You can't delete a cluster that has registered container instances. First, deregister\n\t\t\tthe container instances before you can delete the cluster. For more information, see\n\t\t\t\tDeregisterContainerInstance.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#ClusterContainsServicesException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "You can't delete a cluster that contains services. First, update the service to reduce\n\t\t\tits desired task count to 0, and then delete the service. For more information, see\n\t\t\t\tUpdateService and\n\t\t\t\tDeleteService.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#ClusterContainsTasksException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "You can't delete a cluster that has active tasks.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#ClusterField": { - "type": "enum", - "members": { - "ATTACHMENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ATTACHMENTS" - } - }, - "CONFIGURATIONS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFIGURATIONS" - } - }, - "SETTINGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SETTINGS" - } - }, - "STATISTICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATISTICS" - } - }, - "TAGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TAGS" - } - } - } - }, - "com.amazonaws.ecs#ClusterFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ClusterField" - } - }, - "com.amazonaws.ecs#ClusterNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#ClusterServiceConnectDefaults": { - "type": "structure", - "members": { - "namespace": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a\n\t\t\tService Connect configuration, this namespace is used.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#ClusterServiceConnectDefaultsRequest": { - "type": "structure", - "members": { - "namespace": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify\n\t\t\ta Service Connect configuration. The namespace name can include up to 1024 characters.\n\t\t\tThe name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than\n\t\t\t(>), less than (<), or slash (/).
\nIf you enter an existing namespace name or ARN, then that namespace will be used.\n\t\t\tAny namespace type is supported. The namespace must be in this account and this Amazon Web Services\n\t\t\tRegion.
\nIf you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a\n\t\t\tCloud Map namespace with the \"API calls\" method of instance discovery only. This instance\n\t\t\tdiscovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance\n\t\t\tdiscovery aren't used by Service Connect.
\nIf you update the cluster with an empty string \"\" for the namespace name,\n\t\t\tthe cluster configuration for Service Connect is removed. Note that the namespace will\n\t\t\tremain in Cloud Map and must be deleted separately.
For more information about Cloud Map, see Working with Services\n\t\t\tin the Cloud Map Developer Guide.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#ClusterSetting": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#ClusterSettingName", - "traits": { - "smithy.api#documentation": "The name of the cluster setting. The value is containerInsights .
The value to set for the cluster setting. The supported values are\n\t\t\t\tenhanced, enabled, and disabled.
To use Container Insights with enhanced observability, set the\n\t\t\t\tcontainerInsights account setting to enhanced.
To use Container Insights, set the containerInsights account setting to\n\t\t\t\tenabled.
If a cluster value is specified, it will override the containerInsights\n\t\t\tvalue set with PutAccountSetting or PutAccountSettingDefault.
The settings to use when creating a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights with enhanced observability or CloudWatch Container Insights for a\n\t\t\tcluster.
\nContainer Insights with enhanced observability provides all the Container Insights\n\t\t\tmetrics, plus additional task and container metrics. This version supports enhanced\n\t\t\tobservability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you\n\t\t\tconfigure Container Insights with enhanced observability on Amazon ECS, Container Insights\n\t\t\tauto-collects detailed infrastructure telemetry from the cluster level down to the\n\t\t\tcontainer level in your environment and displays these critical performance data in\n\t\t\tcurated dashboards removing the heavy lifting in observability set-up.
\nFor more information, see Monitor\n\t\t\t\tAmazon ECS containers using Container Insights with enhanced observability in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#ClusterSettingName": { - "type": "enum", - "members": { - "CONTAINER_INSIGHTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "containerInsights" - } - } - } - }, - "com.amazonaws.ecs#ClusterSettings": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ClusterSetting" - } - }, - "com.amazonaws.ecs#Clusters": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Cluster" - } - }, - "com.amazonaws.ecs#Compatibility": { - "type": "enum", - "members": { - "EC2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2" - } - }, - "FARGATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FARGATE" - } - }, - "EXTERNAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXTERNAL" - } - } - } - }, - "com.amazonaws.ecs#CompatibilityList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Compatibility" - } - }, - "com.amazonaws.ecs#ConflictException": { - "type": "structure", - "members": { - "resourceIds": { - "target": "com.amazonaws.ecs#ResourceIds", - "traits": { - "smithy.api#documentation": "The existing task ARNs which are already associated with the\n\t\t\t\tclientToken.
Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The RunTask request could not be processed due to conflicts. The provided\n\t\t\t\tclientToken is already in use with a different RunTask\n\t\t\trequest. The resourceIds are the existing task ARNs which are already\n\t\t\tassociated with the clientToken.
To fix this issue:
\nRun RunTask with a unique clientToken.
Run RunTask with the clientToken and the original\n\t\t\t\t\tset of parameters
The Amazon Resource Name (ARN) of the container.
" - } - }, - "taskArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the task.
" - } - }, - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the container.
" - } - }, - "image": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The image used for the container.
" - } - }, - "imageDigest": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The container image manifest digest.
" - } - }, - "runtimeId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID of the Docker container.
" - } - }, - "lastStatus": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The last known status of the container.
" - } - }, - "exitCode": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The exit code returned from the container.
" - } - }, - "reason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details about\n\t\t\ta running or stopped container.
" - } - }, - "networkBindings": { - "target": "com.amazonaws.ecs#NetworkBindings", - "traits": { - "smithy.api#documentation": "The network bindings associated with the container.
" - } - }, - "networkInterfaces": { - "target": "com.amazonaws.ecs#NetworkInterfaces", - "traits": { - "smithy.api#documentation": "The network interfaces associated with the container.
" - } - }, - "healthStatus": { - "target": "com.amazonaws.ecs#HealthStatus", - "traits": { - "smithy.api#documentation": "The health status of the container. If health checks aren't configured for this\n\t\t\tcontainer in its task definition, then it reports the health status as\n\t\t\t\tUNKNOWN.
The details of any Amazon ECS managed agents associated with the container.
" - } - }, - "cpu": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The number of CPU units set for the container. The value is 0 if no value\n\t\t\twas specified in the container definition when the task definition was\n\t\t\tregistered.
The hard limit (in MiB) of memory set for the container.
" - } - }, - "memoryReservation": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The soft limit (in MiB) of memory set for the container.
" - } - }, - "gpuIds": { - "target": "com.amazonaws.ecs#GpuIds", - "traits": { - "smithy.api#documentation": "The IDs of each GPU assigned to the container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A Docker container that's part of a task.
" - } - }, - "com.amazonaws.ecs#ContainerCondition": { - "type": "enum", - "members": { - "START": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "START" - } - }, - "COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETE" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "HEALTHY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HEALTHY" - } - } - } - }, - "com.amazonaws.ecs#ContainerDefinition": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of a container. If you're linking multiple containers together in a task\n\t\t\tdefinition, the name of one container can be entered in the\n\t\t\t\tlinks of another container to connect the containers.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the docker container\n\t\t\tcreate command and the --name option to docker run.
The image used to start a container. This string is passed directly to the Docker\n\t\t\tdaemon. By default, images in the Docker Hub registry are available. Other repositories\n\t\t\tare specified with either \n repository-url/image:tag\n or \n repository-url/image@digest\n . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the docker\n\t\t\tcontainer create command and the IMAGE parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of\n\t\t\t\t\tthe specified image and tag for the container to use. However, subsequent\n\t\t\t\t\tupdates to a repository image aren't propagated to already running tasks.
\nImages in Amazon ECR repositories can be specified by either using the full\n\t\t\t\t\t\tregistry/repository:tag or\n\t\t\t\t\t\tregistry/repository@digest. For example,\n\t\t\t\t\t\t012345678910.dkr.ecr.\n\t\t\t\t\tor\n\t\t\t\t\t\t012345678910.dkr.ecr..\n\t\t\t\t
Images in official repositories on Docker Hub use a single name (for example,\n\t\t\t\t\t\tubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization\n\t\t\t\t\tname (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name\n\t\t\t\t\t(for example, quay.io/assemblyline/ubuntu).
The private repository authentication credentials to use.
" - } - }, - "cpu": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of cpu units reserved for the container. This parameter maps\n\t\t\tto CpuShares in the docker container create commandand the\n\t\t\t\t--cpu-shares option to docker run.
This field is optional for tasks using the Fargate launch type, and the\n\t\t\tonly requirement is that the total amount of CPU reserved for all containers within a\n\t\t\ttask be lower than the task-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type\n\t\t\t\tby multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n\t\t\t\tby 1,024.
\nLinux containers share unallocated CPU units with other containers on the container\n\t\t\tinstance with the same ratio as their allocated amount. For example, if you run a\n\t\t\tsingle-container task on a single-core instance type with 512 CPU units specified for\n\t\t\tthat container, and that's the only task running on the container instance, that\n\t\t\tcontainer could use the full 1,024 CPU unit share at any given time. However, if you\n\t\t\tlaunched another copy of the same task on that container instance, each task is\n\t\t\tguaranteed a minimum of 512 CPU units when needed. Moreover, each container could float\n\t\t\tto higher CPU usage if the other container was not using it. If both tasks were 100%\n\t\t\tactive all of the time, they would be limited to 512 CPU units.
\nOn Linux container instances, the Docker daemon on the container instance uses the CPU\n\t\t\tvalue to calculate the relative CPU share ratios for running containers. The minimum\n\t\t\tvalid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share\n\t\t\tvalue that the Linux kernel allows is 262144. However, the CPU parameter isn't required,\n\t\t\tand you can use CPU values below 2 or above 262144 in your container definitions. For\n\t\t\tCPU values below 2 (including null) or above 262144, the behavior varies based on your\n\t\t\tAmazon ECS container agent version:
\n\n Agent versions less than or equal to 1.1.0:\n\t\t\t\t\tNull and zero CPU values are passed to Docker as 0, which Docker then converts\n\t\t\t\t\tto 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux\n\t\t\t\t\tkernel converts to two CPU shares.
\n\n Agent versions greater than or equal to 1.2.0:\n\t\t\t\t\tNull, zero, and CPU values of 1 are passed to Docker as 2.
\n\n Agent versions greater than or equal to\n\t\t\t\t\t\t1.84.0: CPU values greater than 256 vCPU are passed to Docker as\n\t\t\t\t\t256, which is equivalent to 262144 CPU shares.
\nOn Windows container instances, the CPU limit is enforced as an absolute limit, or a\n\t\t\tquota. Windows containers only have access to the specified amount of CPU that's\n\t\t\tdescribed in the task definition. A null or zero CPU value is passed to Docker as\n\t\t\t\t0, which Windows interprets as 1% of one CPU.
The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the docker container create command and the\n\t\t\t\t--memory option to docker run.
If using the Fargate launch type, this parameter is optional.
\nIf using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.
\nThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.
" - } - }, - "memoryReservation": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container. When system memory is\n\t\t\tunder heavy contention, Docker attempts to keep the container memory to this soft limit.\n\t\t\tHowever, your container can consume more memory when it needs to, up to either the hard\n\t\t\tlimit specified with the memory parameter (if applicable), or all of the\n\t\t\tavailable memory on the container instance, whichever comes first. This parameter maps\n\t\t\tto MemoryReservation in the docker container create command and the\n\t\t\t\t--memory-reservation option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for\n\t\t\tone or both of memory or memoryReservation in a container\n\t\t\tdefinition. If you specify both, memory must be greater than\n\t\t\t\tmemoryReservation. If you specify memoryReservation, then\n\t\t\tthat value is subtracted from the available memory resources for the container instance\n\t\t\twhere the container is placed. Otherwise, the value of memory is\n\t\t\tused.
For example, if your container normally uses 128 MiB of memory, but occasionally\n\t\t\tbursts to 256 MiB of memory for short periods of time, you can set a\n\t\t\t\tmemoryReservation of 128 MiB, and a memory hard limit of\n\t\t\t300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n\t\t\tfrom the remaining resources on the container instance, but also allow the container to\n\t\t\tconsume more memory resources when needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.
\nThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.
" - } - }, - "links": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The links parameter allows containers to communicate with each other\n\t\t\twithout the need for port mappings. This parameter is only supported if the network mode\n\t\t\tof a task definition is bridge. The name:internalName\n\t\t\tconstruct is analogous to name:alias in Docker links.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to Links in the docker\n\t\t\tcontainer create command and the --link option to docker run.
This parameter is not supported for Windows containers.
\nContainers that are collocated on a single container instance may be able to\n\t\t\t\tcommunicate with each other without requiring links or host port mappings. Network\n\t\t\t\tisolation is achieved on the container instance using security groups and VPC\n\t\t\t\tsettings.
\nThe list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.
\nFor task definitions that use the awsvpc network mode, only specify the\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must\n\t\t\tbe the same value as the containerPort.
Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There's no loopback for port mappings on Windows, so you\n\t\t\tcan't access a container's mapped port from the host itself.
This parameter maps to PortBindings in the the docker container create\n\t\t\tcommand and the --publish option to docker run. If the network mode of a\n\t\t\ttask definition is set to none, then you can't specify port mappings. If\n\t\t\tthe network mode of a task definition is set to host, then host ports must\n\t\t\teither be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings section DescribeTasks\n\t\t\t\tresponses.
If the essential parameter of a container is marked as true,\n\t\t\tand that container fails or stops for any reason, all other containers that are part of\n\t\t\tthe task are stopped. If the essential parameter of a container is marked\n\t\t\tas false, its failure doesn't affect the rest of the containers in a task.\n\t\t\tIf this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application\n\t\t\tthat's composed of multiple containers, group containers that are used for a common\n\t\t\tpurpose into components, and separate the different components into multiple task\n\t\t\tdefinitions. For more information, see Application\n\t\t\t\tArchitecture in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "restartPolicy": { - "target": "com.amazonaws.ecs#ContainerRestartPolicy", - "traits": { - "smithy.api#documentation": "The restart policy for a container. When you set up a restart policy, Amazon ECS can\n\t\t\trestart the container without needing to replace the task. For more information, see\n\t\t\t\tRestart\n\t\t\t\tindividual containers in Amazon ECS tasks with container restart policies in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" - } - }, - "entryPoint": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "Early versions of the Amazon ECS container agent don't properly handle\n\t\t\t\t\tentryPoint parameters. If you have problems using\n\t\t\t\t\tentryPoint, update your container agent or enter your commands and\n\t\t\t\targuments as command array items instead.
The entry point that's passed to the container. This parameter maps to\n\t\t\t\tEntrypoint in the docker container create command and the\n\t\t\t\t--entrypoint option to docker run.
The command that's passed to the container. This parameter maps to Cmd in\n\t\t\tthe docker container create command and the COMMAND parameter to docker\n\t\t\trun. If there are multiple arguments, each argument is a separated string in the\n\t\t\tarray.
The environment variables to pass to a container. This parameter maps to\n\t\t\t\tEnv in the docker container create command and the --env\n\t\t\toption to docker run.
We don't recommend that you use plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.
\nA list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env\n\t\t\tfile extension. Each line in an environment file contains an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored.
If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.
The mount points for data volumes in your container.
\nThis parameter maps to Volumes in the docker container create command and\n\t\t\tthe --volume option to docker run.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives.
Data volumes to mount from another container. This parameter maps to\n\t\t\t\tVolumesFrom in the docker container create command and the\n\t\t\t\t--volumes-from option to docker run.
Linux-specific modifications that are applied to the container, such as Linux kernel\n\t\t\tcapabilities. For more information see KernelCapabilities.
\nThis parameter is not supported for Windows containers.
\nThe secrets to pass to the container. For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "dependsOn": { - "target": "com.amazonaws.ecs#ContainerDependencies", - "traits": { - "smithy.api#documentation": "The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies on other containers in a task definition. When a dependency is\n\t\t\tdefined for container startup, for container shutdown it is reversed.
\nFor tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to turn on container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it doesn't reach the desired status within that\n\t\t\ttime then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0 of the container agent to use a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init\n\t\t\tpackage. If your container instances are launched from version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
" - } - }, - "stopTimeout": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.
\nFor tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks that use the Fargate launch type, the max stop timeout value is 120\n\t\t\tseconds and if the parameter is not specified, the default value of 30 seconds is\n\t\t\tused.
\nFor tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to use a container stop timeout\n\t\t\tvalue. However, we recommend using the latest container agent version. For information\n\t\t\tabout checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
" - } - }, - "versionConsistency": { - "target": "com.amazonaws.ecs#VersionConsistency", - "traits": { - "smithy.api#documentation": "Specifies whether Amazon ECS will resolve the container image tag provided in the container\n\t\t\tdefinition to an image digest. By default, the value is enabled. If you set\n\t\t\tthe value for a container as disabled, Amazon ECS will not resolve the provided\n\t\t\tcontainer image tag to a digest and will use the original image URI specified in the\n\t\t\tcontainer definition for deployment. For more information about container image\n\t\t\tresolution, see Container image resolution in the Amazon ECS Developer\n\t\t\t\tGuide.
The hostname to use for your container. This parameter maps to Hostname\n\t\t\tin the docker container create command and the --hostname option to docker\n\t\t\trun.
The hostname parameter is not supported if you're using the\n\t\t\t\t\tawsvpc network mode.
The user to use inside the container. This parameter maps to User in the\n\t\t\tdocker container create command and the --user option to docker run.
When running tasks using the host network mode, don't run containers\n\t\t\t\tusing the root user (UID 0). We recommend using a non-root user for better\n\t\t\t\tsecurity.
You can specify the user using the following formats. If specifying a UID\n\t\t\tor GID, you must specify it as a positive integer.
\n user\n
\n user:group\n
\n uid\n
\n uid:gid\n
\n user:gid\n
\n uid:group\n
This parameter is not supported for Windows containers.
\nThe working directory to run commands inside the container in. This parameter maps to\n\t\t\t\tWorkingDir in the docker container create command and the\n\t\t\t\t--workdir option to docker run.
When this parameter is true, networking is off within the container. This parameter\n\t\t\tmaps to NetworkDisabled in the docker container create command.
This parameter is not supported for Windows containers.
\nWhen this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the root user). This parameter maps to\n\t\t\t\tPrivileged in the docker container create command and the\n\t\t\t\t--privileged option to docker run
This parameter is not supported for Windows containers or tasks run on Fargate.
\nWhen this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to ReadonlyRootfs in the docker container\n\t\t\tcreate command and the --read-only option to docker run.
This parameter is not supported for Windows containers.
\nA list of DNS servers that are presented to the container. This parameter maps to\n\t\t\t\tDns in the docker container create command and the --dns\n\t\t\toption to docker run.
This parameter is not supported for Windows containers.
\nA list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto DnsSearch in the docker container create command and the\n\t\t\t\t--dns-search option to docker run.
This parameter is not supported for Windows containers.
\nA list of hostnames and IP address mappings to append to the /etc/hosts\n\t\t\tfile on the container. This parameter maps to ExtraHosts in the docker\n\t\t\tcontainer create command and the --add-host option to docker run.
This parameter isn't supported for Windows containers or tasks that use the\n\t\t\t\t\tawsvpc network mode.
A list of strings to provide custom configuration for multiple security systems. This\n\t\t\tfield isn't valid for containers in tasks using the Fargate launch\n\t\t\ttype.
\nFor Linux tasks on EC2, this parameter can be used to reference custom\n\t\t\tlabels for SELinux and AppArmor multi-level security systems.
\nFor any tasks on EC2, this parameter can be used to reference a\n\t\t\tcredential spec file that configures a container for Active Directory authentication.\n\t\t\tFor more information, see Using gMSAs for Windows\n\t\t\t\tContainers and Using gMSAs for Linux\n\t\t\t\tContainers in the Amazon Elastic Container Service Developer Guide.
\nThis parameter maps to SecurityOpt in the docker container create command\n\t\t\tand the --security-opt option to docker run.
The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true\n\t\t\t\tenvironment variables before containers placed on that instance can use these\n\t\t\t\tsecurity options. For more information, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"
" - } - }, - "interactive": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "When this parameter is true, you can deploy containerized applications\n\t\t\tthat require stdin or a tty to be allocated. This parameter\n\t\t\tmaps to OpenStdin in the docker container create command and the\n\t\t\t\t--interactive option to docker run.
When this parameter is true, a TTY is allocated. This parameter maps to\n\t\t\t\tTty in the docker container create command and the --tty\n\t\t\toption to docker run.
A key/value map of labels to add to the container. This parameter maps to\n\t\t\t\tLabels in the docker container create command and the\n\t\t\t\t--label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
A list of ulimits to set in the container. If a ulimit value\n\t\t\tis specified in a task definition, it overrides the default values set by Docker. This\n\t\t\tparameter maps to Ulimits in the docker container create command and the\n\t\t\t\t--ulimit option to docker run. Valid naming values are displayed in the\n\t\t\t\tUlimit data type.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 65535 and the default hard limit\n\t\t\t\t\t\t\tis 65535.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
This parameter is not supported for Windows containers.
\nThe log configuration specification for the container.
\nThis parameter maps to LogConfig in the docker container create command\n\t\t\tand the --log-driver option to docker run. By default, containers use the\n\t\t\tsame logging driver that the Docker daemon uses. However the container can use a\n\t\t\tdifferent logging driver than the Docker daemon by specifying a log driver with this\n\t\t\tparameter in the container definition. To use a different logging driver for a\n\t\t\tcontainer, the log system must be configured properly on the container instance (or on a\n\t\t\tdifferent log server for remote logging options).
Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the LogConfiguration data type). Additional log drivers may be available in\n\t\t\t\tfuture releases of the Amazon ECS container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The Amazon ECS container agent running on a container instance must register the\n\t\t\t\tlogging drivers available on that instance with the\n\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\tcontainers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
The container health check command and associated configuration parameters for the\n\t\t\tcontainer. This parameter maps to HealthCheck in the docker container\n\t\t\tcreate command and the HEALTHCHECK parameter of docker run.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the docker container create command and the\n\t\t\t\t--sysctl option to docker run. For example, you can configure\n\t\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.
The type and amount of a resource to assign to a container. The only supported\n\t\t\tresource is a GPU.
" - } - }, - "firelensConfiguration": { - "target": "com.amazonaws.ecs#FirelensConfiguration", - "traits": { - "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom Log Routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" - } - }, - "credentialSpecs": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that\n\t\t\tconfigures the container for Active Directory authentication. We recommend that you use\n\t\t\tthis parameter instead of the dockerSecurityOptions. The maximum number of\n\t\t\tARNs is 1.
There are two formats for each ARN.
\nYou use credentialspecdomainless:MyARN to provide a\n\t\t\t\t\t\t\tCredSpec with an additional section for a secret in Secrets Manager.\n\t\t\t\t\t\tYou provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different\n\t\t\t\t\t\tdomains.
\nYou can use this format without joining the container instance to a\n\t\t\t\t\t\tdomain.
\nYou use credentialspec:MyARN to provide a\n\t\t\t\t\t\t\tCredSpec for a single domain.
You must join the container instance to the domain before you start any\n\t\t\t\t\t\ttasks that use this task definition.
\nIn both formats, replace MyARN with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN, the\n\t\t\t\tcredspec must provide a ARN in Secrets Manager for a secret containing the\n\t\t\tusername, password, and the domain to connect to. For better security, the instance\n\t\t\tisn't joined to the domain for domainless authentication. Other applications on the\n\t\t\tinstance can't use the domainless credentials. You can use this parameter to run tasks\n\t\t\ton the same instance, even it the tasks need to join different domains. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers and Using gMSAs for Linux\n\t\t\t\tContainers.
Container definitions are used in task definitions to describe the different\n\t\t\tcontainers that are launched as part of a task.
" - } - }, - "com.amazonaws.ecs#ContainerDefinitions": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ContainerDefinition" - } - }, - "com.amazonaws.ecs#ContainerDependencies": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ContainerDependency" - } - }, - "com.amazonaws.ecs#ContainerDependency": { - "type": "structure", - "members": { - "containerName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of a container.
", - "smithy.api#required": {} - } - }, - "condition": { - "target": "com.amazonaws.ecs#ContainerCondition", - "traits": { - "smithy.api#documentation": "The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:
\n\n START - This condition emulates the behavior of links and\n\t\t\t\t\tvolumes today. It validates that a dependent container is started before\n\t\t\t\t\tpermitting other containers to start.
\n COMPLETE - This condition validates that a dependent\n\t\t\t\t\tcontainer runs to completion (exits) before permitting other containers to\n\t\t\t\t\tstart. This can be useful for nonessential containers that run a script and then\n\t\t\t\t\texit. This condition can't be set on an essential container.
\n SUCCESS - This condition is the same as\n\t\t\t\t\t\tCOMPLETE, but it also requires that the container exits with a\n\t\t\t\t\t\tzero status. This condition can't be set on an essential\n\t\t\t\t\tcontainer.
\n HEALTHY - This condition validates that the dependent\n\t\t\t\t\tcontainer passes its Docker health check before permitting other containers to\n\t\t\t\t\tstart. This requires that the dependent container has health checks configured.\n\t\t\t\t\tThis condition is confirmed only at task startup.
The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto use container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#ContainerImage": { - "type": "structure", - "members": { - "containerName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the container.
" - } - }, - "imageDigest": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The container image digest.
" - } - }, - "image": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The container image.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details about the container image a service revision uses.
\nTo ensure that all tasks in a service use the same container image, Amazon ECS\n\t\t\tresolves container image names and any image tags specified in the task definition to\n\t\t\tcontainer image digests.
\nAfter the container image digest has been established, Amazon ECS uses the digest to\n\t\t\tstart any other desired tasks, and for any future service and service revision updates.\n\t\t\tThis leads to all tasks in a service always running identical container images,\n\t\t\tresulting in version consistency for your software. For more information, see Container image resolution in the Amazon ECS Developer Guide.
" - } - }, - "com.amazonaws.ecs#ContainerImages": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ContainerImage" - } - }, - "com.amazonaws.ecs#ContainerInstance": { - "type": "structure", - "members": { - "containerInstanceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format,\n\t\t\tsee Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" - } - }, - "ec2InstanceId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2\n\t\t\tinstance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
" - } - }, - "capacityProviderName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The capacity provider that's associated with the container instance.
" - } - }, - "version": { - "target": "com.amazonaws.ecs#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The version counter for the container instance. Every time a container instance\n\t\t\texperiences a change that triggers a CloudWatch event, the version counter is\n\t\t\tincremented. If you're replicating your Amazon ECS container instance state with CloudWatch\n\t\t\tEvents, you can compare the version of a container instance reported by the Amazon ECS APIs\n\t\t\twith the version reported in CloudWatch Events for the container instance (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.
The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.
" - } - }, - "remainingResources": { - "target": "com.amazonaws.ecs#Resources", - "traits": { - "smithy.api#documentation": "For CPU and memory resource types, this parameter describes the remaining CPU and\n\t\t\tmemory that wasn't already allocated to tasks and is therefore available for new tasks.\n\t\t\tFor port resource types, this parameter describes the ports that were reserved by the\n\t\t\tAmazon ECS container agent (at instance registration time) and any task containers that have\n\t\t\treserved port mappings on the host (with the host or bridge\n\t\t\tnetwork mode). Any port that's not specified here is available for new tasks.
For CPU and memory resource types, this parameter describes the amount of each\n\t\t\tresource that was available on the container instance when the container agent\n\t\t\tregistered it with Amazon ECS. This value represents the total amount of CPU and memory that\n\t\t\tcan be allocated on this container instance to tasks. For port resource types, this\n\t\t\tparameter describes the ports that were reserved by the Amazon ECS container agent when it\n\t\t\tregistered the container instance with Amazon ECS.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING indicates that new tasks aren't placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container instance draining in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
The reason that the container instance reached its current status.
" - } - }, - "agentConnected": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "This parameter returns true if the agent is connected to Amazon ECS. An\n\t\t\tinstance with an agent that may be unhealthy or stopped return false. Only\n\t\t\tinstances connected to an agent can accept task placement requests.
The number of tasks on the container instance that have a desired status\n\t\t\t\t(desiredStatus) of RUNNING.
The number of tasks on the container instance that are in the PENDING\n\t\t\tstatus.
The status of the most recent agent update. If an update wasn't ever requested, this\n\t\t\tvalue is NULL.
The attributes set for the container instance, either by the Amazon ECS container agent at\n\t\t\tinstance registration or manually with the PutAttributes\n\t\t\toperation.
" - } - }, - "registeredAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the container instance was registered.
" - } - }, - "attachments": { - "target": "com.amazonaws.ecs#Attachments", - "traits": { - "smithy.api#documentation": "The resources attached to a container instance, such as an elastic network\n\t\t\tinterface.
" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
An object representing the health status of the container instance.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered\n\t\t\twith a cluster.
" - } - }, - "com.amazonaws.ecs#ContainerInstanceField": { - "type": "enum", - "members": { - "TAGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TAGS" - } - }, - "CONTAINER_INSTANCE_HEALTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINER_INSTANCE_HEALTH" - } - } - } - }, - "com.amazonaws.ecs#ContainerInstanceFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ContainerInstanceField" - } - }, - "com.amazonaws.ecs#ContainerInstanceHealthStatus": { - "type": "structure", - "members": { - "overallStatus": { - "target": "com.amazonaws.ecs#InstanceHealthCheckState", - "traits": { - "smithy.api#documentation": "The overall health status of the container instance. This is an aggregate status of\n\t\t\tall container instance health checks.
" - } - }, - "details": { - "target": "com.amazonaws.ecs#InstanceHealthCheckResultList", - "traits": { - "smithy.api#documentation": "An array of objects representing the details of the container instance health\n\t\t\tstatus.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the health status of the container instance.
" - } - }, - "com.amazonaws.ecs#ContainerInstanceStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DRAINING" - } - }, - "REGISTERING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REGISTERING" - } - }, - "DEREGISTERING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEREGISTERING" - } - }, - "REGISTRATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REGISTRATION_FAILED" - } - } - } - }, - "com.amazonaws.ecs#ContainerInstances": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ContainerInstance" - } - }, - "com.amazonaws.ecs#ContainerOverride": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the container that receives the override. This parameter is required if\n\t\t\tany override is specified.
" - } - }, - "command": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The command to send to the container that overrides the default command from the\n\t\t\tDocker image or the task definition. You must also specify a container name.
" - } - }, - "environment": { - "target": "com.amazonaws.ecs#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "The environment variables to send to the container. You can add new environment\n\t\t\tvariables, which are added to the container at launch, or you can override the existing\n\t\t\tenvironment variables from the Docker image or the task definition. You must also\n\t\t\tspecify a container name.
" - } - }, - "environmentFiles": { - "target": "com.amazonaws.ecs#EnvironmentFiles", - "traits": { - "smithy.api#documentation": "A list of files containing the environment variables to pass to a container, instead\n\t\t\tof the value from the container definition.
" - } - }, - "cpu": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The number of cpu units reserved for the container, instead of the\n\t\t\tdefault value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default\n\t\t\tvalue from the task definition. If your container attempts to exceed the memory\n\t\t\tspecified here, the container is killed. You must also specify a container name.
" - } - }, - "memoryReservation": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default\n\t\t\tvalue from the task definition. You must also specify a container name.
" - } - }, - "resourceRequirements": { - "target": "com.amazonaws.ecs#ResourceRequirements", - "traits": { - "smithy.api#documentation": "The type and amount of a resource to assign to a container, instead of the default\n\t\t\tvalue from the task definition. The only supported resource is a GPU.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The overrides that are sent to a container. An empty container override can be passed\n\t\t\tin. An example of an empty container override is {\"containerOverrides\": [ ]\n\t\t\t\t}. If a non-empty container override is specified, the name\n\t\t\tparameter must be included.
You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the\n\t\t\tsensitive data. For more information, see Retrieve secrets through\n\t\t\t\tenvironment variables in the Amazon ECS Developer Guide.
" - } - }, - "com.amazonaws.ecs#ContainerOverrides": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ContainerOverride" - } - }, - "com.amazonaws.ecs#ContainerRestartPolicy": { - "type": "structure", - "members": { - "enabled": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Specifies whether a restart policy is enabled for the container.
", - "smithy.api#required": {} - } - }, - "ignoredExitCodes": { - "target": "com.amazonaws.ecs#IntegerList", - "traits": { - "smithy.api#documentation": "A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can\n\t\t\tspecify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit\n\t\t\tcodes.
" - } - }, - "restartAttemptPeriod": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "A period of time (in seconds) that the container must run for before a restart can be\n\t\t\tattempted. A container can be restarted only once every\n\t\t\t\trestartAttemptPeriod seconds. If a container isn't able to run for this\n\t\t\ttime period and exits early, it will not be restarted. You can set a minimum\n\t\t\t\trestartAttemptPeriod of 60 seconds and a maximum\n\t\t\t\trestartAttemptPeriod of 1800 seconds. By default, a container must run\n\t\t\tfor 300 seconds before it can be restarted.
You can enable a restart policy for each container defined in your task definition, to\n\t\t\tovercome transient failures faster and maintain task availability. When you enable a\n\t\t\trestart policy for a container, Amazon ECS can restart the container if it exits, without\n\t\t\tneeding to replace the task. For more information, see Restart\n\t\t\t\tindividual containers in Amazon ECS tasks with container restart policies in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#ContainerStateChange": { - "type": "structure", - "members": { - "containerName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the container.
" - } - }, - "imageDigest": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The container image SHA 256 digest.
" - } - }, - "runtimeId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID of the Docker container.
" - } - }, - "exitCode": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The exit code for the container, if the state change is a result of the container\n\t\t\texiting.
" - } - }, - "networkBindings": { - "target": "com.amazonaws.ecs#NetworkBindings", - "traits": { - "smithy.api#documentation": "Any network bindings that are associated with the container.
" - } - }, - "reason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The reason for the state change.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object that represents a change in state for a container.
" - } - }, - "com.amazonaws.ecs#ContainerStateChanges": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ContainerStateChange" - } - }, - "com.amazonaws.ecs#Containers": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Container" - } - }, - "com.amazonaws.ecs#CreateCapacityProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#CreateCapacityProviderRequest" - }, - "output": { - "target": "com.amazonaws.ecs#CreateCapacityProviderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#LimitExceededException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#UpdateInProgressException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.
\nOnly capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tFargate use the FARGATE and FARGATE_SPOT capacity providers.\n\t\t\tThese providers are available to all accounts in the Amazon Web Services Regions that Fargate\n\t\t\tsupports.
The unique identifier for the attachment.
" + } + }, + "type": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The type of the attachment, such as ElasticNetworkInterface,\n\t\t\t\tService Connect, and AmazonElasticBlockStorage.
The status of the attachment. Valid values are PRECREATED,\n\t\t\t\tCREATED, ATTACHING, ATTACHED,\n\t\t\t\tDETACHING, DETACHED, DELETED, and\n\t\t\t\tFAILED.
Details of the attachment.
\nFor elastic network interfaces, this includes the network interface ID, the MAC\n\t\t\taddress, the subnet ID, and the private IPv4 address.
\nFor Service Connect services, this includes portName,\n\t\t\t\tclientAliases, discoveryName, and\n\t\t\t\tingressPortOverride.
For Elastic Block Storage, this includes roleArn,\n\t\t\t\tdeleteOnTermination, volumeName, volumeId,\n\t\t\tand statusReason (only when the attachment fails to create or\n\t\t\tattach).
An object representing a container instance or task attachment.
" + } + }, + "com.amazonaws.ecs#AttachmentDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#KeyValuePair" + } + }, + "com.amazonaws.ecs#AttachmentStateChange": { + "type": "structure", + "members": { + "attachmentArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the attachment.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the attachment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing a change in state for a task attachment.
" + } + }, + "com.amazonaws.ecs#AttachmentStateChanges": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#AttachmentStateChange" + } + }, + "com.amazonaws.ecs#Attachments": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Attachment" + } + }, + "com.amazonaws.ecs#Attribute": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the attribute. The name must contain between 1 and 128\n\t\t\tcharacters. The name may contain letters (uppercase and lowercase), numbers, hyphens\n\t\t\t(-), underscores (_), forward slashes (/), back slashes (\\), or periods (.).
The value of the attribute. The value must contain between 1 and 128\n\t\t\tcharacters. It can contain letters (uppercase and lowercase), numbers, hyphens (-),\n\t\t\tunderscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\\),\n\t\t\tcolons (:), or spaces. The value can't start or end with a space.
The type of the target to attach the attribute with. This parameter is required if you\n\t\t\tuse the short form ID for a resource instead of the full ARN.
" + } + }, + "targetId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID of the target. You can specify the short form ID for a resource or the full\n\t\t\tAmazon Resource Name (ARN).
" + } + } + }, + "traits": { + "smithy.api#documentation": "An attribute is a name-value pair that's associated with an Amazon ECS object. Use\n\t\t\tattributes to extend the Amazon ECS data model by adding custom metadata to your resources.\n\t\t\tFor more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#AttributeLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "You can apply up to 10 custom attributes for each resource. You can view the\n\t\t\tattributes of a resource with ListAttributes.\n\t\t\tYou can remove existing attributes on a resource with DeleteAttributes.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#Attributes": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Attribute" + } + }, + "com.amazonaws.ecs#AutoScalingGroupProvider": { + "type": "structure", + "members": { + "autoScalingGroupArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group\n\t\t\tname.
", + "smithy.api#required": {} + } + }, + "managedScaling": { + "target": "com.amazonaws.ecs#ManagedScaling", + "traits": { + "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
" + } + }, + "managedTerminationProtection": { + "target": "com.amazonaws.ecs#ManagedTerminationProtection", + "traits": { + "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is off.
\nWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an\n\t\t\tAuto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from\n\t\t\ttermination when the Auto Scaling group scales in.
" + } + }, + "managedDraining": { + "target": "com.amazonaws.ecs#ManagedDraining", + "traits": { + "smithy.api#documentation": "The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the Auto Scaling group for the capacity provider.
" + } + }, + "com.amazonaws.ecs#AutoScalingGroupProviderUpdate": { + "type": "structure", + "members": { + "managedScaling": { + "target": "com.amazonaws.ecs#ManagedScaling", + "traits": { + "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
" + } + }, + "managedTerminationProtection": { + "target": "com.amazonaws.ecs#ManagedTerminationProtection", + "traits": { + "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.
\nWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an\n\t\t\tAuto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions on. For more information, see Instance Protection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from\n\t\t\ttermination when the Auto Scaling group scales in.
" + } + }, + "managedDraining": { + "target": "com.amazonaws.ecs#ManagedDraining", + "traits": { + "smithy.api#documentation": "The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the Auto Scaling group capacity provider to update.
" + } + }, + "com.amazonaws.ecs#AvailabilityZoneRebalancing": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.ecs#AwsVpcConfiguration": { + "type": "structure", + "members": { + "subnets": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The IDs of the subnets associated with the task or service. There's a limit of 16\n\t\t\tsubnets that can be specified.
\nAll specified subnets must be from the same VPC.
\nThe IDs of the security groups associated with the task or service. If you don't\n\t\t\tspecify a security group, the default security group for the VPC is used. There's a\n\t\t\tlimit of 5 security groups that can be specified.
\nAll specified security groups must be from the same VPC.
\nWhether the task's elastic network interface receives a public IP address. The default\n\t\t\tvalue is ENABLED.
An object representing the networking details for a task or service. For example\n\t\t\t\tawsVpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}.
Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Your Amazon Web Services account was blocked. For more information, contact \n\t\t\t\tAmazon Web Services Support.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.ecs#BoxedBoolean": { + "type": "boolean" + }, + "com.amazonaws.ecs#BoxedInteger": { + "type": "integer" + }, + "com.amazonaws.ecs#CPUArchitecture": { + "type": "enum", + "members": { + "X86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X86_64" + } + }, + "ARM64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARM64" + } + } + } + }, + "com.amazonaws.ecs#CapacityProvider": { + "type": "structure", + "members": { + "capacityProviderArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the capacity provider.
" + } + }, + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the capacity provider.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#CapacityProviderStatus", + "traits": { + "smithy.api#documentation": "The current status of the capacity provider. Only capacity providers in an\n\t\t\t\tACTIVE state can be used in a cluster. When a capacity provider is\n\t\t\tsuccessfully deleted, it has an INACTIVE status.
The Auto Scaling group settings for the capacity provider.
" + } + }, + "updateStatus": { + "target": "com.amazonaws.ecs#CapacityProviderUpdateStatus", + "traits": { + "smithy.api#documentation": "The update status of the capacity provider. The following are the possible states that\n\t\t\tis returned.
\nThe capacity provider is in the process of being deleted.
\nThe capacity provider was successfully deleted and has an\n\t\t\t\t\t\t\tINACTIVE status.
The capacity provider can't be deleted. The update status reason provides\n\t\t\t\t\t\tfurther details about why the delete failed.
\nThe update status reason. This provides further details about the update status for\n\t\t\tthe capacity provider.
" + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The details for a capacity provider.
" + } + }, + "com.amazonaws.ecs#CapacityProviderField": { + "type": "enum", + "members": { + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGS" + } + } + } + }, + "com.amazonaws.ecs#CapacityProviderFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#CapacityProviderField" + } + }, + "com.amazonaws.ecs#CapacityProviderStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.ecs#CapacityProviderStrategy": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#CapacityProviderStrategyItem" + } + }, + "com.amazonaws.ecs#CapacityProviderStrategyItem": { + "type": "structure", + "members": { + "capacityProvider": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name of the capacity provider.
", + "smithy.api#required": {} + } + }, + "weight": { + "target": "com.amazonaws.ecs#CapacityProviderStrategyItemWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\t\tweight value is taken into consideration after the base\n\t\t\tvalue, if defined, is satisfied.
If no weight value is specified, the default value of 0 is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0 can't be used to place\n\t\t\ttasks. If you specify multiple capacity providers in a strategy that all have a weight\n\t\t\tof 0, any RunTask or CreateService actions using\n\t\t\tthe capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of 1, then when the\n\t\t\t\tbase is satisfied, the tasks will be split evenly across the two\n\t\t\tcapacity providers. Using that same logic, if you specify a weight of 1 for\n\t\t\t\tcapacityProviderA and a weight of 4 for\n\t\t\t\tcapacityProviderB, then for every one task that's run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.
The base value designates how many tasks, at a minimum, to run on\n\t\t\tthe specified capacity provider. Only one capacity provider in a capacity provider\n\t\t\tstrategy can have a base defined. If no value is specified, the\n\t\t\tdefault value of 0 is used.
The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTaskor CreateCluster APIs or as the default capacity provider strategy for a\n\t\t\tcluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider\n\t\t\twith a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateClusterCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate\n\t\t\tthat's discounted compared to the FARGATE price. FARGATE_SPOT\n\t\t\truns tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are\n\t\t\tinterrupted with a two-minute warning. FARGATE_SPOT supports Linux tasks\n\t\t\twith the X86_64 architecture on platform version 1.3.0 or later.\n\t\t\t\tFARGATE_SPOT supports Linux tasks with the ARM64 architecture on\n\t\t\tplatform version 1.4.0 or later.
A capacity provider strategy can contain a maximum of 20 capacity providers.
" + } + }, + "com.amazonaws.ecs#CapacityProviderStrategyItemBase": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.ecs#CapacityProviderStrategyItemWeight": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.ecs#CapacityProviderUpdateStatus": { + "type": "enum", + "members": { + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_COMPLETE" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_COMPLETE" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.ecs#CapacityProviders": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#CapacityProvider" + } + }, + "com.amazonaws.ecs#ClientException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "These errors are usually caused by a client action. This client action might be using\n\t\t\tan action or resource on behalf of a user that doesn't have permissions to use the\n\t\t\taction or resource. Or, it might be specifying an identifier that isn't valid.
\nThe following list includes additional causes for the error:
\nThe RunTask could not be processed because you use managed\n\t\t\t\t\tscaling and there is a capacity error because the quota of tasks in the\n\t\t\t\t\t\tPROVISIONING per cluster has been reached. For information\n\t\t\t\t\tabout the service quotas, see Amazon ECS\n\t\t\t\t\t\tservice quotas.
The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN\n\t\t\tformat, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" + } + }, + "clusterName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "A user-generated string that you use to identify your cluster.
" + } + }, + "configuration": { + "target": "com.amazonaws.ecs#ClusterConfiguration", + "traits": { + "smithy.api#documentation": "The execute command configuration for the cluster.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the cluster. The following are the possible states that are\n\t\t\treturned.
\nThe cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.
\nThe cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being created.
\nThe cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being deleted.
\nThe cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider have failed to create.
\nThe cluster has been deleted. Clusters with an INACTIVE\n\t\t\t\t\t\tstatus may remain discoverable in your account for a period of time.\n\t\t\t\t\t\tHowever, this behavior is subject to change in the future. We don't\n\t\t\t\t\t\trecommend that you rely on INACTIVE clusters persisting.
The number of container instances registered into the cluster. This includes container\n\t\t\tinstances in both ACTIVE and DRAINING status.
The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The number of services that are running on the cluster in an ACTIVE\n\t\t\tstate. You can view these services with PListServices.
Additional information about your clusters that are separated by launch type. They\n\t\t\tinclude the following:
\nrunningEC2TasksCount
\nRunningFargateTasksCount
\npendingEC2TasksCount
\npendingFargateTasksCount
\nactiveEC2ServiceCount
\nactiveFargateServiceCount
\ndrainingEC2ServiceCount
\ndrainingFargateServiceCount
\nThe metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights\n\t\t\tis on or off for a cluster.
" + } + }, + "capacityProviders": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The capacity providers associated with the cluster.
" + } + }, + "defaultCapacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "The default capacity provider strategy for the cluster. When services or tasks are run\n\t\t\tin the cluster with no launch type or capacity provider strategy specified, the default\n\t\t\tcapacity provider strategy is used.
" + } + }, + "attachments": { + "target": "com.amazonaws.ecs#Attachments", + "traits": { + "smithy.api#documentation": "The resources attached to a cluster. When using a capacity provider with a cluster,\n\t\t\tthe capacity provider and associated resources are returned as cluster\n\t\t\tattachments.
" + } + }, + "attachmentsStatus": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that are returned.
\nThe available capacity providers for the cluster are updating.
\nThe capacity providers have successfully updated.
\nThe capacity provider updates failed.
\nUse this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A regional grouping of one or more container instances where you can run task\n\t\t\trequests. Each account receives a default cluster the first time you use the Amazon ECS\n\t\t\tservice, but you may also create other clusters. Clusters may contain more than one\n\t\t\tinstance type simultaneously.
" + } + }, + "com.amazonaws.ecs#ClusterConfiguration": { + "type": "structure", + "members": { + "executeCommandConfiguration": { + "target": "com.amazonaws.ecs#ExecuteCommandConfiguration", + "traits": { + "smithy.api#documentation": "The details of the execute command configuration.
" + } + }, + "managedStorageConfiguration": { + "target": "com.amazonaws.ecs#ManagedStorageConfiguration", + "traits": { + "smithy.api#documentation": "The details of the managed storage configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The execute command and managed storage configuration for the cluster.
" + } + }, + "com.amazonaws.ecs#ClusterContainsContainerInstancesException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "You can't delete a cluster that has registered container instances. First, deregister\n\t\t\tthe container instances before you can delete the cluster. For more information, see\n\t\t\t\tDeregisterContainerInstance.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#ClusterContainsServicesException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "You can't delete a cluster that contains services. First, update the service to reduce\n\t\t\tits desired task count to 0, and then delete the service. For more information, see\n\t\t\t\tUpdateService and\n\t\t\t\tDeleteService.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#ClusterContainsTasksException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "You can't delete a cluster that has active tasks.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#ClusterField": { + "type": "enum", + "members": { + "ATTACHMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENTS" + } + }, + "CONFIGURATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIGURATIONS" + } + }, + "SETTINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SETTINGS" + } + }, + "STATISTICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATISTICS" + } + }, + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGS" + } + } + } + }, + "com.amazonaws.ecs#ClusterFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ClusterField" + } + }, + "com.amazonaws.ecs#ClusterNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#ClusterServiceConnectDefaults": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a\n\t\t\tService Connect configuration, this namespace is used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#ClusterServiceConnectDefaultsRequest": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify\n\t\t\ta Service Connect configuration. The namespace name can include up to 1024 characters.\n\t\t\tThe name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than\n\t\t\t(>), less than (<), or slash (/).
\nIf you enter an existing namespace name or ARN, then that namespace will be used.\n\t\t\tAny namespace type is supported. The namespace must be in this account and this Amazon Web Services\n\t\t\tRegion.
\nIf you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a\n\t\t\tCloud Map namespace with the \"API calls\" method of instance discovery only. This instance\n\t\t\tdiscovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance\n\t\t\tdiscovery aren't used by Service Connect.
\nIf you update the cluster with an empty string \"\" for the namespace name,\n\t\t\tthe cluster configuration for Service Connect is removed. Note that the namespace will\n\t\t\tremain in Cloud Map and must be deleted separately.
For more information about Cloud Map, see Working with Services\n\t\t\tin the Cloud Map Developer Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#ClusterSetting": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#ClusterSettingName", + "traits": { + "smithy.api#documentation": "The name of the cluster setting. The value is containerInsights .
The value to set for the cluster setting. The supported values are\n\t\t\t\tenhanced, enabled, and disabled.
To use Container Insights with enhanced observability, set the\n\t\t\t\tcontainerInsights account setting to enhanced.
To use Container Insights, set the containerInsights account setting to\n\t\t\t\tenabled.
If a cluster value is specified, it will override the containerInsights\n\t\t\tvalue set with PutAccountSetting or PutAccountSettingDefault.
The settings to use when creating a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights with enhanced observability or CloudWatch Container Insights for a\n\t\t\tcluster.
\nContainer Insights with enhanced observability provides all the Container Insights\n\t\t\tmetrics, plus additional task and container metrics. This version supports enhanced\n\t\t\tobservability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you\n\t\t\tconfigure Container Insights with enhanced observability on Amazon ECS, Container Insights\n\t\t\tauto-collects detailed infrastructure telemetry from the cluster level down to the\n\t\t\tcontainer level in your environment and displays these critical performance data in\n\t\t\tcurated dashboards removing the heavy lifting in observability set-up.
\nFor more information, see Monitor\n\t\t\t\tAmazon ECS containers using Container Insights with enhanced observability in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#ClusterSettingName": { + "type": "enum", + "members": { + "CONTAINER_INSIGHTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "containerInsights" + } + } + } + }, + "com.amazonaws.ecs#ClusterSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ClusterSetting" + } + }, + "com.amazonaws.ecs#Clusters": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Cluster" + } + }, + "com.amazonaws.ecs#Compatibility": { + "type": "enum", + "members": { + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" + } + }, + "FARGATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE" + } + }, + "EXTERNAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL" + } + } + } + }, + "com.amazonaws.ecs#CompatibilityList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Compatibility" + } + }, + "com.amazonaws.ecs#ConflictException": { + "type": "structure", + "members": { + "resourceIds": { + "target": "com.amazonaws.ecs#ResourceIds", + "traits": { + "smithy.api#documentation": "The existing task ARNs which are already associated with the\n\t\t\t\tclientToken.
Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The RunTask request could not be processed due to conflicts. The provided\n\t\t\t\tclientToken is already in use with a different RunTask\n\t\t\trequest. The resourceIds are the existing task ARNs which are already\n\t\t\tassociated with the clientToken.
To fix this issue:
\nRun RunTask with a unique clientToken.
Run RunTask with the clientToken and the original\n\t\t\t\t\tset of parameters
The Amazon Resource Name (ARN) of the container.
" + } + }, + "taskArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the task.
" + } + }, + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container.
" + } + }, + "image": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The image used for the container.
" + } + }, + "imageDigest": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The container image manifest digest.
" + } + }, + "runtimeId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID of the Docker container.
" + } + }, + "lastStatus": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The last known status of the container.
" + } + }, + "exitCode": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The exit code returned from the container.
" + } + }, + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details about\n\t\t\ta running or stopped container.
" + } + }, + "networkBindings": { + "target": "com.amazonaws.ecs#NetworkBindings", + "traits": { + "smithy.api#documentation": "The network bindings associated with the container.
" + } + }, + "networkInterfaces": { + "target": "com.amazonaws.ecs#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "The network interfaces associated with the container.
" + } + }, + "healthStatus": { + "target": "com.amazonaws.ecs#HealthStatus", + "traits": { + "smithy.api#documentation": "The health status of the container. If health checks aren't configured for this\n\t\t\tcontainer in its task definition, then it reports the health status as\n\t\t\t\tUNKNOWN.
The details of any Amazon ECS managed agents associated with the container.
" + } + }, + "cpu": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The number of CPU units set for the container. The value is 0 if no value\n\t\t\twas specified in the container definition when the task definition was\n\t\t\tregistered.
The hard limit (in MiB) of memory set for the container.
" + } + }, + "memoryReservation": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The soft limit (in MiB) of memory set for the container.
" + } + }, + "gpuIds": { + "target": "com.amazonaws.ecs#GpuIds", + "traits": { + "smithy.api#documentation": "The IDs of each GPU assigned to the container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A Docker container that's part of a task.
" + } + }, + "com.amazonaws.ecs#ContainerCondition": { + "type": "enum", + "members": { + "START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + } + } + }, + "com.amazonaws.ecs#ContainerDefinition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of a container. If you're linking multiple containers together in a task\n\t\t\tdefinition, the name of one container can be entered in the\n\t\t\t\tlinks of another container to connect the containers.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the docker container\n\t\t\tcreate command and the --name option to docker run.
The image used to start a container. This string is passed directly to the Docker\n\t\t\tdaemon. By default, images in the Docker Hub registry are available. Other repositories\n\t\t\tare specified with either \n repository-url/image:tag\n or \n repository-url/image@digest\n . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the docker\n\t\t\tcontainer create command and the IMAGE parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of\n\t\t\t\t\tthe specified image and tag for the container to use. However, subsequent\n\t\t\t\t\tupdates to a repository image aren't propagated to already running tasks.
\nImages in Amazon ECR repositories can be specified by either using the full\n\t\t\t\t\t\tregistry/repository:tag or\n\t\t\t\t\t\tregistry/repository@digest. For example,\n\t\t\t\t\t\t012345678910.dkr.ecr.\n\t\t\t\t\tor\n\t\t\t\t\t\t012345678910.dkr.ecr..\n\t\t\t\t
Images in official repositories on Docker Hub use a single name (for example,\n\t\t\t\t\t\tubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization\n\t\t\t\t\tname (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name\n\t\t\t\t\t(for example, quay.io/assemblyline/ubuntu).
The private repository authentication credentials to use.
" + } + }, + "cpu": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of cpu units reserved for the container. This parameter maps\n\t\t\tto CpuShares in the docker container create commandand the\n\t\t\t\t--cpu-shares option to docker run.
This field is optional for tasks using the Fargate launch type, and the\n\t\t\tonly requirement is that the total amount of CPU reserved for all containers within a\n\t\t\ttask be lower than the task-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type\n\t\t\t\tby multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n\t\t\t\tby 1,024.
\nLinux containers share unallocated CPU units with other containers on the container\n\t\t\tinstance with the same ratio as their allocated amount. For example, if you run a\n\t\t\tsingle-container task on a single-core instance type with 512 CPU units specified for\n\t\t\tthat container, and that's the only task running on the container instance, that\n\t\t\tcontainer could use the full 1,024 CPU unit share at any given time. However, if you\n\t\t\tlaunched another copy of the same task on that container instance, each task is\n\t\t\tguaranteed a minimum of 512 CPU units when needed. Moreover, each container could float\n\t\t\tto higher CPU usage if the other container was not using it. If both tasks were 100%\n\t\t\tactive all of the time, they would be limited to 512 CPU units.
\nOn Linux container instances, the Docker daemon on the container instance uses the CPU\n\t\t\tvalue to calculate the relative CPU share ratios for running containers. The minimum\n\t\t\tvalid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share\n\t\t\tvalue that the Linux kernel allows is 262144. However, the CPU parameter isn't required,\n\t\t\tand you can use CPU values below 2 or above 262144 in your container definitions. For\n\t\t\tCPU values below 2 (including null) or above 262144, the behavior varies based on your\n\t\t\tAmazon ECS container agent version:
\n\n Agent versions less than or equal to 1.1.0:\n\t\t\t\t\tNull and zero CPU values are passed to Docker as 0, which Docker then converts\n\t\t\t\t\tto 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux\n\t\t\t\t\tkernel converts to two CPU shares.
\n\n Agent versions greater than or equal to 1.2.0:\n\t\t\t\t\tNull, zero, and CPU values of 1 are passed to Docker as 2.
\n\n Agent versions greater than or equal to\n\t\t\t\t\t\t1.84.0: CPU values greater than 256 vCPU are passed to Docker as\n\t\t\t\t\t256, which is equivalent to 262144 CPU shares.
\nOn Windows container instances, the CPU limit is enforced as an absolute limit, or a\n\t\t\tquota. Windows containers only have access to the specified amount of CPU that's\n\t\t\tdescribed in the task definition. A null or zero CPU value is passed to Docker as\n\t\t\t\t0, which Windows interprets as 1% of one CPU.
The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the docker container create command and the\n\t\t\t\t--memory option to docker run.
If using the Fargate launch type, this parameter is optional.
\nIf using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.
\nThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.
" + } + }, + "memoryReservation": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container. When system memory is\n\t\t\tunder heavy contention, Docker attempts to keep the container memory to this soft limit.\n\t\t\tHowever, your container can consume more memory when it needs to, up to either the hard\n\t\t\tlimit specified with the memory parameter (if applicable), or all of the\n\t\t\tavailable memory on the container instance, whichever comes first. This parameter maps\n\t\t\tto MemoryReservation in the docker container create command and the\n\t\t\t\t--memory-reservation option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for\n\t\t\tone or both of memory or memoryReservation in a container\n\t\t\tdefinition. If you specify both, memory must be greater than\n\t\t\t\tmemoryReservation. If you specify memoryReservation, then\n\t\t\tthat value is subtracted from the available memory resources for the container instance\n\t\t\twhere the container is placed. Otherwise, the value of memory is\n\t\t\tused.
For example, if your container normally uses 128 MiB of memory, but occasionally\n\t\t\tbursts to 256 MiB of memory for short periods of time, you can set a\n\t\t\t\tmemoryReservation of 128 MiB, and a memory hard limit of\n\t\t\t300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n\t\t\tfrom the remaining resources on the container instance, but also allow the container to\n\t\t\tconsume more memory resources when needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.
\nThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.
" + } + }, + "links": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The links parameter allows containers to communicate with each other\n\t\t\twithout the need for port mappings. This parameter is only supported if the network mode\n\t\t\tof a task definition is bridge. The name:internalName\n\t\t\tconstruct is analogous to name:alias in Docker links.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to Links in the docker\n\t\t\tcontainer create command and the --link option to docker run.
This parameter is not supported for Windows containers.
\nContainers that are collocated on a single container instance may be able to\n\t\t\t\tcommunicate with each other without requiring links or host port mappings. Network\n\t\t\t\tisolation is achieved on the container instance using security groups and VPC\n\t\t\t\tsettings.
\nThe list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.
\nFor task definitions that use the awsvpc network mode, only specify the\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must\n\t\t\tbe the same value as the containerPort.
Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There's no loopback for port mappings on Windows, so you\n\t\t\tcan't access a container's mapped port from the host itself.
This parameter maps to PortBindings in the the docker container create\n\t\t\tcommand and the --publish option to docker run. If the network mode of a\n\t\t\ttask definition is set to none, then you can't specify port mappings. If\n\t\t\tthe network mode of a task definition is set to host, then host ports must\n\t\t\teither be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings section DescribeTasks\n\t\t\t\tresponses.
If the essential parameter of a container is marked as true,\n\t\t\tand that container fails or stops for any reason, all other containers that are part of\n\t\t\tthe task are stopped. If the essential parameter of a container is marked\n\t\t\tas false, its failure doesn't affect the rest of the containers in a task.\n\t\t\tIf this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application\n\t\t\tthat's composed of multiple containers, group containers that are used for a common\n\t\t\tpurpose into components, and separate the different components into multiple task\n\t\t\tdefinitions. For more information, see Application\n\t\t\t\tArchitecture in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "restartPolicy": { + "target": "com.amazonaws.ecs#ContainerRestartPolicy", + "traits": { + "smithy.api#documentation": "The restart policy for a container. When you set up a restart policy, Amazon ECS can\n\t\t\trestart the container without needing to replace the task. For more information, see\n\t\t\t\tRestart\n\t\t\t\tindividual containers in Amazon ECS tasks with container restart policies in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" + } + }, + "entryPoint": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "Early versions of the Amazon ECS container agent don't properly handle\n\t\t\t\t\tentryPoint parameters. If you have problems using\n\t\t\t\t\tentryPoint, update your container agent or enter your commands and\n\t\t\t\targuments as command array items instead.
The entry point that's passed to the container. This parameter maps to\n\t\t\t\tEntrypoint in the docker container create command and the\n\t\t\t\t--entrypoint option to docker run.
The command that's passed to the container. This parameter maps to Cmd in\n\t\t\tthe docker container create command and the COMMAND parameter to docker\n\t\t\trun. If there are multiple arguments, each argument is a separated string in the\n\t\t\tarray.
The environment variables to pass to a container. This parameter maps to\n\t\t\t\tEnv in the docker container create command and the --env\n\t\t\toption to docker run.
We don't recommend that you use plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.
\nA list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env\n\t\t\tfile extension. Each line in an environment file contains an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored.
If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.
The mount points for data volumes in your container.
\nThis parameter maps to Volumes in the docker container create command and\n\t\t\tthe --volume option to docker run.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives.
Data volumes to mount from another container. This parameter maps to\n\t\t\t\tVolumesFrom in the docker container create command and the\n\t\t\t\t--volumes-from option to docker run.
Linux-specific modifications that are applied to the default Docker container configuration, such as Linux kernel\n\t\t\tcapabilities. For more information see KernelCapabilities.
\nThis parameter is not supported for Windows containers.
\nThe secrets to pass to the container. For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "dependsOn": { + "target": "com.amazonaws.ecs#ContainerDependencies", + "traits": { + "smithy.api#documentation": "The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies on other containers in a task definition. When a dependency is\n\t\t\tdefined for container startup, for container shutdown it is reversed.
\nFor tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to turn on container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it doesn't reach the desired status within that\n\t\t\ttime then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0 of the container agent to use a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init\n\t\t\tpackage. If your container instances are launched from version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
" + } + }, + "stopTimeout": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.
\nFor tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks that use the Fargate launch type, the max stop timeout value is 120\n\t\t\tseconds and if the parameter is not specified, the default value of 30 seconds is\n\t\t\tused.
\nFor tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to use a container stop timeout\n\t\t\tvalue. However, we recommend using the latest container agent version. For information\n\t\t\tabout checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
" + } + }, + "versionConsistency": { + "target": "com.amazonaws.ecs#VersionConsistency", + "traits": { + "smithy.api#documentation": "Specifies whether Amazon ECS will resolve the container image tag provided in the container\n\t\t\tdefinition to an image digest. By default, the value is enabled. If you set\n\t\t\tthe value for a container as disabled, Amazon ECS will not resolve the provided\n\t\t\tcontainer image tag to a digest and will use the original image URI specified in the\n\t\t\tcontainer definition for deployment. For more information about container image\n\t\t\tresolution, see Container image resolution in the Amazon ECS Developer\n\t\t\t\tGuide.
The hostname to use for your container. This parameter maps to Hostname\n\t\t\tin the docker container create command and the --hostname option to docker\n\t\t\trun.
The hostname parameter is not supported if you're using the\n\t\t\t\t\tawsvpc network mode.
The user to use inside the container. This parameter maps to User in the\n\t\t\tdocker container create command and the --user option to docker run.
When running tasks using the host network mode, don't run containers\n\t\t\t\tusing the root user (UID 0). We recommend using a non-root user for better\n\t\t\t\tsecurity.
You can specify the user using the following formats. If specifying a UID\n\t\t\tor GID, you must specify it as a positive integer.
\n user\n
\n user:group\n
\n uid\n
\n uid:gid\n
\n user:gid\n
\n uid:group\n
This parameter is not supported for Windows containers.
\nThe working directory to run commands inside the container in. This parameter maps to\n\t\t\t\tWorkingDir in the docker container create command and the\n\t\t\t\t--workdir option to docker run.
When this parameter is true, networking is off within the container. This parameter\n\t\t\tmaps to NetworkDisabled in the docker container create command.
This parameter is not supported for Windows containers.
\nWhen this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the root user). This parameter maps to\n\t\t\t\tPrivileged in the docker container create command and the\n\t\t\t\t--privileged option to docker run
This parameter is not supported for Windows containers or tasks run on Fargate.
\nWhen this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to ReadonlyRootfs in the docker container\n\t\t\tcreate command and the --read-only option to docker run.
This parameter is not supported for Windows containers.
\nA list of DNS servers that are presented to the container. This parameter maps to\n\t\t\t\tDns in the docker container create command and the --dns\n\t\t\toption to docker run.
This parameter is not supported for Windows containers.
\nA list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto DnsSearch in the docker container create command and the\n\t\t\t\t--dns-search option to docker run.
This parameter is not supported for Windows containers.
\nA list of hostnames and IP address mappings to append to the /etc/hosts\n\t\t\tfile on the container. This parameter maps to ExtraHosts in the docker\n\t\t\tcontainer create command and the --add-host option to docker run.
This parameter isn't supported for Windows containers or tasks that use the\n\t\t\t\t\tawsvpc network mode.
A list of strings to provide custom configuration for multiple security systems. This\n\t\t\tfield isn't valid for containers in tasks using the Fargate launch\n\t\t\ttype.
\nFor Linux tasks on EC2, this parameter can be used to reference custom\n\t\t\tlabels for SELinux and AppArmor multi-level security systems.
\nFor any tasks on EC2, this parameter can be used to reference a\n\t\t\tcredential spec file that configures a container for Active Directory authentication.\n\t\t\tFor more information, see Using gMSAs for Windows\n\t\t\t\tContainers and Using gMSAs for Linux\n\t\t\t\tContainers in the Amazon Elastic Container Service Developer Guide.
\nThis parameter maps to SecurityOpt in the docker container create command\n\t\t\tand the --security-opt option to docker run.
The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true\n\t\t\t\tenvironment variables before containers placed on that instance can use these\n\t\t\t\tsecurity options. For more information, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"
" + } + }, + "interactive": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "When this parameter is true, you can deploy containerized applications\n\t\t\tthat require stdin or a tty to be allocated. This parameter\n\t\t\tmaps to OpenStdin in the docker container create command and the\n\t\t\t\t--interactive option to docker run.
When this parameter is true, a TTY is allocated. This parameter maps to\n\t\t\t\tTty in the docker container create command and the --tty\n\t\t\toption to docker run.
A key/value map of labels to add to the container. This parameter maps to\n\t\t\t\tLabels in the docker container create command and the\n\t\t\t\t--label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
A list of ulimits to set in the container. If a ulimit value\n\t\t\tis specified in a task definition, it overrides the default values set by Docker. This\n\t\t\tparameter maps to Ulimits in the docker container create command and the\n\t\t\t\t--ulimit option to docker run. Valid naming values are displayed in the\n\t\t\t\tUlimit data type.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 65535 and the default hard limit\n\t\t\t\t\t\t\tis 65535.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
This parameter is not supported for Windows containers.
\nThe log configuration specification for the container.
\nThis parameter maps to LogConfig in the docker container create command\n\t\t\tand the --log-driver option to docker run. By default, containers use the\n\t\t\tsame logging driver that the Docker daemon uses. However the container can use a\n\t\t\tdifferent logging driver than the Docker daemon by specifying a log driver with this\n\t\t\tparameter in the container definition. To use a different logging driver for a\n\t\t\tcontainer, the log system must be configured properly on the container instance (or on a\n\t\t\tdifferent log server for remote logging options).
Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the LogConfiguration data type). Additional log drivers may be available in\n\t\t\t\tfuture releases of the Amazon ECS container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The Amazon ECS container agent running on a container instance must register the\n\t\t\t\tlogging drivers available on that instance with the\n\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\tcontainers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
The container health check command and associated configuration parameters for the\n\t\t\tcontainer. This parameter maps to HealthCheck in the docker container\n\t\t\tcreate command and the HEALTHCHECK parameter of docker run.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the docker container create command and the\n\t\t\t\t--sysctl option to docker run. For example, you can configure\n\t\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.
The type and amount of a resource to assign to a container. The only supported\n\t\t\tresource is a GPU.
" + } + }, + "firelensConfiguration": { + "target": "com.amazonaws.ecs#FirelensConfiguration", + "traits": { + "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom Log Routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + } + }, + "credentialSpecs": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that\n\t\t\tconfigures the container for Active Directory authentication. We recommend that you use\n\t\t\tthis parameter instead of the dockerSecurityOptions. The maximum number of\n\t\t\tARNs is 1.
There are two formats for each ARN.
\nYou use credentialspecdomainless:MyARN to provide a\n\t\t\t\t\t\t\tCredSpec with an additional section for a secret in Secrets Manager.\n\t\t\t\t\t\tYou provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different\n\t\t\t\t\t\tdomains.
\nYou can use this format without joining the container instance to a\n\t\t\t\t\t\tdomain.
\nYou use credentialspec:MyARN to provide a\n\t\t\t\t\t\t\tCredSpec for a single domain.
You must join the container instance to the domain before you start any\n\t\t\t\t\t\ttasks that use this task definition.
\nIn both formats, replace MyARN with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN, the\n\t\t\t\tcredspec must provide a ARN in Secrets Manager for a secret containing the\n\t\t\tusername, password, and the domain to connect to. For better security, the instance\n\t\t\tisn't joined to the domain for domainless authentication. Other applications on the\n\t\t\tinstance can't use the domainless credentials. You can use this parameter to run tasks\n\t\t\ton the same instance, even it the tasks need to join different domains. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers and Using gMSAs for Linux\n\t\t\t\tContainers.
Container definitions are used in task definitions to describe the different\n\t\t\tcontainers that are launched as part of a task.
" + } + }, + "com.amazonaws.ecs#ContainerDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ContainerDefinition" + } + }, + "com.amazonaws.ecs#ContainerDependencies": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ContainerDependency" + } + }, + "com.amazonaws.ecs#ContainerDependency": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of a container.
", + "smithy.api#required": {} + } + }, + "condition": { + "target": "com.amazonaws.ecs#ContainerCondition", + "traits": { + "smithy.api#documentation": "The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:
\n\n START - This condition emulates the behavior of links and\n\t\t\t\t\tvolumes today. It validates that a dependent container is started before\n\t\t\t\t\tpermitting other containers to start.
\n COMPLETE - This condition validates that a dependent\n\t\t\t\t\tcontainer runs to completion (exits) before permitting other containers to\n\t\t\t\t\tstart. This can be useful for nonessential containers that run a script and then\n\t\t\t\t\texit. This condition can't be set on an essential container.
\n SUCCESS - This condition is the same as\n\t\t\t\t\t\tCOMPLETE, but it also requires that the container exits with a\n\t\t\t\t\t\tzero status. This condition can't be set on an essential\n\t\t\t\t\tcontainer.
\n HEALTHY - This condition validates that the dependent\n\t\t\t\t\tcontainer passes its Docker health check before permitting other containers to\n\t\t\t\t\tstart. This requires that the dependent container has health checks configured.\n\t\t\t\t\tThis condition is confirmed only at task startup.
The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto use container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#ContainerImage": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container.
" + } + }, + "imageDigest": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The container image digest.
" + } + }, + "image": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The container image.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details about the container image a service revision uses.
\nTo ensure that all tasks in a service use the same container image, Amazon ECS\n\t\t\tresolves container image names and any image tags specified in the task definition to\n\t\t\tcontainer image digests.
\nAfter the container image digest has been established, Amazon ECS uses the digest to\n\t\t\tstart any other desired tasks, and for any future service and service revision updates.\n\t\t\tThis leads to all tasks in a service always running identical container images,\n\t\t\tresulting in version consistency for your software. For more information, see Container image resolution in the Amazon ECS Developer Guide.
" + } + }, + "com.amazonaws.ecs#ContainerImages": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ContainerImage" + } + }, + "com.amazonaws.ecs#ContainerInstance": { + "type": "structure", + "members": { + "containerInstanceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format,\n\t\t\tsee Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" + } + }, + "ec2InstanceId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2\n\t\t\tinstance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
" + } + }, + "capacityProviderName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The capacity provider that's associated with the container instance.
" + } + }, + "version": { + "target": "com.amazonaws.ecs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The version counter for the container instance. Every time a container instance\n\t\t\texperiences a change that triggers a CloudWatch event, the version counter is\n\t\t\tincremented. If you're replicating your Amazon ECS container instance state with CloudWatch\n\t\t\tEvents, you can compare the version of a container instance reported by the Amazon ECS APIs\n\t\t\twith the version reported in CloudWatch Events for the container instance (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.
The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.
" + } + }, + "remainingResources": { + "target": "com.amazonaws.ecs#Resources", + "traits": { + "smithy.api#documentation": "For CPU and memory resource types, this parameter describes the remaining CPU and\n\t\t\tmemory that wasn't already allocated to tasks and is therefore available for new tasks.\n\t\t\tFor port resource types, this parameter describes the ports that were reserved by the\n\t\t\tAmazon ECS container agent (at instance registration time) and any task containers that have\n\t\t\treserved port mappings on the host (with the host or bridge\n\t\t\tnetwork mode). Any port that's not specified here is available for new tasks.
For CPU and memory resource types, this parameter describes the amount of each\n\t\t\tresource that was available on the container instance when the container agent\n\t\t\tregistered it with Amazon ECS. This value represents the total amount of CPU and memory that\n\t\t\tcan be allocated on this container instance to tasks. For port resource types, this\n\t\t\tparameter describes the ports that were reserved by the Amazon ECS container agent when it\n\t\t\tregistered the container instance with Amazon ECS.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING indicates that new tasks aren't placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container instance draining in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
The reason that the container instance reached its current status.
" + } + }, + "agentConnected": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This parameter returns true if the agent is connected to Amazon ECS. An\n\t\t\tinstance with an agent that may be unhealthy or stopped return false. Only\n\t\t\tinstances connected to an agent can accept task placement requests.
The number of tasks on the container instance that have a desired status\n\t\t\t\t(desiredStatus) of RUNNING.
The number of tasks on the container instance that are in the PENDING\n\t\t\tstatus.
The status of the most recent agent update. If an update wasn't ever requested, this\n\t\t\tvalue is NULL.
The attributes set for the container instance, either by the Amazon ECS container agent at\n\t\t\tinstance registration or manually with the PutAttributes\n\t\t\toperation.
" + } + }, + "registeredAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the container instance was registered.
" + } + }, + "attachments": { + "target": "com.amazonaws.ecs#Attachments", + "traits": { + "smithy.api#documentation": "The resources attached to a container instance, such as an elastic network\n\t\t\tinterface.
" + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
An object representing the health status of the container instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered\n\t\t\twith a cluster.
" + } + }, + "com.amazonaws.ecs#ContainerInstanceField": { + "type": "enum", + "members": { + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGS" + } + }, + "CONTAINER_INSTANCE_HEALTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINER_INSTANCE_HEALTH" + } + } + } + }, + "com.amazonaws.ecs#ContainerInstanceFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ContainerInstanceField" + } + }, + "com.amazonaws.ecs#ContainerInstanceHealthStatus": { + "type": "structure", + "members": { + "overallStatus": { + "target": "com.amazonaws.ecs#InstanceHealthCheckState", + "traits": { + "smithy.api#documentation": "The overall health status of the container instance. This is an aggregate status of\n\t\t\tall container instance health checks.
" + } + }, + "details": { + "target": "com.amazonaws.ecs#InstanceHealthCheckResultList", + "traits": { + "smithy.api#documentation": "An array of objects representing the details of the container instance health\n\t\t\tstatus.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the health status of the container instance.
" + } + }, + "com.amazonaws.ecs#ContainerInstanceStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAINING" + } + }, + "REGISTERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTERING" + } + }, + "DEREGISTERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEREGISTERING" + } + }, + "REGISTRATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTRATION_FAILED" + } + } + } + }, + "com.amazonaws.ecs#ContainerInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ContainerInstance" + } + }, + "com.amazonaws.ecs#ContainerOverride": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container that receives the override. This parameter is required if\n\t\t\tany override is specified.
" + } + }, + "command": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The command to send to the container that overrides the default command from the\n\t\t\tDocker image or the task definition. You must also specify a container name.
" + } + }, + "environment": { + "target": "com.amazonaws.ecs#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "The environment variables to send to the container. You can add new environment\n\t\t\tvariables, which are added to the container at launch, or you can override the existing\n\t\t\tenvironment variables from the Docker image or the task definition. You must also\n\t\t\tspecify a container name.
" + } + }, + "environmentFiles": { + "target": "com.amazonaws.ecs#EnvironmentFiles", + "traits": { + "smithy.api#documentation": "A list of files containing the environment variables to pass to a container, instead\n\t\t\tof the value from the container definition.
" + } + }, + "cpu": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The number of cpu units reserved for the container, instead of the\n\t\t\tdefault value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default\n\t\t\tvalue from the task definition. If your container attempts to exceed the memory\n\t\t\tspecified here, the container is killed. You must also specify a container name.
" + } + }, + "memoryReservation": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default\n\t\t\tvalue from the task definition. You must also specify a container name.
" + } + }, + "resourceRequirements": { + "target": "com.amazonaws.ecs#ResourceRequirements", + "traits": { + "smithy.api#documentation": "The type and amount of a resource to assign to a container, instead of the default\n\t\t\tvalue from the task definition. The only supported resource is a GPU.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The overrides that are sent to a container. An empty container override can be passed\n\t\t\tin. An example of an empty container override is {\"containerOverrides\": [ ]\n\t\t\t\t}. If a non-empty container override is specified, the name\n\t\t\tparameter must be included.
You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the\n\t\t\tsensitive data. For more information, see Retrieve secrets through\n\t\t\t\tenvironment variables in the Amazon ECS Developer Guide.
" + } + }, + "com.amazonaws.ecs#ContainerOverrides": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ContainerOverride" + } + }, + "com.amazonaws.ecs#ContainerRestartPolicy": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Specifies whether a restart policy is enabled for the container.
", + "smithy.api#required": {} + } + }, + "ignoredExitCodes": { + "target": "com.amazonaws.ecs#IntegerList", + "traits": { + "smithy.api#documentation": "A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can\n\t\t\tspecify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit\n\t\t\tcodes.
" + } + }, + "restartAttemptPeriod": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "A period of time (in seconds) that the container must run for before a restart can be\n\t\t\tattempted. A container can be restarted only once every\n\t\t\t\trestartAttemptPeriod seconds. If a container isn't able to run for this\n\t\t\ttime period and exits early, it will not be restarted. You can set a minimum\n\t\t\t\trestartAttemptPeriod of 60 seconds and a maximum\n\t\t\t\trestartAttemptPeriod of 1800 seconds. By default, a container must run\n\t\t\tfor 300 seconds before it can be restarted.
You can enable a restart policy for each container defined in your task definition, to\n\t\t\tovercome transient failures faster and maintain task availability. When you enable a\n\t\t\trestart policy for a container, Amazon ECS can restart the container if it exits, without\n\t\t\tneeding to replace the task. For more information, see Restart\n\t\t\t\tindividual containers in Amazon ECS tasks with container restart policies in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#ContainerStateChange": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container.
" + } + }, + "imageDigest": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The container image SHA 256 digest.
" + } + }, + "runtimeId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID of the Docker container.
" + } + }, + "exitCode": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The exit code for the container, if the state change is a result of the container\n\t\t\texiting.
" + } + }, + "networkBindings": { + "target": "com.amazonaws.ecs#NetworkBindings", + "traits": { + "smithy.api#documentation": "Any network bindings that are associated with the container.
" + } + }, + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The reason for the state change.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that represents a change in state for a container.
" + } + }, + "com.amazonaws.ecs#ContainerStateChanges": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ContainerStateChange" + } + }, + "com.amazonaws.ecs#Containers": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Container" + } + }, + "com.amazonaws.ecs#CreateCapacityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#CreateCapacityProviderRequest" + }, + "output": { + "target": "com.amazonaws.ecs#CreateCapacityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#LimitExceededException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UpdateInProgressException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.
\nOnly capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tFargate use the FARGATE and FARGATE_SPOT capacity providers.\n\t\t\tThese providers are available to all accounts in the Amazon Web Services Regions that Fargate\n\t\t\tsupports.
The name of the capacity provider. Up to 255 characters are allowed. They include\n\t\t\tletters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-).\n\t\t\tThe name can't be prefixed with \"aws\", \"ecs\", or\n\t\t\t\t\"fargate\".
The details of the Auto Scaling group for the capacity provider.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The metadata that you apply to the capacity provider to categorize and organize them\n\t\t\tmore conveniently. Each tag consists of a key and an optional value. You define both of\n\t\t\tthem.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The full description of the new capacity provider.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#CreateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#CreateClusterRequest" + }, + "output": { + "target": "com.amazonaws.ecs#CreateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#NamespaceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name.
When you call the CreateCluster\n\t\t\t\tAPI operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your\n\t\t\t\taccount. This is so that it can manage required resources in other Amazon Web Services services on\n\t\t\t\tyour behalf. However, if the user that makes the call doesn't have permissions to\n\t\t\t\tcreate the service-linked role, it isn't created. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
\nThe name of your cluster. If you don't specify a name for your cluster, you create a\n\t\t\tcluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The setting to use when creating a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The execute command configuration for the cluster.
The short name of one or more capacity providers to associate with the cluster. A\n\t\t\tcapacity provider must be associated with a cluster before it can be included as part of\n\t\t\tthe default capacity provider strategy of the cluster or used in a capacity provider\n\t\t\tstrategy when calling the CreateService or\n\t\t\t\tRunTask actions.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must be created but not associated with another cluster. New Auto Scaling group\n\t\t\tcapacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutCapacityProvider API operation is used to update the list of available\n\t\t\tcapacity providers for a cluster after the cluster is created.
" + } + }, + "defaultCapacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "The capacity provider strategy to set as the default for the cluster. After a default\n\t\t\tcapacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no\n\t\t\tcapacity provider strategy or launch type specified, the default capacity provider\n\t\t\tstrategy for the cluster is used.
\nIf a default capacity provider strategy isn't defined for a cluster when it was\n\t\t\tcreated, it can be defined later with the PutClusterCapacityProviders API operation.
" + } + }, + "serviceConnectDefaults": { + "target": "com.amazonaws.ecs#ClusterServiceConnectDefaultsRequest", + "traits": { + "smithy.api#documentation": "Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#CreateClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#Cluster", + "traits": { + "smithy.api#documentation": "The full description of your new cluster.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#CreateService": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#CreateServiceRequest" + }, + "output": { + "target": "com.amazonaws.ecs#CreateServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#NamespaceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#PlatformTaskDefinitionIncompatibilityException" + }, + { + "target": "com.amazonaws.ecs#PlatformUnknownException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + } + ], + "traits": { + "smithy.api#documentation": "Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, use UpdateService.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nIn addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nYou can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. volumeConfigurations is only supported for REPLICA\n\t\t\tservice and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.
There are two service scheduler strategies available:
\n\n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
\n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.
If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide\n
", + "smithy.api#examples": [ + { + "title": "To create a new service", + "documentation": "This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task.", + "input": { + "serviceName": "ecs-simple-service", + "taskDefinition": "hello_world", + "desiredCount": 10 + }, + "output": { + "service": { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:13:47.298Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:13:47.298Z", + "desiredCount": 10, + "id": "ecs-svc/9223370564342348388", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:13:47.298Z" + }, + { + "createdAt": "2016-08-29T15:52:44.481Z", + "desiredCount": 0, + "id": "ecs-svc/9223370564343611322", + "pendingCount": 0, + "runningCount": 0, + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:11:38.941Z" + } + ], + "desiredCount": 10, + "events": [], + "loadBalancers": [], + "pendingCount": 0, + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", + "serviceName": "ecs-simple-service", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6" + } + } + }, + { + "title": "To create a new service behind a load balancer", + "documentation": "This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name.", + "input": { + "loadBalancers": [ + { + "containerName": "simple-app", + "containerPort": 80, + "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2" + } + ], + "serviceName": "ecs-simple-service-elb", + "role": "ecsServiceRole", + "taskDefinition": "console-sample-app-static", + "desiredCount": 10 + }, + "output": { + "service": { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:02:54.884Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:02:54.884Z", + "desiredCount": 10, + "id": "ecs-svc/9223370564343000923", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6", + "updatedAt": "2016-08-29T16:02:54.884Z" + } + ], + "desiredCount": 10, + "events": [], + "loadBalancers": [ + { + "containerName": "simple-app", + "containerPort": 80, + "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2" + } + ], + "pendingCount": 0, + "roleArn": "arn:aws:iam::012345678910:role/ecsServiceRole", + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service-elb", + "serviceName": "ecs-simple-service-elb", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/default/console-sample-app-static:6" + } + } + } + ] + } + }, + "com.amazonaws.ecs#CreateServiceRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + } + }, + "serviceName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster, but you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
", + "smithy.api#required": {} + } + }, + "taskDefinition": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision\n\t\t\tisn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or\n\t\t\t\tCODE_DEPLOY deployment controllers.
For more information about deployment types, see Amazon ECS deployment\n\t\t\t\ttypes.
" + } + }, + "availabilityZoneRebalancing": { + "target": "com.amazonaws.ecs#AvailabilityZoneRebalancing", + "traits": { + "smithy.api#documentation": "Indicates whether to use Availability Zone rebalancing for the service.
\nFor more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
" + } + }, + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", + "traits": { + "smithy.api#documentation": "A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nIf the service uses the rolling update (ECS) deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.
If you use the CODE_DEPLOY deployment controller, these values can be\n\t\t\tchanged when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.
\nFor Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted.\n\t\t\tWhen a task from this service is placed on a container instance, the container instance\n\t\t\tis registered with the load balancer that's specified here.
\nServices with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.
The details of the service discovery registry to associate with this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
\nEach service may be associated with one service registry. Multiple service\n\t\t\t\tregistries for each service isn't supported.
\nThe number of instantiations of the specified task definition to place and keep\n\t\t\trunning in your service.
\nThis is required if schedulingStrategy is REPLICA or isn't\n\t\t\tspecified. If schedulingStrategy is DAEMON then this isn't\n\t\t\trequired.
An identifier that you provide to ensure the idempotency of the request. It must be\n\t\t\tunique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
" + } + }, + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", + "traits": { + "smithy.api#documentation": "The infrastructure that you run your service on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
\nThe FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.
Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the Amazon ECS\n\t\t\t\t\tDeveloper Guide.
\nThe EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.
The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.
The capacity provider strategy to use for the service.
\nIf a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy can contain a maximum of 20 capacity providers.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The platform version that your tasks in the service are running on. A platform version\n\t\t\tis specified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used. For more information, see\n\t\t\t\tFargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n\t\t\tload balancer on your behalf. This parameter is only permitted if you are using a load\n\t\t\tbalancer with your service and your task definition doesn't use the awsvpc\n\t\t\tnetwork mode. If you specify the role parameter, you must also specify a\n\t\t\tload balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is\n\t\t\t\tused for your service unless you specify a role here. The service-linked role is\n\t\t\t\trequired if your task definition uses the awsvpc network mode or if the\n\t\t\t\tservice is configured to use service discovery, an external deployment controller,\n\t\t\t\tmultiple target groups, or Elastic Inference accelerators in which case you don't\n\t\t\t\tspecify a role here. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /, then you must either\n\t\t\tspecify the full role ARN (this is recommended) or prefix the role name with the path.\n\t\t\tFor example, if a role with the name bar has a path of /foo/\n\t\t\tthen you would specify /foo/bar as the role name. For more information, see\n\t\t\t\tFriendly names and paths in the IAM User\n\t\t\tGuide.
Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" + } + }, + "placementConstraints": { + "target": "com.amazonaws.ecs#PlacementConstraints", + "traits": { + "smithy.api#documentation": "An array of placement constraint objects to use for tasks in your service. You can\n\t\t\tspecify a maximum of 10 constraints for each task. This limit includes constraints in\n\t\t\tthe task definition and those specified at runtime.
" + } + }, + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", + "traits": { + "smithy.api#documentation": "The placement strategy objects to use for tasks in your service. You can specify a\n\t\t\tmaximum of 5 strategy rules for each service.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for the service. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it isn't supported for other network modes. For more information,\n\t\t\tsee Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't\n\t\t\tspecify a health check grace period value, the default value of 0 is used.\n\t\t\tIf you don't use any of the health checks, then\n\t\t\t\thealthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can\n\t\t\tspecify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.
" + } + }, + "schedulingStrategy": { + "target": "com.amazonaws.ecs#SchedulingStrategy", + "traits": { + "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available:
\n\n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. This\n\t\t\t\t\tscheduler strategy is required if the service uses the CODE_DEPLOY\n\t\t\t\t\tor EXTERNAL deployment controller types.
\n DAEMON-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks and will stop tasks\n\t\t\t\t\tthat don't meet the placement constraints. When you're using this strategy, you\n\t\t\t\t\tdon't need to specify a desired number of tasks, a task placement strategy, or\n\t\t\t\t\tuse Service Auto Scaling policies.
Tasks using the Fargate launch type or the\n\t\t\t\t\t\t\tCODE_DEPLOY or EXTERNAL deployment controller\n\t\t\t\t\t\ttypes don't support the DAEMON scheduling strategy.
The deployment controller to use for the service. If no deployment controller is\n\t\t\tspecified, the default value of ECS is used.
The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging your Amazon ECS\n\t\t\t\tresources in the Amazon Elastic Container Service Developer Guide.
\nWhen you use Amazon ECS managed tags, you need to set the propagateTags\n\t\t\trequest parameter.
Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.
\nYou must set this to a value other than NONE when you use Cost Explorer.\n\t\t\tFor more information, see Amazon ECS usage reports\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The default is NONE.
Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe service tasks.
The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "volumeConfigurations": { + "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", + "traits": { + "smithy.api#documentation": "The configuration for a volume specified in the task definition as a volume that is\n\t\t\tconfigured at launch time. Currently, the only supported volume type is an Amazon EBS\n\t\t\tvolume.
" + } + }, + "vpcLatticeConfigurations": { + "target": "com.amazonaws.ecs#VpcLatticeConfigurations", + "traits": { + "smithy.api#documentation": "The VPC Lattice configuration for the service being created.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#CreateServiceResponse": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.ecs#Service", + "traits": { + "smithy.api#documentation": "The full description of your service following the create call.
\nA service will return either a capacityProviderStrategy or\n\t\t\t\tlaunchType parameter, but not both, depending where one was specified\n\t\t\twhen it was created.
If a service is using the ECS deployment controller, the\n\t\t\t\tdeploymentController and taskSets parameters will not be\n\t\t\treturned.
if the service uses the CODE_DEPLOY deployment controller, the\n\t\t\t\tdeploymentController, taskSets and\n\t\t\t\tdeployments parameters will be returned, however the\n\t\t\t\tdeployments parameter will be an empty list.
Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the EXTERNAL deployment controller type. For more information, see\n\t\t\t\tAmazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nFor information about the maximum number of task sets and other quotas, see Amazon ECS\n\t\t\t\tservice quotas in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#examples": [ + { + "title": "To create a task set", + "documentation": "This example creates a task set in a service that uses the EXTERNAL deployment controller.", + "input": { + "service": "MyService", + "cluster": "MyCluster", + "taskDefinition": "MyTaskDefinition:2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ] + } + } + }, + "output": { + "taskSet": { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition:2", + "computedDesiredCount": 0, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1.557128360711E9, + "updatedAt": 1.557128360711E9, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 0, + "unit": "PERCENT" + }, + "stabilityStatus": "STABILIZING", + "stabilityStatusAt": 1.557128360711E9 + } + } + } + ] + } + }, + "com.amazonaws.ecs#CreateTaskSetRequest": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
", + "smithy.api#required": {} + } + }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the\n\t\t\ttask set in.
", + "smithy.api#required": {} + } + }, + "externalId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "An optional non-unique tag that identifies this task set in external systems. If the\n\t\t\ttask set is associated with a service discovery registry, the tasks in this task set\n\t\t\twill have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided\n\t\t\tvalue.
The task definition for the tasks in the task set to use. If a revision isn't\n\t\t\tspecified, the latest ACTIVE revision is used.
An object representing the network configuration for a task set.
" + } + }, + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", + "traits": { + "smithy.api#documentation": "A load balancer object representing the load balancer to use with the task set. The\n\t\t\tsupported load balancer types are either an Application Load Balancer or a Network Load Balancer.
" + } + }, + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", + "traits": { + "smithy.api#documentation": "The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
" + } + }, + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", + "traits": { + "smithy.api#documentation": "The launch type that new tasks in the task set uses. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
\nIf a launchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.
The capacity provider strategy to use for the task set.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity provider\n\t\t\twith a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProviderProviderAPI operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the list of\n\t\t\tavailable capacity providers for a cluster after the cluster is created.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The platform version that the tasks in the task set uses. A platform version is\n\t\t\tspecified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used.
A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" + } + }, + "clientToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "An identifier that you provide to ensure the idempotency of the request. It must be\n\t\t\tunique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
" + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both. When a service is\n\t\t\tdeleted, the tags are deleted.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an\n\t\t\t\tEXTERNAL deployment. A task set includes details such as the desired\n\t\t\tnumber of tasks, how many tasks are running, and whether the task set serves production\n\t\t\ttraffic.
Include service deployments in the result that were created before this time. The\n\t\t\tformat is yyyy-MM-dd HH:mm:ss.SSSSSS.
" + } + }, + "after": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "Include service deployments in the result that were created after this time. The\n\t\t\tformat is yyyy-MM-dd HH:mm:ss.SSSSSS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The optional filter to narrow the ListServiceDeployment results.
If you do not specify a value, service deployments that were created before the\n\t\t\tcurrent time are included in the result.
" + } + }, + "com.amazonaws.ecs#DeleteAccountSetting": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DeleteAccountSettingRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DeleteAccountSettingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Disables an account setting for a specified user, role, or the root user for an\n\t\t\taccount.
", + "smithy.api#examples": [ + { + "title": "To delete the account settings for a specific IAM user or IAM role", + "documentation": "This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user.", + "input": { + "name": "containerInstanceLongArnFormat", + "principalArn": "arn:aws:iam::The resource name to disable the account setting for. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected.
The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the\n\t\t\troot user. If you specify the root user, it disables the account setting for all users, roles,\n\t\t\tand the root user of the account unless a user or role explicitly overrides these settings.\n\t\t\tIf this field is omitted, the setting is changed only for the authenticated user.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DeleteAccountSettingResponse": { + "type": "structure", + "members": { + "setting": { + "target": "com.amazonaws.ecs#Setting", + "traits": { + "smithy.api#documentation": "The account setting for the specified principal ARN.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DeleteAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DeleteAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DeleteAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#TargetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes one or more custom attributes from an Amazon ECS resource.
", + "smithy.api#examples": [ + { + "title": "To delete a custom attribute from an Amazon ECS instance", + "documentation": "This example deletes an attribute named stack from a container instance. ", + "input": { + "attributes": [ + { + "name": "stack", + "targetId": "aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34" + } + ] + }, + "output": { + "attributes": [ + { + "name": "stack", + "targetId": "aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", + "value": "production" + } + ] + } + } + ] + } + }, + "com.amazonaws.ecs#DeleteAttributesRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" + } + }, + "attributes": { + "target": "com.amazonaws.ecs#Attributes", + "traits": { + "smithy.api#documentation": "The attributes to delete from your resource. You can specify up to 10 attributes for\n\t\t\teach request. For custom attributes, specify the attribute name and target ID, but don't\n\t\t\tspecify the value. If you specify the target ID using the short form, you must also\n\t\t\tspecify the target type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DeleteAttributesResponse": { + "type": "structure", + "members": { + "attributes": { + "target": "com.amazonaws.ecs#Attributes", + "traits": { + "smithy.api#documentation": "A list of attribute objects that were successfully deleted from your resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DeleteCapacityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DeleteCapacityProviderRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DeleteCapacityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified capacity provider.
\nThe FARGATE and FARGATE_SPOT capacity providers are\n\t\t\t\treserved and can't be deleted. You can disassociate them from a cluster using either\n\t\t\t\t\tPutClusterCapacityProviders or by deleting the cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from\n\t\t\tthe capacity provider strategy from all services. The UpdateService API\n\t\t\tcan be used to remove a capacity provider from a service's capacity provider strategy.\n\t\t\tWhen updating a service, the forceNewDeployment option can be used to\n\t\t\tensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n\t\t\tprovider are transitioned to use the capacity from the remaining capacity providers.\n\t\t\tOnly capacity providers that aren't associated with a cluster can be deleted. To remove\n\t\t\ta capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.
The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DeleteCapacityProviderResponse": { + "type": "structure", + "members": { + "capacityProvider": { + "target": "com.amazonaws.ecs#CapacityProvider", + "traits": { + "smithy.api#documentation": "The details of the capacity provider.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterContainsContainerInstancesException" + }, + { + "target": "com.amazonaws.ecs#ClusterContainsServicesException" + }, + { + "target": "com.amazonaws.ecs#ClusterContainsTasksException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UpdateInProgressException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.
You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
", + "smithy.api#examples": [ + { + "title": "To delete an empty cluster", + "documentation": "This example deletes an empty cluster in your default region.", + "input": { + "cluster": "my_cluster" + }, + "output": { + "cluster": { + "activeServicesCount": 0, + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", + "clusterName": "my_cluster", + "pendingTasksCount": 0, + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "status": "INACTIVE" + } + } + } + ] + } + }, + "com.amazonaws.ecs#DeleteClusterRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DeleteClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#Cluster", + "traits": { + "smithy.api#documentation": "The full description of the deleted cluster.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DeleteService": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DeleteServiceRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DeleteServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#ServiceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you can't delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.
\nWhen you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + } + }, + "service": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the service to delete.
", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "If true, allows you to delete a service even if it wasn't scaled down to\n\t\t\tzero tasks. It's only necessary to use this if the service uses the REPLICA\n\t\t\tscheduling strategy.
The full description of the deleted service.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DeleteTaskDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DeleteTaskDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DeleteTaskDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes one or more task definitions.
\nYou must deregister a task definition revision before you delete it. For more\n\t\t\tinformation, see DeregisterTaskDefinition.
\nWhen you delete a task definition revision, it is immediately transitions from the\n\t\t\t\tINACTIVE to DELETE_IN_PROGRESS. Existing tasks and\n\t\t\tservices that reference a DELETE_IN_PROGRESS task definition revision\n\t\t\tcontinue to run without disruption. Existing services that reference a\n\t\t\t\tDELETE_IN_PROGRESS task definition revision can still scale up or down\n\t\t\tby modifying the service's desired count.
You can't use a DELETE_IN_PROGRESS task definition revision to run new\n\t\t\ttasks or create new services. You also can't update an existing service to reference a\n\t\t\t\tDELETE_IN_PROGRESS task definition revision.
A task definition revision will stay in DELETE_IN_PROGRESS status until\n\t\t\tall the associated tasks and services have been terminated.
When you delete all INACTIVE task definition revisions, the task\n\t\t\tdefinition name is not displayed in the console and not returned in the API. If a task\n\t\t\tdefinition revisions are in the DELETE_IN_PROGRESS state, the task\n\t\t\tdefinition name is displayed in the console and returned in the API. The task definition\n\t\t\tname is retained by Amazon ECS and the revision is incremented the next time you create a\n\t\t\ttask definition with that name.
The family and revision (family:revision) or\n\t\t\tfull Amazon Resource Name (ARN) of the task definition to delete. You must specify a\n\t\t\t\trevision.
You can specify up to 10 task definitions as a comma separated list.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DeleteTaskDefinitionsResponse": { + "type": "structure", + "members": { + "taskDefinitions": { + "target": "com.amazonaws.ecs#TaskDefinitionList", + "traits": { + "smithy.api#documentation": "The list of deleted task definitions.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DeleteTaskSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DeleteTaskSetRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DeleteTaskSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#ServiceNotActiveException" + }, + { + "target": "com.amazonaws.ecs#ServiceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#TaskSetNotFoundException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a specified task set within a service. This is used when a service uses the\n\t\t\t\tEXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset found in to delete.
", + "smithy.api#required": {} + } + }, + "service": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to\n\t\t\tdelete.
", + "smithy.api#required": {} + } + }, + "taskSet": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "If true, you can delete a task set even if it hasn't been scaled down to\n\t\t\tzero.
Details about the task set.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#Deployment": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID of the deployment.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the deployment. The following describes each state.
\nThe most recent deployment of a service.
\nA service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new PRIMARY deployment.
A deployment that has been completely replaced.
\nThe most recent task definition that was specified for the tasks in the service to\n\t\t\tuse.
" + } + }, + "desiredCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The most recent desired count of tasks that was specified for the service to deploy or\n\t\t\tmaintain.
" + } + }, + "pendingCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of tasks in the deployment that are in the PENDING\n\t\t\tstatus.
The number of tasks in the deployment that are in the RUNNING\n\t\t\tstatus.
The number of consecutively failed tasks in the deployment. A task is considered a\n\t\t\tfailure if the service scheduler can't launch the task, the task doesn't transition to a\n\t\t\t\tRUNNING state, or if it fails any of its defined health checks and is\n\t\t\tstopped.
Once a service deployment has one or more successfully running tasks, the failed\n\t\t\t\ttask count resets to zero and stops being evaluated.
\nThe Unix timestamp for the time when the service deployment was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the service deployment was last updated.
" + } + }, + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "The capacity provider strategy that the deployment is using.
" + } + }, + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", + "traits": { + "smithy.api#documentation": "The launch type the tasks in the service are using. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If one isn't specified,\n\t\t\tthe LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service, or tasks are running on. A\n\t\t\tplatform family is specified only for tasks using the Fargate launch type.
\n All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service, for example, \n\t\t\tLINUX..
The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.
The rolloutState of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS) deployment type that aren't behind a\n\t\t\t\tClassic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS state. When the service reaches a steady state, the\n\t\t\tdeployment transitions to a COMPLETED state. If the service fails to reach\n\t\t\ta steady state and circuit breaker is turned on, the deployment transitions to a\n\t\t\t\tFAILED state. A deployment in FAILED state doesn't launch\n\t\t\tany new tasks. For more information, see DeploymentCircuitBreaker.
A description of the rollout state of a deployment.
" + } + }, + "serviceConnectConfiguration": { + "target": "com.amazonaws.ecs#ServiceConnectConfiguration", + "traits": { + "smithy.api#documentation": "The details of the Service Connect configuration that's used by this deployment.\n\t\t\tCompare the configuration between multiple deployments when troubleshooting issues with\n\t\t\tnew deployments.
\nThe configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "serviceConnectResources": { + "target": "com.amazonaws.ecs#ServiceConnectServiceResourceList", + "traits": { + "smithy.api#documentation": "The list of Service Connect resources that are associated with this deployment. Each\n\t\t\tlist entry maps a discovery name to a Cloud Map service name.
" + } + }, + "volumeConfigurations": { + "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", + "traits": { + "smithy.api#documentation": "The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tdifferent settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume\n\t\t\tmust match the name from the task definition.
The Fargate ephemeral storage settings for the deployment.
" + } + }, + "vpcLatticeConfigurations": { + "target": "com.amazonaws.ecs#VpcLatticeConfigurations", + "traits": { + "smithy.api#documentation": "The VPC Lattice configuration for the service deployment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of an Amazon ECS service deployment. This is used only when a service uses the\n\t\t\t\tECS deployment controller type.
One or more CloudWatch alarm names. Use a \",\" to separate the alarms.
", + "smithy.api#required": {} + } + }, + "rollback": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is used, when a service deployment fails, the service is rolled back\n\t\t\tto the last deployment that completed successfully.
", + "smithy.api#required": {} + } + }, + "enable": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Determines whether to use the CloudWatch alarm option in the service deployment\n\t\t\tprocess.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "One of the methods which provide a way for you to quickly identify when a deployment\n\t\t\thas failed, and then to optionally roll back the failure to the last working\n\t\t\tdeployment.
\nWhen the alarms are generated, Amazon ECS sets the service deployment to failed. Set the\n\t\t\trollback parameter to have Amazon ECS to roll back your service to the last completed\n\t\t\tdeployment after a failure.
\nYou can only use the DeploymentAlarms method to detect failures when the\n\t\t\t\tDeploymentController is set to ECS (rolling\n\t\t\tupdate).
For more information, see Rolling\n\t\t\t\tupdate in the \n Amazon Elastic Container Service Developer Guide\n .
" + } + }, + "com.amazonaws.ecs#DeploymentCircuitBreaker": { + "type": "structure", + "members": { + "enable": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Determines whether to use the deployment circuit breaker logic for the service.
", + "smithy.api#required": {} + } + }, + "rollback": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is on, when a service deployment fails, the service is rolled back to\n\t\t\tthe last deployment that completed successfully.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If it is turned\n\t\t\ton, a service deployment will transition to a failed state and stop launching new tasks.\n\t\t\tYou can also configure Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.
\nFor more information about API failure reasons, see API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#DeploymentConfiguration": { + "type": "structure", + "members": { + "deploymentCircuitBreaker": { + "target": "com.amazonaws.ecs#DeploymentCircuitBreaker", + "traits": { + "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If you use the\n\t\t\tdeployment circuit breaker, a service deployment will transition to a failed state and\n\t\t\tstop launching new tasks. If you use the rollback option, when a service deployment\n\t\t\tfails, the service is rolled back to the last deployment that completed successfully.\n\t\t\tFor more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer\n\t\t\t\tGuide\n
" + } + }, + "maximumPercent": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximumPercent parameter represents an upper limit on the number of\n\t\t\tyour service's tasks that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the\n\t\t\t\tdesiredCount (rounded down to the nearest integer). This parameter\n\t\t\tenables you to define the deployment batch size. For example, if your service is using\n\t\t\tthe REPLICA service scheduler and has a desiredCount of four\n\t\t\ttasks and a maximumPercent value of 200%, the scheduler may start four new\n\t\t\ttasks before stopping the four older tasks (provided that the cluster resources required\n\t\t\tto do this are available). The default maximumPercent value for a service\n\t\t\tusing the REPLICA service scheduler is 200%.
The Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting\n\t\t\treplacement tasks first and then stopping the unhealthy tasks, as long as cluster\n\t\t\tresources for starting replacement tasks are available. For more information about how\n\t\t\tthe scheduler replaces unhealthy tasks, see Amazon ECS\n\t\t\tservices.
\nIf a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types, and tasks in the service use the\n\t\t\tEC2 launch type, the maximum percent\n\t\t\tvalue is set to the default value. The maximum percent\n\t\t\tvalue is used to define the upper limit on the number of the tasks in the service that\n\t\t\tremain in the RUNNING state while the container instances are in the\n\t\t\t\tDRAINING state.
You can't specify a custom maximumPercent value for a service that\n\t\t\t\tuses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\t\tdeployment types and has tasks that use the EC2 launch type.
If the service uses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types, and the tasks in the service use the Fargate launch type, the maximum\n\t\t\tpercent value is not used. The value is still returned when describing your service.
If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimumHealthyPercent represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the RUNNING state during a deployment,\n\t\t\tas a percentage of the desiredCount (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a desiredCount of four tasks and a\n\t\t\t\tminimumHealthyPercent of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks.
If any tasks are unhealthy and if maximumPercent doesn't allow the Amazon ECS\n\t\t\tscheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one\n\t\t\t— using the minimumHealthyPercent as a constraint — to clear up capacity to\n\t\t\tlaunch replacement tasks. For more information about how the scheduler replaces\n\t\t\tunhealthy tasks, see Amazon ECS services .
For services that do not use a load balancer, the following\n\t\t\tshould be noted:
\nA service is considered healthy if all essential containers within the tasks\n\t\t\t\t\tin the service pass their health checks.
\nIf a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for 40 seconds after a task reaches a RUNNING\n\t\t\t\t\tstate before the task is counted towards the minimum healthy percent\n\t\t\t\t\ttotal.
If a task has one or more essential containers with a health check defined,\n\t\t\t\t\tthe service scheduler will wait for the task to reach a healthy status before\n\t\t\t\t\tcounting it towards the minimum healthy percent total. A task is considered\n\t\t\t\t\thealthy when all essential containers within the task have passed their health\n\t\t\t\t\tchecks. The amount of time the service scheduler can wait for is determined by\n\t\t\t\t\tthe container health check settings.
\nFor services that do use a load balancer, the following should be\n\t\t\tnoted:
\nIf a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for the load balancer target group health check to return a\n\t\t\t\t\thealthy status before counting the task towards the minimum healthy percent\n\t\t\t\t\ttotal.
\nIf a task has an essential container with a health check defined, the service\n\t\t\t\t\tscheduler will wait for both the task to reach a healthy status and the load\n\t\t\t\t\tbalancer target group health check to return a healthy status before counting\n\t\t\t\t\tthe task towards the minimum healthy percent total.
\nThe default value for a replica service for minimumHealthyPercent is\n\t\t\t100%. The default minimumHealthyPercent value for a service using the\n\t\t\t\tDAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the\n\t\t\tAPIs and 50% for the Amazon Web Services Management Console.
The minimum number of healthy tasks during a deployment is the\n\t\t\t\tdesiredCount multiplied by the minimumHealthyPercent/100,\n\t\t\trounded up to the nearest integer value.
If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the minimum healthy\n\t\t\t\tpercent value is set to the default value. The minimum healthy percent value is used to define the lower limit on the\n\t\t\tnumber of the tasks in the service that remain in the RUNNING state while\n\t\t\tthe container instances are in the DRAINING state.
You can't specify a custom minimumHealthyPercent value for a service\n\t\t\t\tthat uses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\t\tdeployment types and has tasks that use the EC2 launch type.
If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tFargate launch type, the minimum healthy percent value is not used,\n\t\t\talthough it is returned when describing your service.
Information about the CloudWatch alarms.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during a deployment and\n\t\t\tthe ordering of stopping and starting tasks.
" + } + }, + "com.amazonaws.ecs#DeploymentController": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.ecs#DeploymentControllerType", + "traits": { + "smithy.api#documentation": "The deployment controller type to use.
\nThere are three deployment controller types available:
\nThe rolling update (ECS) deployment type involves replacing\n\t\t\t\t\t\tthe current running version of the container with the latest version. The\n\t\t\t\t\t\tnumber of containers Amazon ECS adds or removes from the service during a rolling\n\t\t\t\t\t\tupdate is controlled by adjusting the minimum and maximum number of healthy\n\t\t\t\t\t\ttasks allowed during a service deployment, as specified in the DeploymentConfiguration.
For more information about rolling deployments, see Deploy\n\t\t\t\t\t\t\tAmazon ECS services by replacing tasks in the Amazon Elastic Container Service Developer Guide.
\nThe blue/green (CODE_DEPLOY) deployment type uses the\n\t\t\t\t\t\tblue/green deployment model powered by CodeDeploy, which allows you to verify a\n\t\t\t\t\t\tnew deployment of a service before sending production traffic to it.
For more information about blue/green deployments, see Validate the state of an Amazon ECS service before deployment in\n\t\t\t\t\t\tthe Amazon Elastic Container Service Developer Guide.
\nThe external (EXTERNAL) deployment type enables you to use\n\t\t\t\t\t\tany third-party deployment controller for full control over the deployment\n\t\t\t\t\t\tprocess for an Amazon ECS service.
For more information about external deployments, see Deploy Amazon ECS services using a third-party controller in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
\nThe deployment controller to use for the service.
" + } + }, + "com.amazonaws.ecs#DeploymentControllerType": { + "type": "enum", + "members": { + "ECS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS" + } + }, + "CODE_DEPLOY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODE_DEPLOY" + } + }, + "EXTERNAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL" + } + } + } + }, + "com.amazonaws.ecs#DeploymentEphemeralStorage": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Specify an Key Management Service key ID to encrypt the ephemeral storage for\n\t\t\tdeployment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The amount of ephemeral storage to allocate for the deployment.
" + } + }, + "com.amazonaws.ecs#DeploymentRolloutState": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + } + } + }, + "com.amazonaws.ecs#Deployments": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Deployment" + } + }, + "com.amazonaws.ecs#DeregisterContainerInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DeregisterContainerInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DeregisterContainerInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.
\nIf you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.
\nDeregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.
\nIf you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).
\nThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tderegister. If you do not specify a cluster, the default cluster is assumed.
" + } + }, + "containerInstance": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The container instance ID or full ARN of the container instance to deregister. For\n\t\t\tmore information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Forces the container instance to be deregistered. If you have tasks running on the\n\t\t\tcontainer instance when you deregister it with the force option, these\n\t\t\ttasks remain running until you terminate the instance or the tasks stop through some\n\t\t\tother means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an\n\t\t\torphaned task on your container instance is part of an Amazon ECS service, then the service\n\t\t\tscheduler starts another copy of that task, on a different container instance if\n\t\t\tpossible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n\t\t\ttarget group are deregistered. They begin connection draining according to the settings\n\t\t\ton the load balancer or target group.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DeregisterContainerInstanceResponse": { + "type": "structure", + "members": { + "containerInstance": { + "target": "com.amazonaws.ecs#ContainerInstance", + "traits": { + "smithy.api#documentation": "The container instance that was deregistered.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DeregisterTaskDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DeregisterTaskDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DeregisterTaskDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as INACTIVE. Existing tasks and services that\n\t\t\treference an INACTIVE task definition continue to run without disruption.\n\t\t\tExisting services that reference an INACTIVE task definition can still\n\t\t\tscale up or down by modifying the service's desired count. If you want to delete a task\n\t\t\tdefinition revision, you must first deregister the task definition revision.
You can't use an INACTIVE task definition to run new tasks or create new\n\t\t\tservices, and you can't update an existing service to reference an INACTIVE\n\t\t\ttask definition. However, there may be up to a 10-minute window following deregistration\n\t\t\twhere these restrictions have not yet taken effect.
At this time, INACTIVE task definitions remain discoverable in your\n\t\t\t\taccount indefinitely. However, this behavior is subject to change in the future. We\n\t\t\t\tdon't recommend that you rely on INACTIVE task definitions persisting\n\t\t\t\tbeyond the lifecycle of any associated tasks and services.
You must deregister a task definition revision before you delete it. For more\n\t\t\tinformation, see DeleteTaskDefinitions.
", + "smithy.api#examples": [ + { + "title": "To deregister a revision of a task definition", + "documentation": "This example deregisters the first revision of the curler task definition", + "input": { + "taskDefinition": "curler:1" + }, + "output": { + "taskDefinition": { + "status": "INACTIVE", + "family": "curler", + "volumes": [], + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/curler:1", + "containerDefinitions": [ + { + "environment": [], + "name": "curler", + "mountPoints": [], + "image": "curl:latest", + "cpu": 100, + "portMappings": [], + "entryPoint": [], + "memory": 256, + "command": [ + "curl -v http://example.com/" + ], + "essential": true, + "volumesFrom": [] + } + ], + "revision": 1 + } + } + } + ] + } + }, + "com.amazonaws.ecs#DeregisterTaskDefinitionRequest": { + "type": "structure", + "members": { + "taskDefinition": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull Amazon Resource Name (ARN) of the task definition to deregister. You must specify a\n\t\t\t\trevision.
The full description of the deregistered task.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DescribeCapacityProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DescribeCapacityProvidersRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DescribeCapacityProvidersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Describes one or more of your capacity providers.
", + "smithy.api#examples": [ + { + "title": "To describe a specific capacity provider", + "documentation": "This example retrieves details about the capacity provider MyCapacityProvider", + "input": { + "capacityProviders": [ + "MyCapacityProvider" + ], + "include": [ + "TAGS" + ] + }, + "output": { + "capacityProviders": [ + { + "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider", + "name": "MyCapacityProvider", + "status": "ACTIVE", + "autoScalingGroupProvider": { + "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup", + "managedScaling": { + "status": "ENABLED", + "targetCapacity": 100, + "minimumScalingStepSize": 1, + "maximumScalingStepSize": 1000 + }, + "managedTerminationProtection": "ENABLED" + }, + "tags": [ + { + "key": "environment", + "value": "production" + } + ] + } + ] + } + }, + { + "title": "To describe all capacity providers", + "documentation": "This example retrieves details about all capacity providers. ", + "output": { + "capacityProviders": [ + { + "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider", + "name": "MyCapacityProvider", + "status": "ACTIVE", + "autoScalingGroupProvider": { + "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup", + "managedScaling": { + "status": "ENABLED", + "targetCapacity": 100, + "minimumScalingStepSize": 1, + "maximumScalingStepSize": 1000 + }, + "managedTerminationProtection": "ENABLED" + }, + "tags": [] + }, + { + "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE", + "name": "FARGATE", + "status": "ACTIVE", + "tags": [] + }, + { + "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE_SPOT", + "name": "FARGATE_SPOT", + "status": "ACTIVE", + "tags": [] + } + ] + } + } + ] + } + }, + "com.amazonaws.ecs#DescribeCapacityProvidersRequest": { + "type": "structure", + "members": { + "capacityProviders": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to\n\t\t\t\t100 capacity providers can be described in an action.
Specifies whether or not you want to see the resource tags for the capacity provider.\n\t\t\tIf TAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.
The maximum number of account setting results returned by\n\t\t\t\tDescribeCapacityProviders in paginated output. When this parameter is\n\t\t\tused, DescribeCapacityProviders only returns maxResults\n\t\t\tresults in a single page along with a nextToken response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\tDescribeCapacityProviders request with the returned\n\t\t\t\tnextToken value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then DescribeCapacityProviders returns up to\n\t\t\t10 results and a nextToken value\n\t\t\tif applicable.
The nextToken value returned from a previous paginated\n\t\t\t\tDescribeCapacityProviders request where maxResults was\n\t\t\tused and the results exceeded the value of that parameter. Pagination continues from the\n\t\t\tend of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of capacity providers.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future\n\t\t\t\tDescribeCapacityProviders request. When the results of a\n\t\t\t\tDescribeCapacityProviders request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null\n\t\t\twhen there are no more results to return.
Describes one or more of your clusters.
\nFor CLI examples, see describe-clusters.rst on GitHub.
", + "smithy.api#examples": [ + { + "title": "To describe a cluster", + "documentation": "This example provides a description of the specified cluster in your default region.", + "input": { + "clusters": [ + "default" + ] + }, + "output": { + "clusters": [ + { + "clusterName": "default", + "status": "ACTIVE", + "clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster/default" + } + ], + "failures": [] + } + } + ] + } + }, + "com.amazonaws.ecs#DescribeClustersRequest": { + "type": "structure", + "members": { + "clusters": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + } + }, + "include": { + "target": "com.amazonaws.ecs#ClusterFieldList", + "traits": { + "smithy.api#documentation": "Determines whether to include additional information about the clusters in the\n\t\t\tresponse. If this field is omitted, this information isn't included.
\nIf ATTACHMENTS is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included, for example the capacity providers.
If SETTINGS is specified, the settings for the cluster are\n\t\t\tincluded.
If CONFIGURATIONS is specified, the configuration for the cluster is\n\t\t\tincluded.
If STATISTICS is specified, the task and service count is included,\n\t\t\tseparated by launch type.
If TAGS is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.
The list of clusters.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DescribeContainerInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DescribeContainerInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DescribeContainerInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Describes one or more container instances. Returns metadata about each container\n\t\t\tinstance requested.
", + "smithy.api#examples": [ + { + "title": "To describe container instance", + "documentation": "This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.", + "input": { + "cluster": "default", + "containerInstances": [ + "f2756532-8f13-4d53-87c9-aed50dc94cd7" + ] + }, + "output": { + "failures": [], + "containerInstances": [ + { + "status": "ACTIVE", + "registeredResources": [ + { + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "integerValue": 2048, + "name": "CPU" + }, + { + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "integerValue": 3768, + "name": "MEMORY" + }, + { + "name": "PORTS", + "longValue": 0, + "doubleValue": 0.0, + "stringSetValue": [ + "2376", + "22", + "51678", + "2375" + ], + "type": "STRINGSET", + "integerValue": 0 + } + ], + "ec2InstanceId": "i-807f3249", + "agentConnected": true, + "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/default/f2756532-8f13-4d53-87c9-aed50dc94cd7", + "pendingTasksCount": 0, + "remainingResources": [ + { + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "integerValue": 1948, + "name": "CPU" + }, + { + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "integerValue": 3668, + "name": "MEMORY" + }, + { + "name": "PORTS", + "longValue": 0, + "doubleValue": 0.0, + "stringSetValue": [ + "2376", + "22", + "80", + "51678", + "2375" + ], + "type": "STRINGSET", + "integerValue": 0 + } + ], + "runningTasksCount": 1 + } + ] + } + } + ] + } + }, + "com.amazonaws.ecs#DescribeContainerInstancesRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance\n\t\t\tor container instances you are describing were launched in any cluster other than the\n\t\t\tdefault cluster.
" + } + }, + "containerInstances": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
", + "smithy.api#required": {} + } + }, + "include": { + "target": "com.amazonaws.ecs#ContainerInstanceFieldList", + "traits": { + "smithy.api#documentation": "Specifies whether you want to see the resource tags for the container instance. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If\n\t\t\t\tCONTAINER_INSTANCE_HEALTH is specified, the container instance health\n\t\t\tis included in the response. If this field is omitted, tags and container instance\n\t\t\thealth status aren't included in the response.
The list of container instances.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DescribeServiceDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DescribeServiceDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DescribeServiceDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#ServiceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + } + ], + "traits": { + "smithy.api#documentation": "Describes one or more of your service deployments.
\nA service deployment happens when you release a software update for the service. For\n\t\t\tmore information, see Amazon ECS service\n\t\t\t\tdeployments.
" + } + }, + "com.amazonaws.ecs#DescribeServiceDeploymentsRequest": { + "type": "structure", + "members": { + "serviceDeploymentArns": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The ARN of the service deployment.
\nYou can specify a maximum of 20 ARNs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DescribeServiceDeploymentsResponse": { + "type": "structure", + "members": { + "serviceDeployments": { + "target": "com.amazonaws.ecs#ServiceDeployments", + "traits": { + "smithy.api#documentation": "The list of service deployments described.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
\nIf you decsribe a deployment with a service revision created before October 25, 2024,\n\t\t\tthe call fails. The failure includes the service revision ARN and the reason set to\n\t\t\t\tMISSING.
Describes one or more service revisions.
\nA service revision is a version of the service that includes the values for the Amazon\n\t\t\tECS resources (for example, task definition) and the environment resources (for example,\n\t\t\tload balancers, subnets, and security groups). For more information, see Amazon ECS service revisions.
\nYou can't describe a service revision that was created before October 25, 2024.
" + } + }, + "com.amazonaws.ecs#DescribeServiceRevisionsRequest": { + "type": "structure", + "members": { + "serviceRevisionArns": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The ARN of the service revision.
\nYou can specify a maximum of 20 ARNs.
\nYou can call ListServiceDeployments to get the ARNs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DescribeServiceRevisionsResponse": { + "type": "structure", + "members": { + "serviceRevisions": { + "target": "com.amazonaws.ecs#ServiceRevisions", + "traits": { + "smithy.api#documentation": "The list of service revisions described.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DescribeServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DescribeServicesRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DescribeServicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the specified services running in your cluster.
", + "smithy.api#examples": [ + { + "title": "To describe a service", + "documentation": "This example provides descriptive information about the service named ``ecs-simple-service``.", + "input": { + "services": [ + "ecs-simple-service" + ] + }, + "output": { + "failures": [], + "services": [ + { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:25:52.130Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:25:52.130Z", + "desiredCount": 1, + "id": "ecs-svc/9223370564341623665", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:25:52.130Z" + } + ], + "desiredCount": 1, + "events": [ + { + "createdAt": "2016-08-29T16:25:58.520Z", + "id": "38c285e5-d335-4b68-8b15-e46dedc8e88d", + "message": "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide." + } + ], + "loadBalancers": [], + "pendingCount": 0, + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", + "serviceName": "ecs-simple-service", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6" + } + ] + } + } + ], + "smithy.waiters#waitable": { + "ServicesInactive": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "failures[].reason", + "expected": "MISSING", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "services[].status", + "expected": "INACTIVE", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ServicesStable": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "failures[].reason", + "expected": "MISSING", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "services[].status", + "expected": "DRAINING", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "services[].status", + "expected": "INACTIVE", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "length(services[?!(length(deployments) == `1` && runningCount == desiredCount)]) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ecs#DescribeServicesRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are\n\t\t\tdescribing were launched in any cluster other than the default cluster.
" + } + }, + "services": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "A list of services to describe. You may specify up to 10 services to describe in a\n\t\t\tsingle operation.
", + "smithy.api#required": {} + } + }, + "include": { + "target": "com.amazonaws.ecs#ServiceFieldList", + "traits": { + "smithy.api#documentation": "Determines whether you want to see the resource tags for the service. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.
The list of services described.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DescribeTaskDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DescribeTaskDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DescribeTaskDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a task definition. You can specify a family and\n\t\t\t\trevision to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest ACTIVE revision in that\n\t\t\tfamily.
You can only describe INACTIVE task definitions while an active task\n\t\t\t\tor service references them.
The family for the latest ACTIVE revision,\n\t\t\t\tfamily and revision (family:revision) for a\n\t\t\tspecific revision in the family, or full Amazon Resource Name (ARN) of the task definition to\n\t\t\tdescribe.
Determines whether to see the resource tags for the task definition. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.
The full task definition description.
" + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The metadata that's applied to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Describes the task sets in the specified cluster and service. This is used when a\n\t\t\tservice uses the EXTERNAL deployment controller type. For more information,\n\t\t\tsee Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", + "smithy.api#required": {} + } + }, + "service": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
", + "smithy.api#required": {} + } + }, + "taskSets": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The ID or full Amazon Resource Name (ARN) of task sets to\n\t\t\tdescribe.
" + } + }, + "include": { + "target": "com.amazonaws.ecs#TaskSetFieldList", + "traits": { + "smithy.api#documentation": "Specifies whether to see the resource tags for the task set. If TAGS is\n\t\t\tspecified, the tags are included in the response. If this field is omitted, tags aren't\n\t\t\tincluded in the response.
The list of task sets described.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DescribeTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DescribeTasksRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DescribeTasksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a specified task or tasks.
\nCurrently, stopped tasks appear in the returned results for at least one hour.
\nIf you have tasks with tags, and then delete the cluster, the tagged tasks are\n\t\t\treturned in the response. If you create a new cluster with the same name as the deleted\n\t\t\tcluster, the tagged tasks are not included in the response.
", + "smithy.api#examples": [ + { + "title": "To describe a task", + "documentation": "This example provides a description of the specified task, using the task UUID as an identifier.", + "input": { + "tasks": [ + "c5cba4eb-5dad-405e-96db-71ef8eefe6a8" + ] + }, + "output": { + "failures": [], + "tasks": [ + { + "taskArn": "arn:aws:ecs:The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required. If you do not specify a\n\t\t\tvalue, the default cluster is used.
A list of up to 100 task IDs or full ARN entries.
", + "smithy.api#required": {} + } + }, + "include": { + "target": "com.amazonaws.ecs#TaskFieldList", + "traits": { + "smithy.api#documentation": "Specifies whether you want to see the resource tags for the task. If TAGS\n\t\t\tis specified, the tags are included in the response. If this field is omitted, tags\n\t\t\taren't included in the response.
The list of tasks.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DesiredStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.ecs#Device": { + "type": "structure", + "members": { + "hostPath": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The path for the device on the host container instance.
", + "smithy.api#required": {} + } + }, + "containerPath": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The path inside the container at which to expose the host device.
" + } + }, + "permissions": { + "target": "com.amazonaws.ecs#DeviceCgroupPermissions", + "traits": { + "smithy.api#documentation": "The explicit permissions to provide to the container for the device. By default, the\n\t\t\tcontainer has permissions for read, write, and\n\t\t\t\tmknod for the device.
An object representing a container instance host device.
" + } + }, + "com.amazonaws.ecs#DeviceCgroupPermission": { + "type": "enum", + "members": { + "READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "read" + } + }, + "WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "write" + } + }, + "MKNOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mknod" + } + } + } + }, + "com.amazonaws.ecs#DeviceCgroupPermissions": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#DeviceCgroupPermission" + } + }, + "com.amazonaws.ecs#DevicesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Device" + } + }, + "com.amazonaws.ecs#DiscoverPollEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DiscoverPollEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DiscoverPollEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nReturns an endpoint for the Amazon ECS agent to poll for updates.
" + } + }, + "com.amazonaws.ecs#DiscoverPollEndpointRequest": { + "type": "structure", + "members": { + "containerInstance": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The container instance ID or full ARN of the container instance. For more\n\t\t\tinformation about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" + } + }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs\n\t\t\tto.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DiscoverPollEndpointResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The endpoint for the Amazon ECS agent to poll.
" + } + }, + "telemetryEndpoint": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The telemetry endpoint for the Amazon ECS agent.
" + } + }, + "serviceConnectEndpoint": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The endpoint for the Amazon ECS agent to poll for Service Connect configuration.\n\t\t\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#DockerLabelsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.ecs#String" + }, + "value": { + "target": "com.amazonaws.ecs#String" + } + }, + "com.amazonaws.ecs#DockerVolumeConfiguration": { + "type": "structure", + "members": { + "scope": { + "target": "com.amazonaws.ecs#Scope", + "traits": { + "smithy.api#documentation": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are\n\t\t\tscoped to a task are automatically provisioned when the task starts and\n\t\t\tdestroyed when the task stops. Docker volumes that are scoped as shared\n\t\t\tpersist after the task stops.
If this value is true, the Docker volume is created if it doesn't already\n\t\t\texist.
This field is only used if the scope is shared.
The Docker volume driver to use. The driver value must match the driver name provided\n\t\t\tby Docker because it is used for task placement. If the driver was installed using the\n\t\t\tDocker plugin CLI, use docker plugin ls to retrieve the driver name from\n\t\t\tyour container instance. If the driver was installed using another method, use Docker\n\t\t\tplugin discovery to retrieve the driver name. This parameter maps to Driver\n\t\t\tin the docker container create command and the xxdriver option to docker\n\t\t\tvolume create.
A map of Docker driver-specific options passed through. This parameter maps to\n\t\t\t\tDriverOpts in the docker create-volume command and the\n\t\t\t\txxopt option to docker volume create.
Custom metadata to add to your Docker volume. This parameter maps to\n\t\t\t\tLabels in the docker container create command and the\n\t\t\t\txxlabel option to docker volume create.
This parameter is specified when you're using Docker volumes. Docker volumes are only\n\t\t\tsupported when you're using the EC2 launch type. Windows containers only\n\t\t\tsupport the use of the local driver. To use bind mounts, specify a\n\t\t\t\thost instead.
The type of volume resource.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The tags applied to this Amazon EBS volume. AmazonECSCreated and\n\t\t\t\tAmazonECSManaged are reserved tags that can't be used.
Determines whether to propagate the tags from the task definition to \u2028the Amazon EBS\n\t\t\tvolume. Tags can only propagate to a SERVICE specified in\n\t\t\t\t\u2028ServiceVolumeConfiguration. If no value is specified, the tags aren't\n\t\t\t\u2028propagated.
The tag specifications of an Amazon EBS volume.
" + } + }, + "com.amazonaws.ecs#EBSTagSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#EBSTagSpecification" + } + }, + "com.amazonaws.ecs#EBSVolumeType": { + "type": "string" + }, + "com.amazonaws.ecs#ECSVolumeName": { + "type": "string" + }, + "com.amazonaws.ecs#EFSAuthorizationConfig": { + "type": "structure", + "members": { + "accessPointId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the EFSVolumeConfiguration must either be omitted or set\n\t\t\tto / which will enforce the path set on the EFS access point. If an access\n\t\t\tpoint is used, transit encryption must be on in the EFSVolumeConfiguration.\n\t\t\tFor more information, see Working with Amazon EFS access\n\t\t\t\tpoints in the Amazon Elastic File System User Guide.
Determines whether to use the Amazon ECS task role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on\n\t\t\tin the EFSVolumeConfiguration. If this parameter is omitted, the default\n\t\t\tvalue of DISABLED is used. For more information, see Using\n\t\t\t\tAmazon EFS access points in the Amazon Elastic Container Service Developer Guide.
The authorization configuration details for the Amazon EFS file system.
" + } + }, + "com.amazonaws.ecs#EFSAuthorizationConfigIAM": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.ecs#EFSTransitEncryption": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.ecs#EFSVolumeConfiguration": { + "type": "structure", + "members": { + "fileSystemId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon EFS file system ID to use.
", + "smithy.api#required": {} + } + }, + "rootDirectory": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The directory within the Amazon EFS file system to mount as the root directory inside the\n\t\t\thost. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n\t\t\tSpecifying / will have the same effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the\n\t\t\t\troot directory parameter must either be omitted or set to / which will\n\t\t\t\tenforce the path set on the EFS access point.
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host\n\t\t\tand the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization\n\t\t\tis used. If this parameter is omitted, the default value of DISABLED is\n\t\t\tused. For more information, see Encrypting data in transit in\n\t\t\tthe Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n\t\t\tserver. If you do not specify a transit encryption port, it will use the port selection\n\t\t\tstrategy that the Amazon EFS mount helper uses. For more information, see EFS mount\n\t\t\t\thelper in the Amazon Elastic File System User Guide.
" + } + }, + "authorizationConfig": { + "target": "com.amazonaws.ecs#EFSAuthorizationConfig", + "traits": { + "smithy.api#documentation": "The authorization configuration details for the Amazon EFS file system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This parameter is specified when you're using an Amazon Elastic File System file system for task\n\t\t\tstorage. For more information, see Amazon EFS volumes in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#EnvironmentFile": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment\n\t\t\tvariable file.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.ecs#EnvironmentFileType", + "traits": { + "smithy.api#documentation": "The file type to use. Environment files are objects in Amazon S3. The only supported value\n\t\t\tis s3.
A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored.
If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Use a file to pass\n\t\t\t\tenvironment variables to a container in the Amazon Elastic Container Service Developer Guide.
Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations\n\t\t\tapply.
\nYou must use the following platforms for the Fargate launch type:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
Consider the following when using the Fargate launch type:
\nThe file is handled like a native Docker env-file.
\nThere is no support for shell escape handling.
\nThe container entry point interperts the VARIABLE values.
The total amount, in GiB, of ephemeral storage to set for the task. The minimum\n\t\t\tsupported value is 21 GiB and the maximum supported value is\n\t\t\t\t200 GiB.
The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in\n\t\t\t\ttasks in the Amazon ECS Developer Guide;.
\nFor tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
Runs a command remotely on a container within a task.
\nIf you use a condition key in your IAM policy to refine the conditions for the\n\t\t\tpolicy statement, for example limit the actions to a specific cluster, you receive an\n\t\t\t\tAccessDeniedException when there is a mismatch between the condition\n\t\t\tkey value and the corresponding parameter value.
For information about required permissions and considerations, see Using Amazon ECS\n\t\t\t\tExec for debugging in the Amazon ECS Developer Guide.\n\t\t
", + "smithy.api#examples": [ + { + "title": "To run a command remotely on a container in a task", + "documentation": "This example runs an interactive /bin/sh command on a container MyContainer. ", + "input": { + "cluster": "MyCluster", + "container": "MyContainer", + "command": "/bin/sh", + "interactive": true, + "task": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE" + }, + "output": { + "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster", + "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE/43ba4b77-37f7-4a41-b923-69d4abEXAMPLE", + "containerName": "MyContainer", + "interactive": true, + "session": { + "sessionId": "ecs-execute-command-794nnsxobsg4p2hiur6gxu9a9e", + "streamUrl": "wss://ssmmessages.us-east-1.amazonaws.com/v1/data-channel/ecs-execute-command-794nnsxobsg4p2hiur6gxu9a9e?role=publish_subscribe&cell-number=AAEAAfiZG4oybxqsYj3Zhm15s4J0W1k7d9nxVRenNO8Kl5nzAAAAAGdbWGl479/y/4IrTWPadUic3eBrMu3vmB7aPvI+s12lbpDc142y1KZy", + "tokenValue": "AAEAAcVb7ww10N9aNUI5Cl7K7DbHjbD2Ed4Mw6uaGYIc+UFNAAAAAGdbWGmMDaPbGfDkzrVIhyKEsc4CPT2hcToPU6yzlddPm7rRZvYQtpaAgsvQdjbCAd9OB6ohtDYfqZI9gzMqLKegXq0E+KbDcGPnQVODFNHmQxnR1BvC6vNcHqh6HAJuKnQD7RSYx/J5bfYNHj4hCYHuN0HNcueSDOOTRB/MBt5DBDY7Djv2uzs9FD0N1kcsGljZkZWLuPTVKHHyrU3zh0awfrFFC3RXvgaUCBnloIIvZeq2CjTesxn9JJS+3N4I0DVxfkHdWWBbBY/5+wH82JVTJpqN3yOAt74u/W7TvYBd7Xu2lQbvtpuAnEszl++bFG2ZoV3dfnmBkSnfD/qV1FJcEskbxUHKgmqe0Paouv4zwrQKNfWYfcv9xkWskqcExh07IeaxZz1tp/WegZ5D76sD6xYeuH+35TMNXMoY7oudLgxIXsA7b39ElM7orGi4Jy3W2tLyuNIvDoI2JI6ww4tYdEjYZnld9rhKwV9rDHk1Z8wjHMs++3BIkHrFQRsv7BFUWlZ9lyqO9GWlXeBe7dQtOeFNahBuJUE9z/xLHJn1x13VkdROKqUVHTJrT4sXAnI5roWiGPoQPVY7aHVYJnwjSxrPRWJBsgyHiVN3dAWTmeVMjp0VbOiJaLlpBI+AUWs8OeVRzuJSZ+1alETpK7Ukag7ma9K4lxq/N7IxYo2ub0cG/bvX42zQqdJAW+9St9sQ1QMaMvkSq1tdbLoOuY0QjN7JrkuKLFQA5bhs+o1YwItzIp7bNrzQ9Z9IN51qoGL5HDXQzi1kNFfYtAryhwt6BgtQU9Z0k+RpE+V5G+V68E0MMUvb313f0nRBYj1u5VKonWb708wADPbUU+s7nvbWuD5oLp1Z6A4iqI9Om0R4RrFASj/7fVY7r3raNXcIYA=" + }, + "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE" + } + } + ] + } + }, + "com.amazonaws.ecs#ExecuteCommandConfiguration": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Specify an Key Management Service key ID to encrypt the data between the local client\n\t\t\tand the container.
" + } + }, + "logging": { + "target": "com.amazonaws.ecs#ExecuteCommandLogging", + "traits": { + "smithy.api#documentation": "The log setting to use for redirecting logs for your execute command results. The\n\t\t\tfollowing log settings are available.
\n\n NONE: The execute command session is not logged.
\n DEFAULT: The awslogs configuration in the task\n\t\t\t\t\tdefinition is used. If no logging parameter is specified, it defaults to this\n\t\t\t\t\tvalue. If no awslogs log driver is configured in the task\n\t\t\t\t\tdefinition, the output won't be logged.
\n OVERRIDE: Specify the logging details as a part of\n\t\t\t\t\t\tlogConfiguration. If the OVERRIDE logging option\n\t\t\t\t\tis specified, the logConfiguration is required.
The log configuration for the results of the execute command actions. The logs can be\n\t\t\tsent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is\n\t\t\tspecified, a logConfiguration must be provided.
The details of the execute command configuration.
" + } + }, + "com.amazonaws.ecs#ExecuteCommandLogConfiguration": { + "type": "structure", + "members": { + "cloudWatchLogGroupName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the CloudWatch log group to send logs to.
\nThe CloudWatch log group must already be created.
\nDetermines whether to use encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be off.
" + } + }, + "s3BucketName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket to send logs to.
\nThe S3 bucket must already be created.
\nDetermines whether to use encryption on the S3 logs. If not specified, encryption is\n\t\t\tnot used.
" + } + }, + "s3KeyPrefix": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "An optional folder in the S3 bucket to place logs in.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The log configuration for the results of the execute command actions. The logs can be\n\t\t\tsent to CloudWatch Logs or an Amazon S3 bucket.
" + } + }, + "com.amazonaws.ecs#ExecuteCommandLogging": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDE" + } + } + } + }, + "com.amazonaws.ecs#ExecuteCommandRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) or short name of the cluster the task is running in.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + } + }, + "container": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container to execute the command on. A container name only needs to be\n\t\t\tspecified for tasks containing multiple containers.
" + } + }, + "command": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The command to run on the container.
", + "smithy.api#required": {} + } + }, + "interactive": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Use this flag to run your command in interactive mode.
", + "smithy.api#required": {} + } + }, + "task": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) or ID of the task the container is part of.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#ExecuteCommandResponse": { + "type": "structure", + "members": { + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster.
" + } + }, + "containerArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container.
" + } + }, + "containerName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container.
" + } + }, + "interactive": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Determines whether the execute command session is running in interactive mode. Amazon ECS\n\t\t\tonly supports initiating interactive sessions, so you must specify true for\n\t\t\tthis value.
The details of the SSM session that was created for this instance of\n\t\t\texecute-command.
" + } + }, + "taskArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig": { + "type": "structure", + "members": { + "credentialsParameter": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The authorization credential option to use. The authorization credential options can\n\t\t\tbe provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store\n\t\t\tparameter. The ARN refers to the stored credentials.
", + "smithy.api#required": {} + } + }, + "domain": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on\n\t\t\tAmazon EC2.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API\n\t\t\t\tReference.
\nFor more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration": { + "type": "structure", + "members": { + "fileSystemId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon FSx for Windows File Server file system ID to use.
", + "smithy.api#required": {} + } + }, + "rootDirectory": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory\n\t\t\tinside the host.
", + "smithy.api#required": {} + } + }, + "authorizationConfig": { + "target": "com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig", + "traits": { + "smithy.api#documentation": "The authorization configuration details for the Amazon FSx for Windows File Server file system.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This parameter is specified when you're using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
\nFor more information and the input format, see Amazon FSx for Windows File Server volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#Failure": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the failed resource.
" + } + }, + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The reason for the failure.
" + } + }, + "detail": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The details of the failure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A failed resource. For a list of common causes, see API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#Failures": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Failure" + } + }, + "com.amazonaws.ecs#FirelensConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.ecs#FirelensConfigurationType", + "traits": { + "smithy.api#documentation": "The log router to use. The valid values are fluentd or\n\t\t\t\tfluentbit.
The options to use when configuring the log router. This field is optional and can be\n\t\t\tused to specify a custom configuration file or to add additional metadata, such as the\n\t\t\ttask, task definition, cluster, and container instance details to the log event. If\n\t\t\tspecified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}.\n\t\t\tFor more information, see Creating\n\t\t\t\ta task definition that uses a FireLens configuration in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file\n\t\t\t\ttype.
The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom log routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#FirelensConfigurationOptionsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.ecs#String" + }, + "value": { + "target": "com.amazonaws.ecs#String" + } + }, + "com.amazonaws.ecs#FirelensConfigurationType": { + "type": "enum", + "members": { + "FLUENTD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fluentd" + } + }, + "FLUENTBIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fluentbit" + } + } + } + }, + "com.amazonaws.ecs#GetTaskProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#GetTaskProtectionRequest" + }, + "output": { + "target": "com.amazonaws.ecs#GetTaskProtectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the protection status of tasks in an Amazon ECS service.
", + "smithy.api#examples": [ + { + "title": "To get the protection status of a task", + "documentation": "In this example, we get the protection status for a single task.", + "input": { + "cluster": "test-task-protection", + "tasks": [ + "b8b1cf532d0e46ba8d44a40d1de16772" + ] + }, + "output": { + "protectedTasks": [ + { + "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772", + "protectionEnabled": true, + "expirationDate": "2022-11-02T06:56:32.553Z" + } + ], + "failures": [] + } + } + ] + } + }, + "com.amazonaws.ecs#GetTaskProtectionRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", + "smithy.api#required": {} + } + }, + "tasks": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "A list of up to 100 task IDs or full ARN entries.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#GetTaskProtectionResponse": { + "type": "structure", + "members": { + "protectedTasks": { + "target": "com.amazonaws.ecs#ProtectedTasks", + "traits": { + "smithy.api#documentation": "A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is turned on for a task, the value is true. Otherwise,\n\t\t\t\t\tit is false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#GpuIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#String" + } + }, + "com.amazonaws.ecs#HealthCheck": { + "type": "structure", + "members": { + "command": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with CMD to run the command arguments\n\t\t\tdirectly, or CMD-SHELL to run the command with the container's default\n\t\t\tshell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list\n\t\t\tof commands in double quotes and brackets.
\n\n [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n
You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.
\n\n CMD-SHELL, curl -f http://localhost/ || exit 1\n
An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the docker container create\n\t\t\tcommand.
The time period in seconds between each health check execution. You may specify\n\t\t\tbetween 5 and 300 seconds. The default value is 30 seconds.
" + } + }, + "timeout": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The time period in seconds to wait for a health check to succeed before it is\n\t\t\tconsidered a failure. You may specify between 2 and 60 seconds. The default value is\n\t\t\t5.
" + } + }, + "retries": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The number of times to retry a failed health check before the container is considered\n\t\t\tunhealthy. You may specify between 1 and 10 retries. The default value is 3.
" + } + }, + "startPeriod": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The optional grace period to provide containers time to bootstrap before failed health\n\t\t\tchecks count towards the maximum number of retries. You can specify between 0 and 300\n\t\t\tseconds. By default, the startPeriod is off.
If a health check succeeds within the startPeriod, then the container\n\t\t\t\tis considered healthy and any subsequent failures count toward the maximum number of\n\t\t\t\tretries.
An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile). This configuration maps to the HEALTHCHECK parameter of docker\n\t\t\trun.
The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.
\nYou can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.
\nThe health check is designed to make sure that your containers survive agent restarts,\n\t\t\tupgrades, or temporary unavailability.
\nAmazon ECS performs health checks on containers with the default that launched the\n\t\t\tcontainer instance or the task.
\nThe following describes the possible healthStatus values for a\n\t\t\tcontainer:
\n HEALTHY-The container health check has passed\n\t\t\t\t\tsuccessfully.
\n UNHEALTHY-The container health check has failed.
\n UNKNOWN-The container health check is being evaluated,\n\t\t\t\t\tthere's no container health check defined, or Amazon ECS doesn't have the health\n\t\t\t\t\tstatus of the container.
The following describes the possible healthStatus values based on the\n\t\t\tcontainer health checker status of essential containers in the task with the following\n\t\t\tpriority order (high to low):
\n UNHEALTHY-One or more essential containers have failed\n\t\t\t\t\ttheir health check.
\n UNKNOWN-Any essential container running within the task is\n\t\t\t\t\tin an UNKNOWN state and no other essential containers have an\n\t\t\t\t\t\tUNHEALTHY state.
\n HEALTHY-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.
Consider the following task health example with 2 containers.
\nIf Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, the task health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, the task health is UNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tthe task health is UNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tthe task health is HEALTHY.
Consider the following task health example with 3 containers.
\nIf Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is UNKNOWN, the task health is\n\t\t\t\t\t\tUNHEALTHY.
If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.
If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tUNKNOWN.
If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is UNKNOWN, the task health is\n\t\t\t\t\tUNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tHEALTHY.
If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.
\nThe following are notes about container health check support:
\nIf the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this\n\t\t\t\t\twon't cause a container to transition to an UNHEALTHY status. This\n\t\t\t\t\tis by design, to ensure that containers remain running during agent restarts or\n\t\t\t\t\ttemporary unavailability. The health check status is the \"last heard from\"\n\t\t\t\t\tresponse from the Amazon ECS agent, so if the container was considered\n\t\t\t\t\t\tHEALTHY prior to the disconnect, that status will remain until\n\t\t\t\t\tthe agent reconnects and another health check occurs. There are no assumptions\n\t\t\t\t\tmade about the status of the container health checks.
Container health checks require version 1.17.0 or greater of the\n\t\t\t\t\tAmazon ECS container agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS container agent.
Container health checks are supported for Fargate tasks if\n\t\t\t\t\tyou're using platform version 1.1.0 or greater. For more\n\t\t\t\t\tinformation, see Fargate\n\t\t\t\t\t\tplatform versions.
Container health checks aren't supported for tasks that are part of a service\n\t\t\t\t\tthat's configured to use a Classic Load Balancer.
\nThe hostname to use in the /etc/hosts entry.
The IP address to use in the /etc/hosts entry.
Hostnames and IP address entries that are added to the /etc/hosts file of\n\t\t\ta container via the extraHosts parameter of its ContainerDefinition.
When the host parameter is used, specify a sourcePath to\n\t\t\tdeclare the path on the host container instance that's presented to the container. If\n\t\t\tthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n\t\t\t\thost parameter contains a sourcePath file location, then\n\t\t\tthe data volume persists at the specified location on the host container instance until\n\t\t\tyou delete it manually. If the sourcePath value doesn't exist on the host\n\t\t\tcontainer instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.
If you're using the Fargate launch type, the sourcePath\n\t\t\tparameter is not supported.
Details on a container instance bind mount host volume.
" + } + }, + "com.amazonaws.ecs#IAMRoleArn": { + "type": "string" + }, + "com.amazonaws.ecs#InferenceAccelerator": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Elastic Inference accelerator device name. The deviceName must also\n\t\t\tbe referenced in a container definition as a ResourceRequirement.
The Elastic Inference accelerator type to use.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#InferenceAcceleratorOverride": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Elastic Inference accelerator device name to override for the task. This parameter\n\t\t\tmust match a deviceName specified in the task definition.
The Elastic Inference accelerator type to use.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details on an Elastic Inference accelerator task override. This parameter is used to\n\t\t\toverride the Elastic Inference accelerator specified in the task definition. For more\n\t\t\tinformation, see Working with Amazon\n\t\t\t\tElastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#InferenceAcceleratorOverrides": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#InferenceAcceleratorOverride" + } + }, + "com.amazonaws.ecs#InferenceAccelerators": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#InferenceAccelerator" + } + }, + "com.amazonaws.ecs#InstanceHealthCheckResult": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.ecs#InstanceHealthCheckType", + "traits": { + "smithy.api#documentation": "The type of container instance health status that was verified.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#InstanceHealthCheckState", + "traits": { + "smithy.api#documentation": "The container instance health status.
" + } + }, + "lastUpdated": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for when the container instance health status was last\n\t\t\tupdated.
" + } + }, + "lastStatusChange": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for when the container instance health status last changed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the result of a container instance health status check.
" + } + }, + "com.amazonaws.ecs#InstanceHealthCheckResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#InstanceHealthCheckResult" + } + }, + "com.amazonaws.ecs#InstanceHealthCheckState": { + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" + } + }, + "IMPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPAIRED" + } + }, + "INSUFFICIENT_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_DATA" + } + }, + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + } + } + }, + "com.amazonaws.ecs#InstanceHealthCheckType": { + "type": "enum", + "members": { + "CONTAINER_RUNTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINER_RUNTIME" + } + } + } + }, + "com.amazonaws.ecs#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.ecs#IntegerList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#BoxedInteger" + } + }, + "com.amazonaws.ecs#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified parameter isn't valid. Review the available parameters for the API\n\t\t\trequest.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#IpcMode": { + "type": "enum", + "members": { + "HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + }, + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "task" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } + } + }, + "com.amazonaws.ecs#KernelCapabilities": { + "type": "structure", + "members": { + "add": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The Linux capabilities for the container that have been added to the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapAdd in the\n\t\t\tdocker container create command and the --cap-add option to docker\n\t\t\trun.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel\n\t\t\t\tcapability.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n
The Linux capabilities for the container that have been removed from the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapDrop in the\n\t\t\tdocker container create command and the --cap-drop option to docker\n\t\t\trun.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n
The Linux capabilities to add or remove from the default Docker configuration for a\n\t\t\tcontainer defined in the task definition. For more detailed information about these\n\t\t\tLinux capabilities, see the capabilities(7) Linux manual page.
" + } + }, + "com.amazonaws.ecs#KeyValuePair": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the\n\t\t\tenvironment variable.
" + } + }, + "value": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the\n\t\t\tenvironment variable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A key-value pair object.
" + } + }, + "com.amazonaws.ecs#LaunchType": { + "type": "enum", + "members": { + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" + } + }, + "FARGATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE" + } + }, + "EXTERNAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL" + } + } + } + }, + "com.amazonaws.ecs#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The limit for the resource was exceeded.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#LinuxParameters": { + "type": "structure", + "members": { + "capabilities": { + "target": "com.amazonaws.ecs#KernelCapabilities", + "traits": { + "smithy.api#documentation": "The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker.
\nFor tasks that use the Fargate launch type,\n\t\t\t\t\tcapabilities is supported for all platform versions but the\n\t\t\t\t\tadd parameter is only supported if using platform version 1.4.0 or\n\t\t\t\tlater.
Any host devices to expose to the container. This parameter maps to\n\t\t\t\tDevices in the docker container create command and the\n\t\t\t\t--device option to docker run.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tdevices parameter isn't supported.
Run an init process inside the container that forwards signals and reaps\n\t\t\tprocesses. This parameter maps to the --init option to docker run.\n\t\t\tThis parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The value for the size (in MiB) of the /dev/shm volume. This parameter\n\t\t\tmaps to the --shm-size option to docker run.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tsharedMemorySize parameter is not supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the --tmpfs option to docker run.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\ttmpfs parameter isn't supported.
The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the --memory-swap option to docker run where the value would\n\t\t\tbe the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not\n\t\t\tuse swap. Accepted values are 0 or any positive integer. If the\n\t\t\t\tmaxSwap parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A maxSwap value\n\t\t\tmust be set for the swappiness parameter to be used.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tmaxSwap parameter isn't supported.
If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't\n\t\t\t\tsupported.
This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\tswappiness value of 0 will cause swapping to not happen\n\t\t\tunless absolutely necessary. A swappiness value of 100 will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t0 and 100. If the swappiness parameter is not\n\t\t\tspecified, a default value of 60 is used. If a value is not specified for\n\t\t\t\tmaxSwap then this parameter is ignored. This parameter maps to the\n\t\t\t\t--memory-swappiness option to docker run.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tswappiness parameter isn't supported.
If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't\n\t\t\t\tsupported.
The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
" + } + }, + "com.amazonaws.ecs#ListAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#ListAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.ecs#ListAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the account settings for a specified principal.
", + "smithy.api#examples": [ + { + "title": "To view the effective account settings for a specific IAM user or IAM role", + "documentation": "This example displays the effective account settings for the specified user or role.", + "input": { + "effectiveSettings": true, + "principalArn": "arn:aws:iam::The name of the account setting you want to list the settings for.
" + } + }, + "value": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The value of the account settings to filter results with. You must also specify an\n\t\t\taccount setting name to use this parameter.
" + } + }, + "principalArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the principal, which can be a user, role, or the root user. If this field is\n\t\t\tomitted, the account settings are listed only for the authenticated user.
\nFederated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nDetermines whether to return the effective settings. If true, the account\n\t\t\tsettings for the root user or the default setting for the principalArn are\n\t\t\treturned. If false, the account settings for the principalArn\n\t\t\tare returned if they're set. Otherwise, no account settings are returned.
The nextToken value returned from a ListAccountSettings\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it's possible the number\n\t\t\tof results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of account setting results returned by\n\t\t\t\tListAccountSettings in paginated output. When this parameter is used,\n\t\t\t\tListAccountSettings only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListAccountSettings\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter isn't used, then ListAccountSettings returns up to\n\t\t\t10 results and a nextToken value\n\t\t\tif applicable.
The account settings for the resource.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future\n\t\t\t\tListAccountSettings request. When the results of a\n\t\t\t\tListAccountSettings request exceed maxResults, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.
Lists the attributes for Amazon ECS resources within a specified target type and cluster.\n\t\t\tWhen you specify a target type and cluster, ListAttributes returns a list\n\t\t\tof attribute objects, one for each attribute on each resource. You can filter the list\n\t\t\tof results to a single attribute name to only return results that have that name. You\n\t\t\tcan also filter the results by attribute name and value. You can do this, for example,\n\t\t\tto see which container instances in a cluster are running a Linux AMI\n\t\t\t\t(ecs.os-type=linux).
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + } + }, + "targetType": { + "target": "com.amazonaws.ecs#TargetType", + "traits": { + "smithy.api#documentation": "The type of the target to list attributes with.
", + "smithy.api#required": {} + } + }, + "attributeName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter the results with.
" + } + }, + "attributeValue": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The value of the attribute to filter results with. You must also specify an attribute\n\t\t\tname to use this parameter.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a ListAttributes request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results that ListAttributes returned in\n\t\t\tpaginated output. When this parameter is used, ListAttributes only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListAttributes request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter isn't used, then ListAttributes returns up to\n\t\t\t100 results and a nextToken value if applicable.
A list of attribute objects that meet the criteria of the request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future ListAttributes\n\t\t\trequest. When the results of a ListAttributes request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
Returns a list of existing clusters.
", + "smithy.api#examples": [ + { + "title": "To list your available clusters", + "documentation": "This example lists all of your available clusters in your default region.", + "output": { + "clusterArns": [ + "arn:aws:ecs:us-east-1:The nextToken value returned from a ListClusters request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results that ListClusters returned in\n\t\t\tpaginated output. When this parameter is used, ListClusters only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListClusters request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter isn't used, then ListClusters returns up to 100\n\t\t\tresults and a nextToken value if applicable.
The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your\n\t\t\taccount.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future ListClusters\n\t\t\trequest. When the results of a ListClusters request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
Returns a list of container instances in a specified cluster. You can filter the\n\t\t\tresults of a ListContainerInstances operation with cluster query language\n\t\t\tstatements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tlist. If you do not specify a cluster, the default cluster is assumed.
" + } + }, + "filter": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "You can filter the results of a ListContainerInstances operation with\n\t\t\tcluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The nextToken value returned from a ListContainerInstances\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls are needed. If maxResults was provided, it's possible the number of\n\t\t\tresults to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of container instance results that\n\t\t\t\tListContainerInstances returned in paginated output. When this\n\t\t\tparameter is used, ListContainerInstances only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListContainerInstances request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListContainerInstances returns up to 100 results and\n\t\t\ta nextToken value if applicable.
Filters the container instances by status. For example, if you specify the\n\t\t\t\tDRAINING status, the results include only container instances that have\n\t\t\tbeen set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the\n\t\t\tdefault is to include container instances set to all states other than\n\t\t\t\tINACTIVE.
The list of container instances with full ARN entries for each container instance\n\t\t\tassociated with the specified cluster.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future\n\t\t\t\tListContainerInstances request. When the results of a\n\t\t\t\tListContainerInstances request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null\n\t\t\twhen there are no more results to return.
This operation lists all the service deployments that meet the specified filter\n\t\t\tcriteria.
\nA service deployment happens when you release a software update for the service. You\n\t\t\troute traffic from the running service revisions to the new service revison and control\n\t\t\tthe number of running tasks.
\nThis API returns the values that you use for the request parameters in DescribeServiceRevisions.
", + "smithy.api#examples": [ + { + "title": "To list service deployments that meet the specified criteria", + "documentation": "This example lists all successful service deployments for the service \"sd-example\" in the cluster \"example\".", + "input": { + "service": "sd-example", + "cluster": "example", + "status": [ + "SUCCESSFUL" + ] + }, + "output": { + "serviceDeployments": [ + { + "serviceDeploymentArn": "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5", + "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/example", + "targetServiceRevisionArn": "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095", + "status": "SUCCESSFUL" + } + ] + } + } + ] + } + }, + "com.amazonaws.ecs#ListServiceDeploymentsRequest": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN or name of the service
", + "smithy.api#required": {} + } + }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The cluster that hosts the service. This can either be the cluster name or ARN.\n\t\t\tStarting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n\t\t\tElastic Inference (EI), and will help current customers migrate their workloads to\n\t\t\toptions that offer better price and performance. If you don't specify a cluster,\n\t\t\t\tdefault is used.
An optional filter you can use to narrow the results. If you do not specify a status,\n\t\t\tthen all status values are included in the result.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecs#CreatedAt", + "traits": { + "smithy.api#documentation": "An optional filter you can use to narrow the results by the service creation date. If\n\t\t\tyou do not specify a value, the result includes all services created before the current\n\t\t\ttime. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a ListServiceDeployments\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls are needed. If you provided maxResults, it's possible the number of\n\t\t\tresults is fewer than maxResults.
The maximum number of service deployment results that\n\t\t\t\tListServiceDeployments returned in paginated output. When this\n\t\t\tparameter is used, ListServiceDeployments only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListServiceDeployments request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and 100. If this parameter\n\t\t\tisn't used, then ListServiceDeployments returns up to 20 results and a\n\t\t\t\tnextToken value if applicable.
An overview of the service deployment, including the following properties:
\nThe ARN of the service deployment.
\nThe ARN of the service being deployed.
\nThe ARN of the cluster that hosts the service in the service\n\t\t\t\t\tdeployment.
\nThe time that the service deployment started.
\nThe time that the service deployment completed.
\nThe service deployment status.
\nInformation about why the service deployment is in the current state.
\nThe ARN of the service revision that is being deployed.
\nThe nextToken value to include in a future\n\t\t\t\tListServiceDeployments request. When the results of a\n\t\t\t\tListServiceDeployments request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null when there\n\t\t\tare no more results to return.
Returns a list of services. You can filter the results by cluster, launch type, and\n\t\t\tscheduling strategy.
", + "smithy.api#examples": [ + { + "title": "To list the services in a cluster", + "documentation": "This example lists the services running in the default cluster for an account.", + "output": { + "serviceArns": [ + "arn:aws:ecs:us-east-1:012345678910:service/default/my-http-service" + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "serviceArns", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.ecs#ListServicesByNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#ListServicesByNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.ecs#ListServicesByNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#NamespaceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "This operation lists all of the services that are associated with a Cloud Map\n\t\t\tnamespace. This list might include services in different clusters. In contrast,\n\t\t\t\tListServices can only list services in one cluster at a time. If you\n\t\t\tneed to filter the list of services in a single cluster by various parameters, use\n\t\t\t\tListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value that's returned from a\n\t\t\t\tListServicesByNamespace request. It indicates that more results are\n\t\t\tavailable to fulfill the request and further calls are needed. If\n\t\t\t\tmaxResults is returned, it is possible the number of results is less\n\t\t\tthan maxResults.
The maximum number of service results that ListServicesByNamespace\n\t\t\treturns in paginated output. When this parameter is used,\n\t\t\t\tListServicesByNamespace only returns maxResults results in\n\t\t\ta single page along with a nextToken response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\t\tListServicesByNamespace request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListServicesByNamespace returns up to\n\t\t\t10 results and a nextToken\n\t\t\tvalue if applicable.
The list of full ARN entries for each service that's associated with the specified\n\t\t\tnamespace.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future\n\t\t\t\tListServicesByNamespace request. When the results of a\n\t\t\t\tListServicesByNamespace request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. When there are no more results\n\t\t\tto return, this value is null.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the\n\t\t\t\tListServices results. If you do not specify a cluster, the default cluster is assumed.
The nextToken value returned from a ListServices request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of service results that ListServices returned in\n\t\t\tpaginated output. When this parameter is used, ListServices only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListServices request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If\n\t\t\tthis parameter isn't used, then ListServices returns up to\n\t\t\t10 results and a nextToken value if\n\t\t\tapplicable.
The launch type to use when filtering the ListServices results.
The scheduling strategy to use when filtering the ListServices\n\t\t\tresults.
The list of full ARN entries for each service that's associated with the specified\n\t\t\tcluster.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future ListServices\n\t\t\trequest. When the results of a ListServices request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
List the tags for an Amazon ECS resource.
", + "smithy.api#examples": [ + { + "title": "To list the tags for a cluster.", + "documentation": "This example lists the tags for the 'dev' cluster.", + "input": { + "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev" + }, + "output": { + "tags": [ + { + "key": "team", + "value": "dev" + } + ] + } + } + ] + } + }, + "com.amazonaws.ecs#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the\n\t\t\tsupported resources are Amazon ECS tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The tags for the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#ListTaskDefinitionFamilies": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#ListTaskDefinitionFamiliesRequest" + }, + "output": { + "target": "com.amazonaws.ecs#ListTaskDefinitionFamiliesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of task definition families that are registered to your account. This\n\t\t\tlist includes task definition families that no longer have any ACTIVE task\n\t\t\tdefinition revisions.
You can filter out task definition families that don't contain any ACTIVE\n\t\t\ttask definition revisions by setting the status parameter to\n\t\t\t\tACTIVE. You can also filter the results with the\n\t\t\t\tfamilyPrefix parameter.
The familyPrefix is a string that's used to filter the results of\n\t\t\t\tListTaskDefinitionFamilies. If you specify a familyPrefix,\n\t\t\tonly task definition family names that begin with the familyPrefix string\n\t\t\tare returned.
The task definition family status to filter the\n\t\t\t\tListTaskDefinitionFamilies results with. By default, both\n\t\t\t\tACTIVE and INACTIVE task definition families are listed.\n\t\t\tIf this parameter is set to ACTIVE, only task definition families that have\n\t\t\tan ACTIVE task definition revision are returned. If this parameter is set\n\t\t\tto INACTIVE, only task definition families that do not have any\n\t\t\t\tACTIVE task definition revisions are returned. If you paginate the\n\t\t\tresulting output, be sure to keep the status value constant in each\n\t\t\tsubsequent request.
The nextToken value returned from a\n\t\t\t\tListTaskDefinitionFamilies request indicating that more results are\n\t\t\tavailable to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be\n\t\t\tfewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task definition family results that\n\t\t\t\tListTaskDefinitionFamilies returned in paginated output. When this\n\t\t\tparameter is used, ListTaskDefinitions only returns maxResults\n\t\t\tresults in a single page along with a nextToken response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\tListTaskDefinitionFamilies request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitionFamilies returns up to 100 results\n\t\t\tand a nextToken value if applicable.
The list of task definition family names that match the\n\t\t\t\tListTaskDefinitionFamilies request.
The nextToken value to include in a future\n\t\t\t\tListTaskDefinitionFamilies request. When the results of a\n\t\t\t\tListTaskDefinitionFamilies request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null\n\t\t\twhen there are no more results to return.
Returns a list of task definitions that are registered to your account. You can filter\n\t\t\tthe results by family name with the familyPrefix parameter or by status\n\t\t\twith the status parameter.
The full family name to filter the ListTaskDefinitions results with.\n\t\t\tSpecifying a familyPrefix limits the listed task definitions to task\n\t\t\tdefinition revisions that belong to that family.
The task definition status to filter the ListTaskDefinitions results\n\t\t\twith. By default, only ACTIVE task definitions are listed. By setting this\n\t\t\tparameter to INACTIVE, you can view task definitions that are\n\t\t\t\tINACTIVE as long as an active task or service still references them. If\n\t\t\tyou paginate the resulting output, be sure to keep the status value\n\t\t\tconstant in each subsequent request.
The order to sort the results in. Valid values are ASC and\n\t\t\t\tDESC. By default, (ASC) task definitions are listed\n\t\t\tlexicographically by family name and in ascending numerical order by revision so that\n\t\t\tthe newest task definitions in a family are listed last. Setting this parameter to\n\t\t\t\tDESC reverses the sort order on family name and revision. This is so\n\t\t\tthat the newest task definitions in a family are listed first.
The nextToken value returned from a ListTaskDefinitions\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task definition results that ListTaskDefinitions\n\t\t\treturned in paginated output. When this parameter is used,\n\t\t\t\tListTaskDefinitions only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListTaskDefinitions\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitions returns up to 100 results and a\n\t\t\t\tnextToken value if applicable.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions\n\t\t\trequest.
The nextToken value to include in a future\n\t\t\t\tListTaskDefinitions request. When the results of a\n\t\t\t\tListTaskDefinitions request exceed maxResults, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.
Returns a list of tasks. You can filter the results by cluster, task definition\n\t\t\tfamily, container instance, launch type, what IAM principal started the task, or by\n\t\t\tthe desired status of the task.
\nRecently stopped tasks might appear in the returned results.
", + "smithy.api#examples": [ + { + "title": "To list the tasks on a particular container instance", + "documentation": "This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.", + "input": { + "cluster": "default", + "containerInstance": "f6bbb147-5370-4ace-8c73-c7181ded911f" + }, + "output": { + "taskArns": [ + "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84" + ] + } + }, + { + "title": "To list the tasks in a cluster", + "documentation": "This example lists all of the tasks in a cluster.", + "input": { + "cluster": "default" + }, + "output": { + "taskArns": [ + "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84", + "arn:aws:ecs:us-east-1:012345678910:task/default/6b809ef6-c67e-4467-921f-ee261c15a0a1" + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "taskArns", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.ecs#ListTasksRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the\n\t\t\t\tListTasks results. If you do not specify a cluster, the default cluster is assumed.
The container instance ID or full ARN of the container instance to use when\n\t\t\tfiltering the ListTasks results. Specifying a\n\t\t\t\tcontainerInstance limits the results to tasks that belong to that\n\t\t\tcontainer instance.
The name of the task definition family to use when filtering the\n\t\t\t\tListTasks results. Specifying a family limits the results\n\t\t\tto tasks that belong to that family.
The nextToken value returned from a ListTasks request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it's possible the number of results\n\t\t\tto be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task results that ListTasks returned in paginated\n\t\t\toutput. When this parameter is used, ListTasks only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListTasks request with the returned nextToken value.\n\t\t\tThis value can be between 1 and 100. If this parameter\n\t\t\tisn't used, then ListTasks returns up to 100 results and\n\t\t\ta nextToken value if applicable.
The startedBy value to filter the task results with. Specifying a\n\t\t\t\tstartedBy value limits the results to tasks that were started with that\n\t\t\tvalue.
When you specify startedBy as the filter, it must be the only filter that\n\t\t\tyou use.
The name of the service to use when filtering the ListTasks results.\n\t\t\tSpecifying a serviceName limits the results to tasks that belong to that\n\t\t\tservice.
The task desired status to use when filtering the ListTasks results.\n\t\t\tSpecifying a desiredStatus of STOPPED limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to STOPPED. This can be useful\n\t\t\tfor debugging tasks that aren't starting properly or have died or finished. The default\n\t\t\tstatus filter is RUNNING, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to RUNNING.
Although you can filter results based on a desired status of PENDING,\n\t\t\t\tthis doesn't return any results. Amazon ECS never sets the desired status of a task to\n\t\t\t\tthat value (only a task's lastStatus may have a value of\n\t\t\t\t\tPENDING).
The launch type to use when filtering the ListTasks results.
The list of task ARN entries for the ListTasks request.
The nextToken value to include in a future ListTasks\n\t\t\trequest. When the results of a ListTasks request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.
\nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
\nFor services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.
The name of the load balancer to associate with the Amazon ECS service or task set.
\nIf you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be\n\t\t\tomitted.
" + } + }, + "containerName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container (as it appears in a container definition) to associate with\n\t\t\tthe load balancer.
\nYou need to specify the container name when configuring the target group for an Amazon ECS\n\t\t\tload balancer.
" + } + }, + "containerPort": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The port on the container to associate with the load balancer. This port must\n\t\t\tcorrespond to a containerPort in the task definition the tasks in the\n\t\t\tservice are using. For tasks that use the EC2 launch type, the container\n\t\t\tinstance they're launched on must allow ingress traffic on the hostPort of\n\t\t\tthe port mapping.
The load balancer configuration to use with a service or task set.
\nWhen you add, update, or remove a load balancer configuration, Amazon ECS starts a new\n\t\t\tdeployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and\n\t\t\tderegister from load balancers.
\nWe recommend that you verify this on a test environment before you update the Elastic Load Balancing\n\t\t\tconfiguration.
\nA service-linked role is required for services that use multiple target groups. For\n\t\t\tmore information, see Using\n\t\t\t\tservice-linked roles in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#LoadBalancers": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#LoadBalancer" + } + }, + "com.amazonaws.ecs#LogConfiguration": { + "type": "structure", + "members": { + "logDriver": { + "target": "com.amazonaws.ecs#LogDriver", + "traits": { + "smithy.api#documentation": "The log driver to use for the container.
\nFor tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\tsplunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\tjson-file, journald, syslog,\n\t\t\t\tsplunk, and awsfirelens.
For more information about using the awslogs log driver, see Send\n\t\t\t\tAmazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Send\n\t\t\t\tAmazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.
If you have a custom driver that isn't listed, you can fork the Amazon ECS container\n\t\t\t\tagent project that's available\n\t\t\t\t\ton GitHub and customize it to work with that driver. We encourage you to\n\t\t\t\tsubmit pull requests for changes that you would like to have included. However, we\n\t\t\t\tdon't currently provide support for running modified copies of this software.
\nThe configuration options to send to the log driver.
\nThe options you can specify depend on the log driver. Some of the options you can\n\t\t\tspecify when you use the awslogs log driver to route logs to Amazon CloudWatch\n\t\t\tinclude the following:
Required: No
\nSpecify whether you want the log group to be created automatically. If\n\t\t\t\t\t\tthis option isn't specified, it defaults to false.
Your IAM policy must include the logs:CreateLogGroup\n\t\t\t\t\t\t\tpermission before you attempt to use\n\t\t\t\t\t\t\tawslogs-create-group.
Required: Yes
\nSpecify the Amazon Web Services Region that the awslogs log driver is to\n\t\t\t\t\t\tsend your Docker logs to. You can choose to send all of your logs from\n\t\t\t\t\t\tclusters in different Regions to a single region in CloudWatch Logs. This is so that\n\t\t\t\t\t\tthey're all visible in one location. Otherwise, you can separate them by\n\t\t\t\t\t\tRegion for more granularity. Make sure that the specified log group exists\n\t\t\t\t\t\tin the Region that you specify with this option.
Required: Yes
\nMake sure to specify a log group that the awslogs log driver\n\t\t\t\t\t\tsends its log streams to.
Required: Yes, when using the Fargate launch\n\t\t\t\t\t\t\ttype.Optional for the EC2 launch type,\n\t\t\t\t\t\t\trequired for the Fargate launch type.
\nUse the awslogs-stream-prefix option to associate a log\n\t\t\t\t\t\tstream with the specified prefix, the container name, and the ID of the\n\t\t\t\t\t\tAmazon ECS task that the container belongs to. If you specify a prefix with this\n\t\t\t\t\t\toption, then the log stream takes the format\n\t\t\t\t\t\t\tprefix-name/container-name/ecs-task-id.
If you don't specify a prefix with this option, then the log stream is\n\t\t\t\t\t\tnamed after the container ID that's assigned by the Docker daemon on the\n\t\t\t\t\t\tcontainer instance. Because it's difficult to trace logs back to the\n\t\t\t\t\t\tcontainer that sent them with just the Docker container ID (which is only\n\t\t\t\t\t\tavailable on the container instance), we recommend that you specify a prefix\n\t\t\t\t\t\twith this option.
\nFor Amazon ECS services, you can use the service name as the prefix. Doing so,\n\t\t\t\t\t\tyou can trace log streams to the service that the container belongs to, the\n\t\t\t\t\t\tname of the container that sent them, and the ID of the task that the\n\t\t\t\t\t\tcontainer belongs to.
\nYou must specify a stream-prefix for your logs to have your logs appear in\n\t\t\t\t\t\tthe Log pane when using the Amazon ECS console.
\nRequired: No
\nThis option defines a multiline start pattern in Python\n\t\t\t\t\t\t\tstrftime format. A log message consists of a line that\n\t\t\t\t\t\tmatches the pattern and any following lines that don’t match the pattern.\n\t\t\t\t\t\tThe matched line is the delimiter between log messages.
One example of a use case for using this format is for parsing output such\n\t\t\t\t\t\tas a stack dump, which might otherwise be logged in multiple entries. The\n\t\t\t\t\t\tcorrect pattern allows it to be captured in a single entry.
\nFor more information, see awslogs-datetime-format.
\nYou cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.
Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.
\nRequired: No
\nThis option defines a multiline start pattern that uses a regular\n\t\t\t\t\t\texpression. A log message consists of a line that matches the pattern and\n\t\t\t\t\t\tany following lines that don’t match the pattern. The matched line is the\n\t\t\t\t\t\tdelimiter between log messages.
\nFor more information, see awslogs-multiline-pattern.
\nThis option is ignored if awslogs-datetime-format is also\n\t\t\t\t\t\tconfigured.
You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.
Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.
\nRequired: No
\nValid values: non-blocking | blocking\n
This option defines the delivery mode of log messages from the container\n\t\t\t\t\t\tto CloudWatch Logs. The delivery mode you choose affects application availability when\n\t\t\t\t\t\tthe flow of logs from container to CloudWatch is interrupted.
\nIf you use the blocking mode and the flow of logs to CloudWatch is\n\t\t\t\t\t\tinterrupted, calls from container code to write to the stdout\n\t\t\t\t\t\tand stderr streams will block. The logging thread of the\n\t\t\t\t\t\tapplication will block as a result. This may cause the application to become\n\t\t\t\t\t\tunresponsive and lead to container healthcheck failure.
If you use the non-blocking mode, the container's logs are\n\t\t\t\t\t\tinstead stored in an in-memory intermediate buffer configured with the\n\t\t\t\t\t\t\tmax-buffer-size option. This prevents the application from\n\t\t\t\t\t\tbecoming unresponsive when logs cannot be sent to CloudWatch. We recommend using\n\t\t\t\t\t\tthis mode if you want to ensure service availability and are okay with some\n\t\t\t\t\t\tlog loss. For more information, see Preventing log loss with non-blocking mode in the awslogs\n\t\t\t\t\t\t\tcontainer log driver.
Required: No
\nDefault value: 1m\n
When non-blocking mode is used, the\n\t\t\t\t\t\t\tmax-buffer-size log option controls the size of the buffer\n\t\t\t\t\t\tthat's used for intermediate message storage. Make sure to specify an\n\t\t\t\t\t\tadequate buffer size based on your application. When the buffer fills up,\n\t\t\t\t\t\tfurther logs cannot be stored. Logs that cannot be stored are lost.
To route logs using the splunk log router, you need to specify a\n\t\t\t\tsplunk-token and a splunk-url.
When you use the awsfirelens log router to route logs to an Amazon Web Services Service\n\t\t\tor Amazon Web Services Partner Network destination for log storage and analytics, you can set the\n\t\t\t\tlog-driver-buffer-limit option to limit the number of events that are\n\t\t\tbuffered in memory, before being sent to the log router container. It can help to\n\t\t\tresolve potential log loss issue because high throughput might result in memory running\n\t\t\tout for the buffer inside of Docker.
Other options you can specify when using awsfirelens to route logs depend\n\t\t\ton the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region\n\t\t\twith region and a name for the log stream with\n\t\t\tdelivery_stream.
When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with\n\t\t\t\tregion and a data stream name with stream.
When you export logs to Amazon OpenSearch Service, you can specify options like Name,\n\t\t\t\tHost (OpenSearch Service endpoint without protocol), Port,\n\t\t\t\tIndex, Type, Aws_auth,\n\t\t\t\tAws_region, Suppress_Type_Name, and\n\t\t\ttls. For more information, see Under the hood: FireLens for Amazon ECS Tasks.
When you export logs to Amazon S3, you can specify the bucket using the bucket\n\t\t\toption. You can also specify region, total_file_size,\n\t\t\t\tupload_timeout, and use_put_object as options.
This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The secrets to pass to the log configuration. For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the docker container create command and the --log-driver option to\n\t\t\tdocker run.
By default, containers use the same logging driver that the Docker daemon uses.\n\t\t\tHowever, the container might use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition.
\nUnderstand the following when specifying a log configuration for your\n\t\t\tcontainers.
\nAmazon ECS currently supports a subset of the logging drivers available to the\n\t\t\t\t\tDocker daemon. Additional log drivers may be available in future releases of the\n\t\t\t\t\tAmazon ECS container agent.
\nFor tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\t\t\tsplunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\t\t\tjson-file, journald,syslog,\n\t\t\t\t\t\tsplunk, and awsfirelens.
This parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.
\nFor tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must\n\t\t\t\t\tregister the available logging drivers with the\n\t\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\t\tcontainers placed on that instance can use these log configuration options. For\n\t\t\t\t\tmore information, see Amazon ECS container agent configuration in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
For tasks that are on Fargate, because you don't have access to the\n\t\t\t\t\tunderlying infrastructure your tasks are hosted on, any additional software\n\t\t\t\t\tneeded must be installed outside of the task. For example, the Fluentd output\n\t\t\t\t\taggregators or a remote host running Logstash to send Gelf logs to.
\nThe Unix timestamp for the time when the managed agent was last started.
" + } + }, + "name": { + "target": "com.amazonaws.ecs#ManagedAgentName", + "traits": { + "smithy.api#documentation": "The name of the managed agent. When the execute command feature is turned on, the\n\t\t\tmanaged agent name is ExecuteCommandAgent.
The reason for why the managed agent is in the state it is in.
" + } + }, + "lastStatus": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The last known status of the managed agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the managed agent status for the container.
" + } + }, + "com.amazonaws.ecs#ManagedAgentName": { + "type": "enum", + "members": { + "ExecuteCommandAgent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecuteCommandAgent" + } + } + } + }, + "com.amazonaws.ecs#ManagedAgentStateChange": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container that's associated with the managed agent.
", + "smithy.api#required": {} + } + }, + "managedAgentName": { + "target": "com.amazonaws.ecs#ManagedAgentName", + "traits": { + "smithy.api#documentation": "The name of the managed agent.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the managed agent.
", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The reason for the status of the managed agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing a change in state for a managed agent.
" + } + }, + "com.amazonaws.ecs#ManagedAgentStateChanges": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ManagedAgentStateChange" + } + }, + "com.amazonaws.ecs#ManagedAgents": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ManagedAgent" + } + }, + "com.amazonaws.ecs#ManagedDraining": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.ecs#ManagedScaling": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.ecs#ManagedScalingStatus", + "traits": { + "smithy.api#documentation": "Determines whether to use managed scaling for the capacity provider.
" + } + }, + "targetCapacity": { + "target": "com.amazonaws.ecs#ManagedScalingTargetCapacity", + "traits": { + "smithy.api#documentation": "The target capacity utilization as a percentage for the capacity provider. The\n\t\t\tspecified value must be greater than 0 and less than or equal to\n\t\t\t\t100. For example, if you want the capacity provider to maintain 10%\n\t\t\tspare capacity, then that means the utilization is 90%, so use a\n\t\t\t\ttargetCapacity of 90. The default value of\n\t\t\t\t100 percent results in the Amazon EC2 instances in your Auto Scaling group\n\t\t\tbeing completely used.
The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.
\nIf you use a capacity provider with an Auto Scaling group configured with more than\n\t\t\tone Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum\n\t\t\tscaling step size value and will ignore both the maximum scaling step size as well as\n\t\t\tthe capacity demand.
" + } + }, + "maximumScalingStepSize": { + "target": "com.amazonaws.ecs#ManagedScalingStepSize", + "traits": { + "smithy.api#documentation": "The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this\n\t\t\tparameter is omitted, the default value of 10000 is used.
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute\n\t\t\tto CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value\n\t\t\tof 300 seconds is used.
The managed scaling settings for the Auto Scaling group capacity provider.
\nWhen managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is off, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.
" + } + }, + "com.amazonaws.ecs#ManagedScalingInstanceWarmupPeriod": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 10000 + } + } + }, + "com.amazonaws.ecs#ManagedScalingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.ecs#ManagedScalingStepSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.ecs#ManagedScalingTargetCapacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecs#ManagedStorageConfiguration": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Specify a Key Management Service key ID to encrypt the managed storage.
" + } + }, + "fargateEphemeralStorageKmsKeyId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Specify the Key Management Service key ID for the Fargate ephemeral storage.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The managed storage configuration for the cluster.
" + } + }, + "com.amazonaws.ecs#ManagedTerminationProtection": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.ecs#MissingVersionException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Amazon ECS can't determine the current version of the Amazon ECS container agent on the\n\t\t\tcontainer instance and doesn't have enough information to proceed with an update. This\n\t\t\tcould be because the agent running on the container instance is a previous or custom\n\t\t\tversion that doesn't use our version information.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#MountPoint": { + "type": "structure", + "members": { + "sourceVolume": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the volume to mount. Must be a volume name referenced in the\n\t\t\t\tname parameter of task definition volume.
The path on the container to mount the host volume at.
" + } + }, + "readOnly": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "If this value is true, the container has read-only access to the volume.\n\t\t\tIf this value is false, then the container can write to the volume. The\n\t\t\tdefault value is false.
The details for a volume mount point that's used in a container definition.
" + } + }, + "com.amazonaws.ecs#MountPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#MountPoint" + } + }, + "com.amazonaws.ecs#NamespaceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified namespace wasn't found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#NetworkBinding": { + "type": "structure", + "members": { + "bindIP": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The IP address that the container is bound to on the container instance.
" + } + }, + "containerPort": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The port number on the container that's used with the network binding.
" + } + }, + "hostPort": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The port number on the host that's used with the network binding.
" + } + }, + "protocol": { + "target": "com.amazonaws.ecs#TransportProtocol", + "traits": { + "smithy.api#documentation": "The protocol used for the network binding.
" + } + }, + "containerPortRange": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The port number range on the container that's bound to the dynamically mapped host\n\t\t\tport range.
\nThe following rules apply when you specify a containerPortRange:
You must use either the bridge network mode or the awsvpc\n\t\t\t\t\tnetwork mode.
This parameter is available for both the EC2 and Fargate launch types.
\nThis parameter is available for both the Linux and Windows operating systems.
\nThe container instance must have at least version 1.67.0 of the container agent\n\t\t\t\t\tand at least version 1.67.0-1 of the ecs-init package
You can specify a maximum of 100 port ranges per container.
\nYou do not specify a hostPortRange. The value of the hostPortRange is set\n\t\t\t\t\tas follows:
For containers in a task with the awsvpc network mode,\n\t\t\t\t\t\t\tthe hostPortRange is set to the same value as the\n\t\t\t\t\t\t\t\tcontainerPortRange. This is a static mapping\n\t\t\t\t\t\t\tstrategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange valid values are between 1 and\n\t\t\t\t\t65535.
A port can only be included in one port mapping per container.
\nYou cannot specify overlapping port ranges.
\nThe first port in the range must be less than last port in the range.
\nDocker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
\nFor more information, see Issue #11185 on the Github website.
\nFor information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
\nYou can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.
The port number range on the host that's used with the network binding. This is\n\t\t\tassigned is assigned by Docker and delivered by the Amazon ECS agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details on the network bindings between a container and its host container instance.\n\t\t\tAfter a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\t\tDescribeTasks API\n\t\t\tresponses.
The VPC subnets and security groups that are associated with a task.
\nAll specified subnets and security groups must be from the same VPC.
\nThe network configuration for a task or service.
" + } + }, + "com.amazonaws.ecs#NetworkInterface": { + "type": "structure", + "members": { + "attachmentId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The attachment ID for the network interface.
" + } + }, + "privateIpv4Address": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The private IPv4 address for the network interface.
" + } + }, + "ipv6Address": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The private IPv6 address for the network interface.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the elastic network interface for tasks that use the\n\t\t\t\tawsvpc network mode.
Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "There's no update available for this Amazon ECS container agent. This might be because the\n\t\t\tagent is already running the latest version or because it's so old that there's no\n\t\t\tupdate path to the current version.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#OSFamily": { + "type": "enum", + "members": { + "WINDOWS_SERVER_2019_FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2019_FULL" + } + }, + "WINDOWS_SERVER_2019_CORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2019_CORE" + } + }, + "WINDOWS_SERVER_2016_FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2016_FULL" + } + }, + "WINDOWS_SERVER_2004_CORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2004_CORE" + } + }, + "WINDOWS_SERVER_2022_CORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2022_CORE" + } + }, + "WINDOWS_SERVER_2022_FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2022_FULL" + } + }, + "WINDOWS_SERVER_20H2_CORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_20H2_CORE" + } + }, + "LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX" + } + } + } + }, + "com.amazonaws.ecs#PidMode": { + "type": "enum", + "members": { + "HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + }, + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "task" + } + } + } + }, + "com.amazonaws.ecs#PlacementConstraint": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.ecs#PlacementConstraintType", + "traits": { + "smithy.api#documentation": "The type of constraint. Use distinctInstance to ensure that each task in\n\t\t\ta particular group is running on a different container instance. Use\n\t\t\t\tmemberOf to restrict the selection to a group of valid\n\t\t\tcandidates.
A cluster query language expression to apply to the constraint. The expression can\n\t\t\thave a maximum length of 2000 characters. You can't specify an expression if the\n\t\t\tconstraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\nIf you're using the Fargate launch type, task placement constraints\n\t\t\t\taren't supported.
\nThe type of placement strategy. The random placement strategy randomly\n\t\t\tplaces tasks on available candidates. The spread placement strategy spreads\n\t\t\tplacement across available candidates evenly based on the field parameter.\n\t\t\tThe binpack strategy places tasks on available candidates that have the\n\t\t\tleast available amount of the resource that's specified with the field\n\t\t\tparameter. For example, if you binpack on memory, a task is placed on the instance with\n\t\t\tthe least amount of remaining memory but still enough to run the task.
The field to apply the placement strategy against. For the spread\n\t\t\tplacement strategy, valid values are instanceId (or host,\n\t\t\twhich has the same effect), or any platform or custom attribute that's applied to a\n\t\t\tcontainer instance, such as attribute:ecs.availability-zone. For the\n\t\t\t\tbinpack placement strategy, valid values are cpu and\n\t\t\t\tmemory. For the random placement strategy, this field is\n\t\t\tnot used.
The task placement strategy for a task or service. For more information, see Task placement strategies in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#PlacementStrategyType": { + "type": "enum", + "members": { + "RANDOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "random" + } + }, + "SPREAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spread" + } + }, + "BINPACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "binpack" + } + } + } + }, + "com.amazonaws.ecs#PlatformDevice": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID for the GPUs on the container instance. The available GPU IDs can also be\n\t\t\tobtained on the container instance in the\n\t\t\t\t/var/lib/ecs/gpu/nvidia_gpu_info.json file.
The type of device that's available on the container instance. The only supported\n\t\t\tvalue is GPU.
The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" + } + }, + "com.amazonaws.ecs#PlatformDeviceType": { + "type": "enum", + "members": { + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GPU" + } + } + } + }, + "com.amazonaws.ecs#PlatformDevices": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#PlatformDevice" + } + }, + "com.amazonaws.ecs#PlatformTaskDefinitionIncompatibilityException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified platform version doesn't satisfy the required capabilities of the task\n\t\t\tdefinition.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#PlatformUnknownException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified platform version doesn't exist.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#PortMapping": { + "type": "structure", + "members": { + "containerPort": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The port number on the container that's bound to the user-specified or automatically\n\t\t\tassigned host port.
\nIf you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort.
If you use containers in a task with the bridge network mode and you\n\t\t\tspecify a container port and not a host port, your container automatically receives a\n\t\t\thost port in the ephemeral port range. For more information, see hostPort.\n\t\t\tPort mappings that are automatically assigned in this way do not count toward the 100\n\t\t\treserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
\nIf you specify a containerPortRange, leave this field empty and the value\n\t\t\tof the hostPort is set as follows:
For containers in a task with the awsvpc network mode, the\n\t\t\t\t\t\thostPort is set to the same value as the\n\t\t\t\t\t\tcontainerPort. This is a static mapping strategy.
For containers in a task with the bridge network mode, the Amazon ECS\n\t\t\t\t\tagent finds open ports on the host and automatically binds them to the container\n\t\t\t\t\tports. This is a dynamic mapping strategy.
If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.
If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535\n\t\t\t(Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port\n\t\t\tin the ephemeral port range as these are reserved for automatic assignment. In general,\n\t\t\tports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\t\tremainingResources of DescribeContainerInstances output. A container instance can have up to 100\n\t\t\treserved ports at a time. This number includes the default reserved ports. Automatically\n\t\t\tassigned ports aren't included in the 100 reserved ports quota.
The protocol used for the port mapping. Valid values are tcp and\n\t\t\t\tudp. The default is tcp. protocol is\n\t\t\timmutable in a Service Connect service. Updating this field requires a service deletion\n\t\t\tand redeployment.
The name that's used for the port mapping. This parameter is the name that you use in\n\t\t\tthe serviceConnectConfiguration and the\n\t\t\t\tvpcLatticeConfigurations of a service. The name can include up to 64\n\t\t\tcharacters. The characters can include lowercase letters, numbers, underscores (_), and\n\t\t\thyphens (-). The name can't start with a hyphen.
The application protocol that's used for the port mapping. This parameter only applies\n\t\t\tto Service Connect. We recommend that you set this parameter to be consistent with the\n\t\t\tprotocol that your application uses. If you set this parameter, Amazon ECS adds\n\t\t\tprotocol-specific connection handling to the Service Connect proxy. If you set this\n\t\t\tparameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
\nIf you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't\n\t\t\tadd protocol-specific telemetry for TCP.
\n\n appProtocol is immutable in a Service Connect service. Updating this\n\t\t\tfield requires a service deletion and redeployment.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "containerPortRange": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The port number range on the container that's bound to the dynamically mapped host\n\t\t\tport range.
\nThe following rules apply when you specify a containerPortRange:
You must use either the bridge network mode or the awsvpc\n\t\t\t\t\tnetwork mode.
This parameter is available for both the EC2 and Fargate launch types.
\nThis parameter is available for both the Linux and Windows operating systems.
\nThe container instance must have at least version 1.67.0 of the container agent\n\t\t\t\t\tand at least version 1.67.0-1 of the ecs-init package
You can specify a maximum of 100 port ranges per container.
\nYou do not specify a hostPortRange. The value of the hostPortRange is set\n\t\t\t\t\tas follows:
For containers in a task with the awsvpc network mode,\n\t\t\t\t\t\t\tthe hostPortRange is set to the same value as the\n\t\t\t\t\t\t\t\tcontainerPortRange. This is a static mapping\n\t\t\t\t\t\t\tstrategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange valid values are between 1 and\n\t\t\t\t\t65535.
A port can only be included in one port mapping per container.
\nYou cannot specify overlapping port ranges.
\nThe first port in the range must be less than last port in the range.
\nDocker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
\nFor more information, see Issue #11185 on the Github website.
\nFor information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
\nYou can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.
Port mappings allow containers to access ports on the host container instance to send\n\t\t\tor receive traffic. Port mappings are specified as part of the container\n\t\t\tdefinition.
\nIf you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort. The\n\t\t\t\thostPort can be left blank or it must be the same value as the\n\t\t\t\tcontainerPort.
Most fields of this parameter (containerPort, hostPort,\n\t\t\t\tprotocol) maps to PortBindings in the docker container\n\t\t\tcreate command and the --publish option to docker run. If the\n\t\t\tnetwork mode of a task definition is set to host, host ports must either be\n\t\t\tundefined or match the container port in the port mapping.
You can't expose the same container port for multiple protocols. If you attempt\n\t\t\t\tthis, an error is returned.
\nAfter a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\t\tDescribeTasks API\n\t\t\tresponses.
The task ARN.
" + } + }, + "protectionEnabled": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The protection status of the task. If scale-in protection is on for a task, the value\n\t\t\tis true. Otherwise, it is false.
The epoch time when protection for the task will expire.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the protection status details for a task. You can set the\n\t\t\tprotection status with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection API.
" + } + }, + "com.amazonaws.ecs#ProtectedTasks": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ProtectedTask" + } + }, + "com.amazonaws.ecs#ProxyConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.ecs#ProxyConfigurationType", + "traits": { + "smithy.api#documentation": "The proxy type. The only supported value is APPMESH.
The name of the container that will serve as the App Mesh proxy.
", + "smithy.api#required": {} + } + }, + "properties": { + "target": "com.amazonaws.ecs#ProxyConfigurationProperties", + "traits": { + "smithy.api#documentation": "The set of network configuration parameters to provide the Container Network Interface\n\t\t\t(CNI) plugin, specified as key-value pairs.
\n\n IgnoredUID - (Required) The user ID (UID) of the proxy\n\t\t\t\t\tcontainer as defined by the user parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredGID is specified, this field can be empty.
\n IgnoredGID - (Required) The group ID (GID) of the proxy\n\t\t\t\t\tcontainer as defined by the user parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredUID is specified, this field can be empty.
\n AppPorts - (Required) The list of ports that the\n\t\t\t\t\tapplication uses. Network traffic to these ports is forwarded to the\n\t\t\t\t\t\tProxyIngressPort and ProxyEgressPort.
\n ProxyIngressPort - (Required) Specifies the port that\n\t\t\t\t\tincoming traffic to the AppPorts is directed to.
\n ProxyEgressPort - (Required) Specifies the port that\n\t\t\t\t\toutgoing traffic from the AppPorts is directed to.
\n EgressIgnoredPorts - (Required) The egress traffic going to\n\t\t\t\t\tthe specified ports is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort. It can be an empty list.
\n EgressIgnoredIPs - (Required) The egress traffic going to\n\t\t\t\t\tthe specified IP addresses is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort. It can be an empty list.
The configuration details for the App Mesh proxy.
\nFor tasks that use the EC2 launch type, the container instances require\n\t\t\tat least version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init package to use a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS optimized AMI version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n
Modifies an account setting. Account settings are set on a per-Region basis.
\nIf you change the root user account setting, the default settings are reset for users and\n\t\t\troles that do not have specified individual account settings. For more information, see\n\t\t\t\tAccount\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#examples": [ + { + "title": "To modify the account settings for a specific IAM user or IAM role", + "documentation": "This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", + "input": { + "name": "containerInstanceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::Modifies an account setting for all users on an account for whom no individual account\n\t\t\tsetting has been specified. Account settings are set on a per-Region basis.
", + "smithy.api#examples": [ + { + "title": "To modify the default account settings for all IAM users or roles on an account", + "documentation": "This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", + "input": { + "name": "serviceLongArnFormat", + "value": "enabled" + }, + "output": { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::The resource name for which to modify the account setting.
\nThe following are the valid values for the account setting name.
\n\n serviceLongArnFormat - When modified, the Amazon Resource Name\n\t\t\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting\n\t\t\t\t\tmust be set for each Amazon ECS resource separately. The ARN and resource ID format\n\t\t\t\t\tof a resource is defined by the opt-in status of the user or role that created\n\t\t\t\t\tthe resource. You must turn on this setting to use Amazon ECS features such as\n\t\t\t\t\tresource tagging.
\n taskLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the\n\t\t\t\t\troot user for an account is affected. The opt-in and opt-out account setting must\n\t\t\t\t\tbe set for each Amazon ECS resource separately. The ARN and resource ID format of a\n\t\t\t\t\tresource is defined by the opt-in status of the user or role that created the\n\t\t\t\t\tresource. You must turn on this setting to use Amazon ECS features such as resource\n\t\t\t\t\ttagging.
\n containerInstanceLongArnFormat - When modified, the Amazon\n\t\t\t\t\tResource Name (ARN) and resource ID format of the resource type for a specified\n\t\t\t\t\tuser, role, or the root user for an account is affected. The opt-in and opt-out\n\t\t\t\t\taccount setting must be set for each Amazon ECS resource separately. The ARN and\n\t\t\t\t\tresource ID format of a resource is defined by the opt-in status of the user or\n\t\t\t\t\trole that created the resource. You must turn on this setting to use Amazon ECS\n\t\t\t\t\tfeatures such as resource tagging.
\n awsvpcTrunking - When modified, the elastic network interface\n\t\t\t\t\t(ENI) limit for any new container instances that support the feature is changed.\n\t\t\t\t\tIf awsvpcTrunking is turned on, any new container instances that\n\t\t\t\t\tsupport the feature are launched have the increased ENI limits available to\n\t\t\t\t\tthem. For more information, see Elastic\n\t\t\t\t\t\tNetwork Interface Trunking in the Amazon Elastic Container Service Developer Guide.
\n containerInsights - Container Insights with enhanced\n\t\t\t\t\tobservability provides all the Container Insights metrics, plus additional task\n\t\t\t\t\tand container metrics. This version supports enhanced observability for Amazon ECS\n\t\t\t\t\tclusters using the Amazon EC2 and Fargate launch types. After you configure\n\t\t\t\t\tContainer Insights with enhanced observability on Amazon ECS, Container Insights\n\t\t\t\t\tauto-collects detailed infrastructure telemetry from the cluster level down to\n\t\t\t\t\tthe container level in your environment and displays these critical performance\n\t\t\t\t\tdata in curated dashboards removing the heavy lifting in observability set-up.
To use Container Insights with enhanced observability, set the\n\t\t\t\t\t\tcontainerInsights account setting to\n\t\t\t\t\tenhanced.
To use Container Insights, set the containerInsights account\n\t\t\t\t\tsetting to enabled.
For more information, see Monitor Amazon ECS containers using Container Insights with enhanced\n\t\t\t\t\t\tobservability in the Amazon Elastic Container Service Developer Guide.
\n\n dualStackIPv6 - When turned on, when using a VPC in dual stack\n\t\t\t\t\tmode, your tasks using the awsvpc network mode can have an IPv6\n\t\t\t\t\taddress assigned. For more information on using IPv6 with tasks launched on\n\t\t\t\t\tAmazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6\n\t\t\t\t\twith tasks launched on Fargate, see Using a VPC in dual-stack mode.
\n fargateFIPSMode - If you specify fargateFIPSMode,\n\t\t\t\t\tFargate FIPS 140 compliance is affected.
\n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a\n\t\t\t\t\tsecurity or infrastructure update is needed for an Amazon ECS task hosted on\n\t\t\t\t\tFargate, the tasks need to be stopped and new tasks launched to replace them.\n\t\t\t\t\tUse fargateTaskRetirementWaitPeriod to configure the wait time to\n\t\t\t\t\tretire a Fargate task. For information about the Fargate tasks maintenance,\n\t\t\t\t\tsee Amazon Web Services Fargate\n\t\t\t\t\t\ttask maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n tagResourceAuthorization - Amazon ECS is introducing tagging\n\t\t\t\t\tauthorization for resource creation. Users must have permissions for actions\n\t\t\t\t\tthat create the resource, such as ecsCreateCluster. If tags are\n\t\t\t\t\tspecified when you create a resource, Amazon Web Services performs additional authorization to\n\t\t\t\t\tverify if users or roles have permissions to create tags. Therefore, you must\n\t\t\t\t\tgrant explicit permissions to use the ecs:TagResource action. For\n\t\t\t\t\tmore information, see Grant permission to tag resources on creation in the\n\t\t\t\t\t\tAmazon ECS Developer Guide.
\n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled, disabled, on, enhanced,\n\t\t\tand off.
When you specify fargateTaskRetirementWaitPeriod for the\n\t\t\t\tname, the following are the valid values:
\n 0 - Amazon Web Services sends the notification, and immediately retires the\n\t\t\t\t\taffected tasks.
\n 7 - Amazon Web Services sends the notification, and waits 7 calendar days to\n\t\t\t\t\tretire the tasks.
\n 14 - Amazon Web Services sends the notification, and waits 14 calendar days to\n\t\t\t\t\tretire the tasks.
The current setting for a resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#PutAccountSettingRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#SettingName", + "traits": { + "smithy.api#documentation": "The Amazon ECS account setting name to modify.
\nThe following are the valid values for the account setting name.
\n\n serviceLongArnFormat - When modified, the Amazon Resource Name\n\t\t\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting\n\t\t\t\t\tmust be set for each Amazon ECS resource separately. The ARN and resource ID format\n\t\t\t\t\tof a resource is defined by the opt-in status of the user or role that created\n\t\t\t\t\tthe resource. You must turn on this setting to use Amazon ECS features such as\n\t\t\t\t\tresource tagging.
\n taskLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the\n\t\t\t\t\troot user for an account is affected. The opt-in and opt-out account setting must\n\t\t\t\t\tbe set for each Amazon ECS resource separately. The ARN and resource ID format of a\n\t\t\t\t\tresource is defined by the opt-in status of the user or role that created the\n\t\t\t\t\tresource. You must turn on this setting to use Amazon ECS features such as resource\n\t\t\t\t\ttagging.
\n fargateFIPSMode - When turned on, you can run Fargate workloads\n\t\t\t\t\tin a manner that is compliant with Federal Information Processing Standard\n\t\t\t\t\t(FIPS-140). For more information, see Fargate\n\t\t\t\t\t\tFederal Information Processing Standard (FIPS-140).
\n containerInstanceLongArnFormat - When modified, the Amazon\n\t\t\t\t\tResource Name (ARN) and resource ID format of the resource type for a specified\n\t\t\t\t\tuser, role, or the root user for an account is affected. The opt-in and opt-out\n\t\t\t\t\taccount setting must be set for each Amazon ECS resource separately. The ARN and\n\t\t\t\t\tresource ID format of a resource is defined by the opt-in status of the user or\n\t\t\t\t\trole that created the resource. You must turn on this setting to use Amazon ECS\n\t\t\t\t\tfeatures such as resource tagging.
\n awsvpcTrunking - When modified, the elastic network interface\n\t\t\t\t\t(ENI) limit for any new container instances that support the feature is changed.\n\t\t\t\t\tIf awsvpcTrunking is turned on, any new container instances that\n\t\t\t\t\tsupport the feature are launched have the increased ENI limits available to\n\t\t\t\t\tthem. For more information, see Elastic\n\t\t\t\t\t\tNetwork Interface Trunking in the Amazon Elastic Container Service Developer Guide.
\n containerInsights - Container Insights with enhanced\n\t\t\t\t\tobservability provides all the Container Insights metrics, plus additional task\n\t\t\t\t\tand container metrics. This version supports enhanced observability for Amazon ECS\n\t\t\t\t\tclusters using the Amazon EC2 and Fargate launch types. After you configure\n\t\t\t\t\tContainer Insights with enhanced observability on Amazon ECS, Container Insights\n\t\t\t\t\tauto-collects detailed infrastructure telemetry from the cluster level down to\n\t\t\t\t\tthe container level in your environment and displays these critical performance\n\t\t\t\t\tdata in curated dashboards removing the heavy lifting in observability set-up.
To use Container Insights with enhanced observability, set the\n\t\t\t\t\t\tcontainerInsights account setting to\n\t\t\t\t\tenhanced.
To use Container Insights, set the containerInsights account\n\t\t\t\t\tsetting to enabled.
For more information, see Monitor Amazon ECS containers using Container Insights with enhanced\n\t\t\t\t\t\tobservability in the Amazon Elastic Container Service Developer Guide.
\n\n dualStackIPv6 - When turned on, when using a VPC in dual stack\n\t\t\t\t\tmode, your tasks using the awsvpc network mode can have an IPv6\n\t\t\t\t\taddress assigned. For more information on using IPv6 with tasks launched on\n\t\t\t\t\tAmazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6\n\t\t\t\t\twith tasks launched on Fargate, see Using a VPC in dual-stack mode.
\n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a\n\t\t\t\t\tsecurity or infrastructure update is needed for an Amazon ECS task hosted on\n\t\t\t\t\tFargate, the tasks need to be stopped and new tasks launched to replace them.\n\t\t\t\t\tUse fargateTaskRetirementWaitPeriod to configure the wait time to\n\t\t\t\t\tretire a Fargate task. For information about the Fargate tasks maintenance,\n\t\t\t\t\tsee Amazon Web Services Fargate\n\t\t\t\t\t\ttask maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n tagResourceAuthorization - Amazon ECS is introducing tagging\n\t\t\t\t\tauthorization for resource creation. Users must have permissions for actions\n\t\t\t\t\tthat create the resource, such as ecsCreateCluster. If tags are\n\t\t\t\t\tspecified when you create a resource, Amazon Web Services performs additional authorization to\n\t\t\t\t\tverify if users or roles have permissions to create tags. Therefore, you must\n\t\t\t\t\tgrant explicit permissions to use the ecs:TagResource action. For\n\t\t\t\t\tmore information, see Grant permission to tag resources on creation in the\n\t\t\t\t\t\tAmazon ECS Developer Guide.
\n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled, disabled, enhanced, on,\n\t\t\tand off.
When you specify fargateTaskRetirementWaitPeriod for the\n\t\t\t\tname, the following are the valid values:
\n 0 - Amazon Web Services sends the notification, and immediately retires the\n\t\t\t\t\taffected tasks.
\n 7 - Amazon Web Services sends the notification, and waits 7 calendar days to\n\t\t\t\t\tretire the tasks.
\n 14 - Amazon Web Services sends the notification, and waits 14 calendar days to\n\t\t\t\t\tretire the tasks.
The ARN of the principal, which can be a user, role, or the root user. If you specify\n\t\t\tthe root user, it modifies the account setting for all users, roles, and the root user of the\n\t\t\taccount unless a user or role explicitly overrides these settings. If this field is\n\t\t\tomitted, the setting is changed only for the authenticated user.
\nYou must use the root user when you set the Fargate wait time\n\t\t\t\t\t(fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nThe current account setting for a resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#PutAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#PutAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ecs#PutAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AttributeLimitExceededException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#TargetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,\n\t\t\tit's created. If the attribute exists, its value is replaced with the specified value.\n\t\t\tTo delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#examples": [ + { + "title": "To create or update an attribute on a resource", + "documentation": "This example adds an attribute \"stack\" with the value \"production\" to a container instance.", + "input": { + "cluster": "MyCluster", + "attributes": [ + { + "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", + "name": "stack", + "value": "production" + } + ] + }, + "output": { + "attributes": [ + { + "name": "stack", + "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", + "value": "production" + } + ] + } + } + ] + } + }, + "com.amazonaws.ecs#PutAttributesRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" + } + }, + "attributes": { + "target": "com.amazonaws.ecs#Attributes", + "traits": { + "smithy.api#documentation": "The attributes to apply to your resource. You can specify up to 10 custom attributes\n\t\t\tfor each resource. You can specify up to 10 attributes in a single call.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#PutAttributesResponse": { + "type": "structure", + "members": { + "attributes": { + "target": "com.amazonaws.ecs#Attributes", + "traits": { + "smithy.api#documentation": "The attributes applied to your resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#PutClusterCapacityProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#PutClusterCapacityProvidersRequest" + }, + "output": { + "target": "com.amazonaws.ecs#PutClusterCapacityProvidersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ResourceInUseException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UpdateInProgressException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.
\nYou must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers that are associated with a\n\t\t\tcluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the\n\t\t\tcluster. You can only disassociate an existing capacity provider from a cluster if it's\n\t\t\tnot being used by any existing tasks.
\nWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tWe recommend that you define a default capacity provider strategy for your cluster.\n\t\t\tHowever, you must specify an empty array ([]) to bypass defining a default\n\t\t\tstrategy.
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n\t\t\tsettings for. If you don't specify a cluster, the default cluster is assumed.
", + "smithy.api#required": {} + } + }, + "capacityProviders": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The name of one or more capacity providers to associate with the cluster.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The capacity provider strategy to use by default for the cluster.
\nWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified then the default capacity provider strategy for the cluster is\n\t\t\tused.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity provider\n\t\t\twith a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
Details about the cluster.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#RegisterContainerInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#RegisterContainerInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ecs#RegisterContainerInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nRegisters an EC2 instance into the specified cluster. This instance becomes available\n\t\t\tto place containers on.
" + } + }, + "com.amazonaws.ecs#RegisterContainerInstanceRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance\n\t\t\twith. If you do not specify a cluster, the default cluster is assumed.
" + } + }, + "instanceIdentityDocument": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The instance identity document for the EC2 instance to register. This document can be\n\t\t\tfound by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/document/\n
The instance identity document signature for the EC2 instance to register. This\n\t\t\tsignature can be found by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/signature/\n
The resources available on the instance.
" + } + }, + "versionInfo": { + "target": "com.amazonaws.ecs#VersionInfo", + "traits": { + "smithy.api#documentation": "The version information for the Amazon ECS container agent and Docker daemon that runs on\n\t\t\tthe container instance.
" + } + }, + "containerInstanceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the container instance (if it was previously registered).
" + } + }, + "attributes": { + "target": "com.amazonaws.ecs#Attributes", + "traits": { + "smithy.api#documentation": "The container instance attributes that this container instance supports.
" + } + }, + "platformDevices": { + "target": "com.amazonaws.ecs#PlatformDevices", + "traits": { + "smithy.api#documentation": "The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The container instance that was registered.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#RegisterTaskDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#RegisterTaskDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.ecs#RegisterTaskDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
You can specify a role for your task with the taskRoleArn parameter. When\n\t\t\tyou specify a role for a task, its containers can then use the latest versions of the\n\t\t\tCLI or SDKs to make API requests to the Amazon Web Services services that are specified in the\n\t\t\tpolicy that's associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with the task\n\t\t\tdefinition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
You must specify a family for a task definition. You can use it track\n\t\t\tmultiple versions of the same task definition. The family is used as a name\n\t\t\tfor your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can\n\t\t\tassume. All containers in this task are granted the permissions that are specified in\n\t\t\tthis role. For more information, see IAM Roles for\n\t\t\t\tTasks in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "networkMode": { + "target": "com.amazonaws.ecs#NetworkMode", + "traits": { + "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task.
", + "smithy.api#required": {} + } + }, + "volumes": { + "target": "com.amazonaws.ecs#VolumeList", + "traits": { + "smithy.api#documentation": "A list of volume definitions in JSON format that containers in your task might\n\t\t\tuse.
" + } + }, + "placementConstraints": { + "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", + "traits": { + "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify a\n\t\t\tmaximum of 10 constraints for each task. This limit includes constraints in the task\n\t\t\tdefinition and those specified at runtime.
" + } + }, + "requiresCompatibilities": { + "target": "com.amazonaws.ecs#CompatibilityList", + "traits": { + "smithy.api#documentation": "The task launch type that Amazon ECS validates the task definition against. A client\n\t\t\texception is returned if the task definition doesn't validate against the\n\t\t\tcompatibilities specified. If no value is specified, the parameter is omitted from the\n\t\t\tresponse.
" + } + }, + "cpu": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, 1024) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU or 1 vcpu) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\nIf you're using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128 CPU units (0.125 vCPUs) and\n\t\t\t\t10240 CPU units (10 vCPUs). If you do not specify a value,\n\t\t\tthe parameter is ignored.
If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB (for example ,1024) or as a string using GB (for example,\n\t\t\t\t1GB or 1 GB) in a task definition. String values are\n\t\t\tconverted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\nIf using the EC2 launch type, this field is optional.
\nIf using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values. This determines your range of supported values for the\n\t\t\t\tcpu parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The metadata that you apply to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both of them.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe configuration details for the App Mesh proxy.
\nFor tasks hosted on Amazon EC2 instances, the container instances require at least version\n\t\t\t\t1.26.0 of the container agent and at least version\n\t\t\t\t1.26.0-1 of the ecs-init package to use a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS-optimized\n\t\t\tAMI version 20190301 or later, then they contain the required versions of\n\t\t\tthe container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
The Elastic Inference accelerators to use for the containers in the task.
" + } + }, + "ephemeralStorage": { + "target": "com.amazonaws.ecs#EphemeralStorage", + "traits": { + "smithy.api#documentation": "The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in\n\t\t\t\ttasks in the Amazon ECS Developer Guide.
\nFor tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The operating system that your tasks definitions run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
" + } + }, + "enableFaultInjection": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Enables fault injection when you register your task definition and allows for fault injection requests \n\t\t\tto be accepted from the task's containers. The default value is false.
The full description of the registered task definition.
" + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The list of tags associated with the task definition.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#RepositoryCredentials": { + "type": "structure", + "members": { + "credentialsParameter": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.
\nWhen you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same\n\t\t\t\tRegion as the task that you're launching then you can use either the full ARN or\n\t\t\t\tthe name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN\n\t\t\t\tof the secret.
\nThe repository credentials for private registry authentication.
" + } + }, + "com.amazonaws.ecs#RequiresAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Attribute" + } + }, + "com.amazonaws.ecs#Resource": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the resource, such as CPU, MEMORY,\n\t\t\t\tPORTS, PORTS_UDP, or a user-defined resource.
The type of the resource. Valid values: INTEGER, DOUBLE,\n\t\t\t\tLONG, or STRINGSET.
When the doubleValue type is set, the value of the resource must be a\n\t\t\tdouble precision floating-point type.
When the longValue type is set, the value of the resource must be an\n\t\t\textended precision floating-point type.
When the integerValue type is set, the value of the resource must be an\n\t\t\tinteger.
When the stringSetValue type is set, the value of the resource must be a\n\t\t\tstring type.
Describes the resources available for a container instance.
" + } + }, + "com.amazonaws.ecs#ResourceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#String" + } + }, + "com.amazonaws.ecs#ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource is in-use and can't be removed.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource wasn't found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#ResourceRequirement": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The value for the specified resource type.
\nWhen the type is GPU, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the\n\t\t\t\tdeviceName for an InferenceAccelerator specified in a task definition.
The type of resource to assign to a container.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The type and amount of a resource to assign to a container. The supported resource\n\t\t\ttypes are GPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with Amazon Elastic\n\t\t\t\tInference on Amazon ECS in the Amazon Elastic Container Service Developer Guide\n
" + } + }, + "com.amazonaws.ecs#ResourceRequirements": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ResourceRequirement" + } + }, + "com.amazonaws.ecs#ResourceType": { + "type": "enum", + "members": { + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GPU" + } + }, + "INFERENCE_ACCELERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InferenceAccelerator" + } + } + } + }, + "com.amazonaws.ecs#Resources": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Resource" + } + }, + "com.amazonaws.ecs#Rollback": { + "type": "structure", + "members": { + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The reason the rollback happened. For example, the circuit breaker initiated the\n\t\t\trollback operation.
" + } + }, + "startedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "Time time that the rollback started. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
" + } + }, + "serviceRevisionArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service revision deployed as part of the rollback.
\nWhen the type is GPU, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the\n\t\t\t\tdeviceName for an InferenceAccelerator specified in a task definition.
Information about the service deployment rollback.
" + } + }, + "com.amazonaws.ecs#RunTask": { + "type": "operation", "input": { - "name": "MyCapacityProvider", - "autoScalingGroupProvider": { - "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG", - "managedScaling": { - "status": "ENABLED", - "targetCapacity": 100 + "target": "com.amazonaws.ecs#RunTaskRequest" + }, + "output": { + "target": "com.amazonaws.ecs#RunTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#BlockedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#ConflictException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#PlatformTaskDefinitionIncompatibilityException" + }, + { + "target": "com.amazonaws.ecs#PlatformUnknownException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a new task using the specified task definition.
\nOn March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.
\nAlternatively, you can use StartTask to use your own scheduler or place\n\t\t\ttasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
\nThe Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.
\nTo manage eventual consistency, you can do the following:
\nConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\nAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\nThe capacity provider strategy to use for the task.
\nIf a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.
A capacity provider strategy can contain a maximum of 20 capacity providers.
" + } + }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to run your task on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + } + }, + "count": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The number of instantiations of the specified task to place on your cluster. You can\n\t\t\tspecify up to 10 tasks for each call.
" + } + }, + "enableECSManagedTags": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to use Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "enableExecuteCommand": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Determines whether to use the execute command functionality for the containers in this\n\t\t\ttask. If true, this enables execute command functionality on all containers\n\t\t\tin the task.
If true, then the task definition must have a task role, or you must\n\t\t\tprovide one as an override.
The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
The infrastructure to run your standalone task on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
\nThe FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.
Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS Developer Guide.
\nThe EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.
The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.
When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.
The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it isn't supported for other network modes. For more information,\n\t\t\tsee Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\tformatting characters of the override structure.
" + } + }, + "placementConstraints": { + "target": "com.amazonaws.ecs#PlacementConstraints", + "traits": { + "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify up to 10\n\t\t\tconstraints for each task (including constraints in the task definition and those\n\t\t\tspecified at runtime).
" + } + }, + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", + "traits": { + "smithy.api#documentation": "The placement strategy objects to use for the task. You can specify a maximum of 5\n\t\t\tstrategy rules for each task.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The platform version the task uses. A platform version is only specified for tasks\n\t\t\thosted on Fargate. If one isn't specified, the LATEST\n\t\t\tplatform version is used. For more information, see Fargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.
Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use theTagResource API action.
\nAn error will be received if you specify the SERVICE option when\n\t\t\t\trunning a task.
This parameter is only used by Amazon ECS. It is not intended for use by customers.
" + } + }, + "startedBy": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call with\n\t\t\tthe startedBy value. Up to 128 letters (uppercase and lowercase), numbers,\n\t\t\thyphens (-), forward slash (/), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.
The full ARN value must match the value that you specified as the\n\t\t\t\tResource of the principal's permissions policy.
When you specify a task definition, you must either specify a specific revision, or\n\t\t\tall revisions in the ARN.
\nTo specify a specific revision, include the revision number in the ARN. For example,\n\t\t\tto specify revision 2, use\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.
To specify all revisions, use the wildcard (*) in the ARN. For example, to specify\n\t\t\tall revisions, use\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "An identifier that you provide to ensure the idempotency of the request. It must be\n\t\t\tunique and is case sensitive. Up to 64 characters are allowed. The valid characters are\n\t\t\tcharacters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "volumeConfigurations": { + "target": "com.amazonaws.ecs#TaskVolumeConfigurations", + "traits": { + "smithy.api#documentation": "The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name of the volume must\n\t\t\tmatch the name from the task definition.
A full description of the tasks that were run. The tasks that were successfully placed\n\t\t\ton your cluster are described here.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
\nFor information about how to address failures, see Service event messages and API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#RuntimePlatform": { + "type": "structure", + "members": { + "cpuArchitecture": { + "target": "com.amazonaws.ecs#CPUArchitecture", + "traits": { + "smithy.api#documentation": "The CPU architecture.
\nYou can run your Linux tasks on an ARM-based platform by setting the value to\n\t\t\t\tARM64. This option is available for tasks that run on Linux Amazon EC2\n\t\t\tinstance or Linux containers on Fargate.
The operating system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the platform for the Amazon ECS service or task.
\nFor more information about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.
The value, specified as a percent total of a service's desiredCount, to\n\t\t\tscale the task set. Accepted values are numbers between 0 and 100.
The unit of measure for the scale value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" + } + }, + "com.amazonaws.ecs#ScaleUnit": { + "type": "enum", + "members": { + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT" + } + } + } + }, + "com.amazonaws.ecs#SchedulingStrategy": { + "type": "enum", + "members": { + "REPLICA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICA" + } + }, + "DAEMON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAEMON" + } + } + } + }, + "com.amazonaws.ecs#Scope": { + "type": "enum", + "members": { + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "task" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "shared" + } + } + } + }, + "com.amazonaws.ecs#Secret": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the secret.
", + "smithy.api#required": {} + } + }, + "valueFrom": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The secret to expose to the container. The supported values are either the full ARN\n\t\t\tof the Secrets Manager secret or the full ARN of the parameter in the SSM\n\t\t\tParameter Store.
\nFor information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or\n\t\t\t\tRequired IAM permissions for Amazon ECS secrets (for Systems Manager Parameter\n\t\t\tstore) in the Amazon Elastic Container Service Developer Guide.
\nIf the SSM Parameter Store parameter exists in the same Region as the task\n\t\t\t\tyou're launching, then you can use either the full ARN or name of the parameter.\n\t\t\t\tIf the parameter exists in a different Region, then the full ARN must be\n\t\t\t\tspecified.
\nAn object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:
\nTo inject sensitive data into your containers as environment variables, use\n\t\t\t\t\tthe secrets container definition parameter.
To reference sensitive information in the log configuration of a container,\n\t\t\t\t\tuse the secretOptions container definition parameter.
For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#SecretList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Secret" + } + }, + "com.amazonaws.ecs#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ecs#ServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "These errors are usually caused by a server issue.
", + "smithy.api#error": "server" + } + }, + "com.amazonaws.ecs#Service": { + "type": "structure", + "members": { + "serviceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN that identifies the service. For more information about the ARN format,\n\t\t\tsee Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" + } + }, + "serviceName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster. However, you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
" + } + }, + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that hosts the service.
" + } + }, + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", + "traits": { + "smithy.api#documentation": "A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.
" + } + }, + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", + "traits": { + "smithy.api#documentation": "The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the service. The valid values are ACTIVE,\n\t\t\t\tDRAINING, or INACTIVE.
The desired number of instantiations of the task definition to keep running on the\n\t\t\tservice. This value is specified when the service is created with CreateService , and it can be modified with UpdateService.
" + } + }, + "runningCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The launch type the service is using. When using the DescribeServices API, this field\n\t\t\tis omitted if the service was created using a capacity provider strategy.
" + } + }, + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "The capacity provider strategy the service uses. When using the DescribeServices API,\n\t\t\tthis field is omitted if the service was created using a launch type.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The platform version to run your service on. A platform version is only specified for\n\t\t\ttasks that are hosted on Fargate. If one isn't specified, the LATEST\n\t\t\tplatform version is used. For more information, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
\n All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX).
The task definition to use for tasks in the service. This value is specified when the\n\t\t\tservice is created with CreateService,\n\t\t\tand it can be modified with UpdateService.
" + } + }, + "deploymentConfiguration": { + "target": "com.amazonaws.ecs#DeploymentConfiguration", + "traits": { + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" + } + }, + "taskSets": { + "target": "com.amazonaws.ecs#TaskSets", + "traits": { + "smithy.api#documentation": "Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
The current state of deployments for the service.
" + } + }, + "roleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that's associated with the service. It allows the Amazon ECS\n\t\t\tcontainer agent to register container instances with an Elastic Load Balancing load balancer.
" + } + }, + "events": { + "target": "com.amazonaws.ecs#ServiceEvents", + "traits": { + "smithy.api#documentation": "The event stream for your service. A maximum of 100 of the latest events are\n\t\t\tdisplayed.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the service was created.
" + } + }, + "placementConstraints": { + "target": "com.amazonaws.ecs#PlacementConstraints", + "traits": { + "smithy.api#documentation": "The placement constraints for the tasks in the service.
" + } + }, + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", + "traits": { + "smithy.api#documentation": "The placement strategy that determines how tasks for the service are placed.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started.
" + } + }, + "schedulingStrategy": { + "target": "com.amazonaws.ecs#SchedulingStrategy", + "traits": { + "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available.
\n\n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement\n\t\t\t\t\tdecisions.
\n DAEMON-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance. This task meets all of the task\n\t\t\t\t\tplacement constraints that you specify in your cluster. The service scheduler\n\t\t\t\t\talso evaluates the task placement constraints for running tasks. It stop tasks\n\t\t\t\t\tthat don't meet the placement constraints.
Fargate tasks don't support the DAEMON\n\t\t\t\t\t\tscheduling strategy.
The deployment controller type the service is using.
" + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define bot the key and\n\t\t\tvalue.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The principal that created the service.
" + } + }, + "enableECSManagedTags": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Determines whether to use Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateTags", + "traits": { + "smithy.api#documentation": "Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.
" + } + }, + "enableExecuteCommand": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, the execute command functionality is turned on for all containers\n\t\t\tin tasks as part of the service.
Indicates whether to use Availability Zone rebalancing for the service.
\nFor more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
" + } + } }, - "output": { - "capacityProvider": { - "capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider", - "name": "MyCapacityProvider", - "status": "ACTIVE", - "autoScalingGroupProvider": { - "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG", - "managedScaling": { - "status": "ENABLED", - "targetCapacity": 100, - "minimumScalingStepSize": 1, - "maximumScalingStepSize": 10000, - "instanceWarmupPeriod": 300 - }, - "managedTerminationProtection": "ENABLED" - }, - "tags": [] - } - } - } - ] - } - }, - "com.amazonaws.ecs#CreateCapacityProviderRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the capacity provider. Up to 255 characters are allowed. They include\n\t\t\tletters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-).\n\t\t\tThe name can't be prefixed with \"aws\", \"ecs\", or\n\t\t\t\t\"fargate\".
The details of the Auto Scaling group for the capacity provider.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The metadata that you apply to the capacity provider to categorize and organize them\n\t\t\tmore conveniently. Each tag consists of a key and an optional value. You define both of\n\t\t\tthem.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The full description of the new capacity provider.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#CreateCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#CreateClusterRequest" - }, - "output": { - "target": "com.amazonaws.ecs#CreateClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#NamespaceNotFoundException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name.
When you call the CreateCluster\n\t\t\t\tAPI operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your\n\t\t\t\taccount. This is so that it can manage required resources in other Amazon Web Services services on\n\t\t\t\tyour behalf. However, if the user that makes the call doesn't have permissions to\n\t\t\t\tcreate the service-linked role, it isn't created. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
\nDetails on a service within a cluster.
" + } + }, + "com.amazonaws.ecs#ServiceConnectClientAlias": { + "type": "structure", + "members": { + "port": { + "target": "com.amazonaws.ecs#PortNumber", + "traits": { + "smithy.api#documentation": "The listening port number for the Service Connect proxy. This port is available\n\t\t\tinside of all of the tasks within the same namespace.
\nTo avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tport that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#required": {} + } + }, + "dnsName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The dnsName is the name that you use in the applications of client tasks\n\t\t\tto connect to this service. The name must be a valid DNS name but doesn't need to be\n\t\t\tfully-qualified. The name can include up to 127 characters. The name can include\n\t\t\tlowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name\n\t\t\tcan't start with a hyphen.
If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tname that the client application uses by default. For example, a few common names are\n\t\t\t\tdatabase, db, or the lowercase name of a database, such as\n\t\t\t\tmysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
The name of your cluster. If you don't specify a name for your cluster, you create a\n\t\t\tcluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The setting to use when creating a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The execute command configuration for the cluster.
The short name of one or more capacity providers to associate with the cluster. A\n\t\t\tcapacity provider must be associated with a cluster before it can be included as part of\n\t\t\tthe default capacity provider strategy of the cluster or used in a capacity provider\n\t\t\tstrategy when calling the CreateService or\n\t\t\t\tRunTask actions.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must be created but not associated with another cluster. New Auto Scaling group\n\t\t\tcapacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutCapacityProvider API operation is used to update the list of available\n\t\t\tcapacity providers for a cluster after the cluster is created.
" - } - }, - "defaultCapacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", - "traits": { - "smithy.api#documentation": "The capacity provider strategy to set as the default for the cluster. After a default\n\t\t\tcapacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no\n\t\t\tcapacity provider strategy or launch type specified, the default capacity provider\n\t\t\tstrategy for the cluster is used.
\nIf a default capacity provider strategy isn't defined for a cluster when it was\n\t\t\tcreated, it can be defined later with the PutClusterCapacityProviders API operation.
" - } - }, - "serviceConnectDefaults": { - "target": "com.amazonaws.ecs#ClusterServiceConnectDefaultsRequest", - "traits": { - "smithy.api#documentation": "Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#CreateClusterResponse": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#Cluster", - "traits": { - "smithy.api#documentation": "The full description of your new cluster.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#CreateService": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#CreateServiceRequest" - }, - "output": { - "target": "com.amazonaws.ecs#CreateServiceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" + "traits": { + "smithy.api#documentation": "Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks\n\t\t\t(\"clients\") can use to connect to this service.
\nEach name and port mapping must be unique within the namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#ServiceConnectClientAliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceConnectClientAlias" + } + }, + "com.amazonaws.ecs#ServiceConnectConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to use Service Connect with this service.
", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in\n\t\t\tthe same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't\n\t\t\taffect Service Connect. For more information about Cloud Map, see Working\n\t\t\t\twith Services in the Cloud Map Developer Guide.
" + } + }, + "services": { + "target": "com.amazonaws.ecs#ServiceConnectServiceList", + "traits": { + "smithy.api#documentation": "The list of Service Connect service objects. These are names and aliases (also known\n\t\t\tas endpoints) that are used by other Amazon ECS services to connect to this service.\n\t\t\t
\nThis field is not required for a \"client\" Amazon ECS service that's a member of a namespace\n\t\t\tonly to connect to other services within the namespace. An example of this would be a\n\t\t\tfrontend application that accepts incoming requests from either a load balancer that's\n\t\t\tattached to the service or by other means.
\nAn object selects a port from the task definition, assigns a name for the Cloud Map\n\t\t\tservice, and a list of aliases (endpoints) and ports for client applications to refer to\n\t\t\tthis service.
" + } + }, + "logConfiguration": { + "target": "com.amazonaws.ecs#LogConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "The Service Connect configuration of your Amazon ECS service. The configuration for this\n\t\t\tservice to discover and connect to services, and be discovered by, and connected from,\n\t\t\tother services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#ServiceConnectService": { + "type": "structure", + "members": { + "portName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The portName must match the name of one of the portMappings\n\t\t\tfrom all the containers in the task definition of this Amazon ECS service.
The discoveryName is the name of the new Cloud Map service that Amazon ECS creates\n\t\t\tfor this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,\n\t\t\tnumbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
The list of client aliases for this Service Connect service. You use these to assign\n\t\t\tnames that can be used by client applications. The maximum number of client aliases that\n\t\t\tyou can have in this list is 1.
\nEach alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS\n\t\t\ttasks (\"clients\") can use to connect to this service.
\nEach name and port mapping must be unique within the namespace.
\nFor each ServiceConnectService, you must provide at least one\n\t\t\t\tclientAlias with one port.
The port number for the Service Connect proxy to listen on.
\nUse the value of this field to bypass the proxy for traffic on the port number\n\t\t\tspecified in the named portMapping in the task definition of this\n\t\t\tapplication, and then use it in your VPC security groups to allow traffic into the proxy\n\t\t\tfor this Amazon ECS service.
In awsvpc mode and Fargate, the default value is the container port\n\t\t\tnumber. The container port number is in the portMapping in the task\n\t\t\tdefinition. In bridge mode, the default value is the ephemeral port of the\n\t\t\tService Connect proxy.
A reference to an object that represents the configured timeouts for\n\t\t\tService Connect.
" + } + }, + "tls": { + "target": "com.amazonaws.ecs#ServiceConnectTlsConfiguration", + "traits": { + "smithy.api#documentation": "A reference to an object that represents a Transport Layer Security (TLS)\n\t\t\tconfiguration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#ServiceConnectServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceConnectService" + } + }, + "com.amazonaws.ecs#ServiceConnectServiceResource": { + "type": "structure", + "members": { + "discoveryName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The discovery name of this Service Connect resource.
\nThe discoveryName is the name of the new Cloud Map service that Amazon ECS creates\n\t\t\tfor this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,\n\t\t\tnumbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this\n\t\t\tService Connect resource. You can use this ARN in other integrations with Cloud Map.\n\t\t\tHowever, Service Connect can't ensure connectivity outside of Amazon ECS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Service Connect resource. Each configuration maps a discovery name to a\n\t\t\tCloud Map service name. The data is stored in Cloud Map as part of the\n\t\t\tService Connect configuration for each discovery name of this Amazon ECS service.
\nA task can resolve the dnsName for each of the clientAliases\n\t\t\tof a service. However a task can't resolve the discovery names. If you want to connect\n\t\t\tto a service, refer to the ServiceConnectConfiguration of that service for\n\t\t\tthe list of clientAliases that you can use.
The ARN of the Amazon Web Services Private Certificate Authority certificate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The certificate root authority that secures your service.
" + } + }, + "com.amazonaws.ecs#ServiceConnectTlsConfiguration": { + "type": "structure", + "members": { + "issuerCertificateAuthority": { + "target": "com.amazonaws.ecs#ServiceConnectTlsCertificateAuthority", + "traits": { + "smithy.api#documentation": "The signer certificate authority.
", + "smithy.api#required": {} + } + }, + "kmsKey": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service key.
" + } + }, + "roleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The key that encrypts and decrypts your resources for Service Connect TLS.
" + } + }, + "com.amazonaws.ecs#ServiceDeployment": { + "type": "structure", + "members": { + "serviceDeploymentArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service deployment.
" + } + }, + "serviceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service for this service deployment.
" + } + }, + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the cluster that hosts the service.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the service deployment was created. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "startedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the service deployment statred. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "finishedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the service deployment finished. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "stoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the service deployment stopped. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
\nThe service deployment stops when any of the following actions happen:
\nA user manually stops the deployment
\nThe rollback option is not in use for the failure detection mechanism (the\n\t\t\t\t\tcircuit breaker or alarm-based) and the service fails.
\nThe time that the service deployment was last updated. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "sourceServiceRevisions": { + "target": "com.amazonaws.ecs#ServiceRevisionsSummaryList", + "traits": { + "smithy.api#documentation": "The currently deployed workload configuration.
" + } + }, + "targetServiceRevision": { + "target": "com.amazonaws.ecs#ServiceRevisionSummary", + "traits": { + "smithy.api#documentation": "The workload configuration being deployed.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#ServiceDeploymentStatus", + "traits": { + "smithy.api#documentation": "The service deployment state.
" + } + }, + "statusReason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Information about why the service deployment is in the current status. For example,\n\t\t\tthe circuit breaker detected a failure.
" + } + }, + "deploymentConfiguration": { + "target": "com.amazonaws.ecs#DeploymentConfiguration" + }, + "rollback": { + "target": "com.amazonaws.ecs#Rollback", + "traits": { + "smithy.api#documentation": "The rollback options the service deployment uses when the deployment fails.
" + } + }, + "deploymentCircuitBreaker": { + "target": "com.amazonaws.ecs#ServiceDeploymentCircuitBreaker", + "traits": { + "smithy.api#documentation": "The circuit breaker configuration that determines a service deployment failed.
" + } + }, + "alarms": { + "target": "com.amazonaws.ecs#ServiceDeploymentAlarms", + "traits": { + "smithy.api#documentation": "The CloudWatch alarms that determine when a service deployment fails.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the service deployment.
\nService deployments provide a comprehensive view of your deployments. For information\n\t\t\tabout service deployments, see View service history\n\t\t\t\tusing Amazon ECS service deployments in the\n\t\t\t\n Amazon Elastic Container Service Developer Guide\n .
" + } + }, + "com.amazonaws.ecs#ServiceDeploymentAlarms": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus", + "traits": { + "smithy.api#documentation": "The status of the alarms check. Amazon ECS is not using alarms for service deployment\n\t\t\tfailures when the status is DISABLED.
The name of the CloudWatch alarms that determine when a service deployment failed. A\n\t\t\t\",\" separates the alarms.
" + } + }, + "triggeredAlarmNames": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "One or more CloudWatch alarm names that have been triggered during the service\n\t\t\tdeployment. A \",\" separates the alarm names.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The CloudWatch alarms used to determine a service deployment failed.
\nAmazon ECS considers the service deployment as failed when any of the alarms move to\n\t\t\tthe ALARM state. For more information, see How CloudWatch\n\t\t\t\talarms detect Amazon ECS deployment failures in the Amazon ECS Developer\n\t\t\tGuide.
The ARN of the service deployment.
" + } + }, + "serviceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service for this service deployment.
" + } + }, + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the cluster that hosts the service.
" + } + }, + "startedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the service deployment statred. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the service deployment was created. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "finishedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the service deployment completed. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "targetServiceRevisionArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service revision being deplyed.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#ServiceDeploymentStatus", + "traits": { + "smithy.api#documentation": "The status of the service deployment
" + } + }, + "statusReason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Information about why the service deployment is in the current status. For example,\n\t\t\tthe circuit breaker detected a deployment failure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The service deployment properties that are retured when you call\n\t\t\t\tListServiceDeployments.
This provides a high-level overview of the service deployment.
" + } + }, + "com.amazonaws.ecs#ServiceDeploymentCircuitBreaker": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus", + "traits": { + "smithy.api#documentation": "The circuit breaker status. Amazon ECS is not using the circuit breaker for service\n\t\t\tdeployment failures when the status is DISABLED.
The number of times the circuit breaker detected a service deploymeny failure.
" + } + }, + "threshold": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The threshhold which determines that the service deployment failed.
\nThe deployment circuit breaker calculates the threshold value, and then uses the value\n\t\t\tto determine when to move the deployment to a FAILED state. The deployment circuit\n\t\t\tbreaker has a minimum threshold of 3 and a maximum threshold of 200. and uses the values\n\t\t\tin the following formula to determine the deployment failure.
\n\n 0.5 * desired task count\n
Information about the circuit breaker used to determine when a service deployment has\n\t\t\tfailed.
\nThe deployment circuit breaker is the rolling update mechanism that determines if the\n\t\t\ttasks reach a steady state. The deployment circuit breaker has an option that will\n\t\t\tautomatically roll back a failed deployment to the last cpompleted service revision. For\n\t\t\tmore information, see How the Amazon\n\t\t\t\tECS deployment circuit breaker detects failures in the Amazon ECS\n\t\t\t\tDeveloper Guide.
" + } + }, + "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus": { + "type": "enum", + "members": { + "TRIGGERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIGGERED" + } + }, + "MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONITORING" + } + }, + "MONITORING_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONITORING_COMPLETE" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.ecs#ServiceDeploymentStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "STOP_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_REQUESTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" + } + }, + "ROLLBACK_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_SUCCESSFUL" + } + }, + "ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_FAILED" + } + } + } + }, + "com.amazonaws.ecs#ServiceDeploymentStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceDeploymentStatus" + } + }, + "com.amazonaws.ecs#ServiceDeployments": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceDeployment" + } + }, + "com.amazonaws.ecs#ServiceDeploymentsBrief": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceDeploymentBrief" + } + }, + "com.amazonaws.ecs#ServiceEvent": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID string for the event.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the event was triggered.
" + } + }, + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The event message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for an event that's associated with a service.
" + } }, - { - "target": "com.amazonaws.ecs#ClientException" + "com.amazonaws.ecs#ServiceEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceEvent" + } }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" + "com.amazonaws.ecs#ServiceField": { + "type": "enum", + "members": { + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGS" + } + } + } }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" + "com.amazonaws.ecs#ServiceFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceField" + } }, - { - "target": "com.amazonaws.ecs#NamespaceNotFoundException" + "com.amazonaws.ecs#ServiceManagedEBSVolumeConfiguration": { + "type": "structure", + "members": { + "encrypted": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether the volume should be encrypted. If no value is specified, encryption\n\t\t\tis turned on by default. This parameter maps 1:1 with the Encrypted\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When\n\t\t\tencryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key\n\t\t\tfor Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe volume type. This parameter maps 1:1 with the VolumeType parameter of\n\t\t\tthe CreateVolume API in the Amazon EC2 API Reference. For more\n\t\t\tinformation, see Amazon EBS volume types in\n\t\t\tthe Amazon EC2 User Guide.
The following are the supported volume types.
\nGeneral Purpose SSD: gp2|gp3\n
Provisioned IOPS SSD: io1|io2\n
Throughput Optimized HDD: st1\n
Cold HDD: sc1\n
Magnetic: standard\n
The magnetic volume type is not supported on Fargate.
\nThe size of the volume in GiB. You must specify either a volume size or a snapshot ID.\n\t\t\tIf you specify a snapshot ID, the snapshot size is used for the volume size by default.\n\t\t\tYou can optionally specify a volume size greater than or equal to the snapshot size.\n\t\t\tThis parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot\n\t\t\tID or a volume size. This parameter maps 1:1 with the SnapshotId parameter\n\t\t\tof the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3,\n\t\t\tio1, and io2 volumes, this represents the number of IOPS that\n\t\t\tare provisioned for the volume. For gp2 volumes, this represents the\n\t\t\tbaseline performance of the volume and the rate at which the volume accumulates I/O\n\t\t\tcredits for bursting.
The following are the supported values for each volume type.
\n\n gp3: 3,000 - 16,000 IOPS
\n io1: 100 - 64,000 IOPS
\n io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The\n\t\t\tdefault for gp3 volumes is 3,000 IOPS. This parameter is not\n\t\t\tsupported for st1, sc1, or standard volume\n\t\t\ttypes.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.\n\t\t\tThis parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This\n\t\t\tparameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS\n\t\t\tinfrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend\n\t\t\tusing the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM\n\t\t\tpolicy with this role. For more information, see Amazon ECS\n\t\t\t\tinfrastructure IAM role in the Amazon ECS Developer\n\t\t\tGuide.
The filesystem type for the volume. For volumes created from a snapshot, you must\n\t\t\tspecify the same filesystem type that the volume was using when the snapshot was\n\t\t\tcreated. If there is a filesystem type mismatch, the task will fail to start.
\nThe available Linux filesystem types are\u2028 ext3, ext4, and\n\t\t\t\txfs. If no value is specified, the xfs filesystem type is\n\t\t\tused by default.
The available Windows filesystem types are NTFS.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask in the service. For information about the supported launch types and operating\n\t\t\tsystems, see Supported operating systems and launch types in the Amazon Elastic Container Service\n\t\t\t\tDeveloper Guide.
\nMany of these parameters map 1:1 with the Amazon EBS CreateVolume API request\n\t\t\tparameters.
Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified service isn't active. You can't update a service that's inactive. If you\n\t\t\thave previously deleted a service, you can re-create it with CreateService.
", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.ecs#PlatformUnknownException" + "com.amazonaws.ecs#ServiceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region\n\t\t\tspecific.
", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.ecs#ServerException" + "com.amazonaws.ecs#ServiceRegistries": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceRegistry" + } }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, use UpdateService.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nIn addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nYou can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. volumeConfigurations is only supported for REPLICA\n\t\t\tservice and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.
There are two service scheduler strategies available:
\n\n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
\n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.
If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide\n
", - "smithy.api#examples": [ - { - "title": "To create a new service", - "documentation": "This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task.", - "input": { - "serviceName": "ecs-simple-service", - "taskDefinition": "hello_world", - "desiredCount": 10 + "com.amazonaws.ecs#ServiceRegistry": { + "type": "structure", + "members": { + "registryArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is\n\t\t\tCloud Map. For more information, see CreateService.
" + } + }, + "port": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The port value used if your service discovery service specified an SRV record. This\n\t\t\tfield might be used if both the awsvpc network mode and SRV records are\n\t\t\tused.
The container name value to be used for your service discovery service. It's already\n\t\t\tspecified in the task definition. If the task definition that your service task\n\t\t\tspecifies uses the bridge or host network mode, you must\n\t\t\tspecify a containerName and containerPort combination from the\n\t\t\ttask definition. If the task definition that your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.
The port value to be used for your service discovery service. It's already specified\n\t\t\tin the task definition. If the task definition your service task specifies uses the\n\t\t\t\tbridge or host network mode, you must specify a\n\t\t\t\tcontainerName and containerPort combination from the task\n\t\t\tdefinition. If the task definition your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.
The details for the service registry.
\nEach service may be associated with one service registry. Multiple service registries\n\t\t\tfor each service are not supported.
\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts a\n\t\t\tnew deployment. New tasks are registered and deregistered to the updated service\n\t\t\tregistry configuration.
" + } + }, + "com.amazonaws.ecs#ServiceRevision": { + "type": "structure", + "members": { + "serviceRevisionArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service revision.
" + } + }, + "serviceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service for the service revision.
" + } + }, + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the cluster that hosts the service.
" + } + }, + "taskDefinition": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The task definition the service revision uses.
" + } + }, + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "The capacity provider strategy the service revision uses.
" + } + }, + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", + "traits": { + "smithy.api#documentation": "The launch type the service revision uses.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "For the Fargate launch type, the platform version the service revision uses.
" + } + }, + "platformFamily": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The platform family the service revision uses.
" + } + }, + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", + "traits": { + "smithy.api#documentation": "The load balancers the service revision uses.
" + } + }, + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", + "traits": { + "smithy.api#documentation": "The service registries (for Service Discovery) the service revision uses.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration" + }, + "containerImages": { + "target": "com.amazonaws.ecs#ContainerImages", + "traits": { + "smithy.api#documentation": "The container images the service revision uses.
" + } + }, + "guardDutyEnabled": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether Runtime Monitoring is turned on.
" + } + }, + "serviceConnectConfiguration": { + "target": "com.amazonaws.ecs#ServiceConnectConfiguration" + }, + "volumeConfigurations": { + "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", + "traits": { + "smithy.api#documentation": "The volumes that are configured at deployment that the service revision uses.
" + } + }, + "fargateEphemeralStorage": { + "target": "com.amazonaws.ecs#DeploymentEphemeralStorage" + }, + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the service revision was created. The format is yyyy-mm-dd\n\t\t\tHH:mm:ss.SSSSS.
" + } + }, + "vpcLatticeConfigurations": { + "target": "com.amazonaws.ecs#VpcLatticeConfigurations", + "traits": { + "smithy.api#documentation": "The VPC Lattice configuration for the service revision.
" + } } - ], - "serviceName": "ecs-simple-service-elb", - "role": "ecsServiceRole", - "taskDefinition": "console-sample-app-static", - "desiredCount": 10 }, - "output": { - "service": { - "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", - "createdAt": "2016-08-29T16:02:54.884Z", - "deploymentConfiguration": { - "maximumPercent": 200, - "minimumHealthyPercent": 100 - }, - "deployments": [ - { - "createdAt": "2016-08-29T16:02:54.884Z", - "desiredCount": 10, - "id": "ecs-svc/9223370564343000923", - "pendingCount": 0, - "runningCount": 0, - "status": "PRIMARY", - "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6", - "updatedAt": "2016-08-29T16:02:54.884Z" - } - ], - "desiredCount": 10, - "events": [], - "loadBalancers": [ - { - "containerName": "simple-app", - "containerPort": 80, - "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2" - } - ], - "pendingCount": 0, - "roleArn": "arn:aws:iam::012345678910:role/ecsServiceRole", - "runningCount": 0, - "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service-elb", - "serviceName": "ecs-simple-service-elb", - "status": "ACTIVE", - "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/default/console-sample-app-static:6" - } - } - } - ] - } - }, - "com.amazonaws.ecs#CreateServiceRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" - } - }, - "serviceName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster, but you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
", - "smithy.api#required": {} - } - }, - "taskDefinition": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision\n\t\t\tisn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or\n\t\t\t\tCODE_DEPLOY deployment controllers.
For more information about deployment types, see Amazon ECS deployment\n\t\t\t\ttypes.
" - } - }, - "availabilityZoneRebalancing": { - "target": "com.amazonaws.ecs#AvailabilityZoneRebalancing", - "traits": { - "smithy.api#documentation": "Indicates whether to use Availability Zone rebalancing for the service.
\nFor more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
" - } - }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", - "traits": { - "smithy.api#documentation": "A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nIf the service uses the rolling update (ECS) deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.
If you use the CODE_DEPLOY deployment controller, these values can be\n\t\t\tchanged when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.
\nFor Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted.\n\t\t\tWhen a task from this service is placed on a container instance, the container instance\n\t\t\tis registered with the load balancer that's specified here.
\nServices with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.
The details of the service discovery registry to associate with this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
\nEach service may be associated with one service registry. Multiple service\n\t\t\t\tregistries for each service isn't supported.
\nThe number of instantiations of the specified task definition to place and keep\n\t\t\trunning in your service.
\nThis is required if schedulingStrategy is REPLICA or isn't\n\t\t\tspecified. If schedulingStrategy is DAEMON then this isn't\n\t\t\trequired.
An identifier that you provide to ensure the idempotency of the request. It must be\n\t\t\tunique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
" - } - }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", - "traits": { - "smithy.api#documentation": "The infrastructure that you run your service on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
\nThe FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.
Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the Amazon ECS\n\t\t\t\t\tDeveloper Guide.
\nThe EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.
The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.
The capacity provider strategy to use for the service.
\nIf a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy can contain a maximum of 20 capacity providers.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The platform version that your tasks in the service are running on. A platform version\n\t\t\tis specified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used. For more information, see\n\t\t\t\tFargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n\t\t\tload balancer on your behalf. This parameter is only permitted if you are using a load\n\t\t\tbalancer with your service and your task definition doesn't use the awsvpc\n\t\t\tnetwork mode. If you specify the role parameter, you must also specify a\n\t\t\tload balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is\n\t\t\t\tused for your service unless you specify a role here. The service-linked role is\n\t\t\t\trequired if your task definition uses the awsvpc network mode or if the\n\t\t\t\tservice is configured to use service discovery, an external deployment controller,\n\t\t\t\tmultiple target groups, or Elastic Inference accelerators in which case you don't\n\t\t\t\tspecify a role here. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /, then you must either\n\t\t\tspecify the full role ARN (this is recommended) or prefix the role name with the path.\n\t\t\tFor example, if a role with the name bar has a path of /foo/\n\t\t\tthen you would specify /foo/bar as the role name. For more information, see\n\t\t\t\tFriendly names and paths in the IAM User\n\t\t\tGuide.
Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" - } - }, - "placementConstraints": { - "target": "com.amazonaws.ecs#PlacementConstraints", - "traits": { - "smithy.api#documentation": "An array of placement constraint objects to use for tasks in your service. You can\n\t\t\tspecify a maximum of 10 constraints for each task. This limit includes constraints in\n\t\t\tthe task definition and those specified at runtime.
" - } - }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", - "traits": { - "smithy.api#documentation": "The placement strategy objects to use for tasks in your service. You can specify a\n\t\t\tmaximum of 5 strategy rules for each service.
" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "The network configuration for the service. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it isn't supported for other network modes. For more information,\n\t\t\tsee Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't\n\t\t\tspecify a health check grace period value, the default value of 0 is used.\n\t\t\tIf you don't use any of the health checks, then\n\t\t\t\thealthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can\n\t\t\tspecify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.
" - } - }, - "schedulingStrategy": { - "target": "com.amazonaws.ecs#SchedulingStrategy", - "traits": { - "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available:
\n\n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. This\n\t\t\t\t\tscheduler strategy is required if the service uses the CODE_DEPLOY\n\t\t\t\t\tor EXTERNAL deployment controller types.
\n DAEMON-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks and will stop tasks\n\t\t\t\t\tthat don't meet the placement constraints. When you're using this strategy, you\n\t\t\t\t\tdon't need to specify a desired number of tasks, a task placement strategy, or\n\t\t\t\t\tuse Service Auto Scaling policies.
Tasks using the Fargate launch type or the\n\t\t\t\t\t\t\tCODE_DEPLOY or EXTERNAL deployment controller\n\t\t\t\t\t\ttypes don't support the DAEMON scheduling strategy.
The deployment controller to use for the service. If no deployment controller is\n\t\t\tspecified, the default value of ECS is used.
The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging your Amazon ECS\n\t\t\t\tresources in the Amazon Elastic Container Service Developer Guide.
\nWhen you use Amazon ECS managed tags, you need to set the propagateTags\n\t\t\trequest parameter.
Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.
\nYou must set this to a value other than NONE when you use Cost Explorer.\n\t\t\tFor more information, see Amazon ECS usage reports\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The default is NONE.
Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe service tasks.
The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "volumeConfigurations": { - "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", - "traits": { - "smithy.api#documentation": "The configuration for a volume specified in the task definition as a volume that is\n\t\t\tconfigured at launch time. Currently, the only supported volume type is an Amazon EBS\n\t\t\tvolume.
" - } - }, - "vpcLatticeConfigurations": { - "target": "com.amazonaws.ecs#VpcLatticeConfigurations", - "traits": { - "smithy.api#documentation": "The VPC Lattice configuration for the service being created.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#CreateServiceResponse": { - "type": "structure", - "members": { - "service": { - "target": "com.amazonaws.ecs#Service", - "traits": { - "smithy.api#documentation": "The full description of your service following the create call.
\nA service will return either a capacityProviderStrategy or\n\t\t\t\tlaunchType parameter, but not both, depending where one was specified\n\t\t\twhen it was created.
If a service is using the ECS deployment controller, the\n\t\t\t\tdeploymentController and taskSets parameters will not be\n\t\t\treturned.
if the service uses the CODE_DEPLOY deployment controller, the\n\t\t\t\tdeploymentController, taskSets and\n\t\t\t\tdeployments parameters will be returned, however the\n\t\t\t\tdeployments parameter will be an empty list.
Information about the service revision.
\nA service revision contains a record of the workload configuration Amazon ECS is attempting\n\t\t\tto deploy. Whenever you create or deploy a service, Amazon ECS automatically creates and\n\t\t\tcaptures the configuration that you're trying to deploy in the service revision. For\n\t\t\tinformation about service revisions, see Amazon ECS service\n\t\t\t\trevisions in the \n Amazon Elastic Container Service Developer Guide\n .
" + } + }, + "com.amazonaws.ecs#ServiceRevisionSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service revision.
" + } + }, + "requestedTaskCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of requested tasks for the service revision.
" + } + }, + "runningTaskCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of running tasks for the service revision.
" + } + }, + "pendingTaskCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of pending tasks for the service revision.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The information about the number of requested, pending, and running tasks for a\n\t\t\tservice revision.
" + } + }, + "com.amazonaws.ecs#ServiceRevisions": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceRevision" + } }, - { - "target": "com.amazonaws.ecs#ClientException" + "com.amazonaws.ecs#ServiceRevisionsSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceRevisionSummary" + } }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" + "com.amazonaws.ecs#ServiceVolumeConfiguration": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#ECSVolumeName", + "traits": { + "smithy.api#documentation": "The name of the volume. This value must match the volume name from the\n\t\t\t\tVolume object in the task definition.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console\n\t\t\tonce they are created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a volume specified in the task definition as a volume that is\n\t\t\tconfigured at launch time. Currently, the only supported volume type is an Amazon EBS\n\t\t\tvolume.
" + } }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" + "com.amazonaws.ecs#ServiceVolumeConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceVolumeConfiguration" + } }, - { - "target": "com.amazonaws.ecs#NamespaceNotFoundException" + "com.amazonaws.ecs#Services": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Service" + } }, - { - "target": "com.amazonaws.ecs#PlatformTaskDefinitionIncompatibilityException" + "com.amazonaws.ecs#Session": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID of the execute command session.
" + } + }, + "streamUrl": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "A URL to the managed agent on the container that the SSM Session Manager client uses\n\t\t\tto send commands and receive output from the container.
" + } + }, + "tokenValue": { + "target": "com.amazonaws.ecs#SensitiveString", + "traits": { + "smithy.api#documentation": "An encrypted token value containing session and caller information. It's used to\n\t\t\tauthenticate the connection to the container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for the execute command session.
" + } }, - { - "target": "com.amazonaws.ecs#PlatformUnknownException" + "com.amazonaws.ecs#Setting": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#SettingName", + "traits": { + "smithy.api#documentation": "The Amazon ECS resource name.
" + } + }, + "value": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Determines whether the account setting is on or off for the specified resource.
" + } + }, + "principalArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the principal. It can be a user, role, or the root user. If this field is\n\t\t\tomitted, the authenticated user is assumed.
" + } + }, + "type": { + "target": "com.amazonaws.ecs#SettingType", + "traits": { + "smithy.api#documentation": "Indicates whether Amazon Web Services manages the account setting, or if the user manages it.
\n\n aws_managed account settings are read-only, as Amazon Web Services manages such on the\n\t\t\tcustomer's behalf. Currently, the guardDutyActivate account setting is the\n\t\t\tonly one Amazon Web Services manages.
The current account setting for a resource.
" + } }, - { - "target": "com.amazonaws.ecs#ServerException" + "com.amazonaws.ecs#SettingName": { + "type": "enum", + "members": { + "SERVICE_LONG_ARN_FORMAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "serviceLongArnFormat" + } + }, + "TASK_LONG_ARN_FORMAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "taskLongArnFormat" + } + }, + "CONTAINER_INSTANCE_LONG_ARN_FORMAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "containerInstanceLongArnFormat" + } + }, + "AWSVPC_TRUNKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "awsvpcTrunking" + } + }, + "CONTAINER_INSIGHTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "containerInsights" + } + }, + "FARGATE_FIPS_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fargateFIPSMode" + } + }, + "TAG_RESOURCE_AUTHORIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tagResourceAuthorization" + } + }, + "FARGATE_TASK_RETIREMENT_WAIT_PERIOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fargateTaskRetirementWaitPeriod" + } + }, + "GUARD_DUTY_ACTIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "guardDutyActivate" + } + } + } }, - { - "target": "com.amazonaws.ecs#ServiceNotActiveException" + "com.amazonaws.ecs#SettingType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "AWS_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws_managed" + } + } + } }, - { - "target": "com.amazonaws.ecs#ServiceNotFoundException" + "com.amazonaws.ecs#Settings": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Setting" + } }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the EXTERNAL deployment controller type. For more information, see\n\t\t\t\tAmazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nFor information about the maximum number of task sets and other quotas, see Amazon ECS\n\t\t\t\tservice quotas in the Amazon Elastic Container Service Developer Guide.
", - "smithy.api#examples": [ - { - "title": "To create a task set", - "documentation": "This example creates a task set in a service that uses the EXTERNAL deployment controller.", - "input": { - "service": "MyService", - "cluster": "MyCluster", - "taskDefinition": "MyTaskDefinition:2", - "networkConfiguration": { - "awsvpcConfiguration": { - "subnets": ["subnet-12344321"], - "securityGroups": ["sg-12344321"] + "com.amazonaws.ecs#SortOrder": { + "type": "enum", + "members": { + "ASC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" + } } - } - }, - "output": { - "taskSet": { - "id": "ecs-svc/1234567890123456789", - "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", - "status": "ACTIVE", - "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition:2", - "computedDesiredCount": 0, - "pendingCount": 0, - "runningCount": 0, - "createdAt": 1.557128360711e9, - "updatedAt": 1.557128360711e9, - "launchType": "EC2", - "networkConfiguration": { - "awsvpcConfiguration": { - "subnets": ["subnet-12344321"], - "securityGroups": ["sg-12344321"], - "assignPublicIp": "DISABLED" - } - }, - "loadBalancers": [], - "serviceRegistries": [], - "scale": { - "value": 0, - "unit": "PERCENT" + } + }, + "com.amazonaws.ecs#StabilityStatus": { + "type": "enum", + "members": { + "STEADY_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STEADY_STATE" + } }, - "stabilityStatus": "STABILIZING", - "stabilityStatusAt": 1.557128360711e9 - } + "STABILIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STABILIZING" + } + } } - } - ] - } - }, - "com.amazonaws.ecs#CreateTaskSetRequest": { - "type": "structure", - "members": { - "service": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
", - "smithy.api#required": {} - } - }, - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the\n\t\t\ttask set in.
", - "smithy.api#required": {} - } - }, - "externalId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "An optional non-unique tag that identifies this task set in external systems. If the\n\t\t\ttask set is associated with a service discovery registry, the tasks in this task set\n\t\t\twill have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided\n\t\t\tvalue.
The task definition for the tasks in the task set to use. If a revision isn't\n\t\t\tspecified, the latest ACTIVE revision is used.
An object representing the network configuration for a task set.
" - } - }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", - "traits": { - "smithy.api#documentation": "A load balancer object representing the load balancer to use with the task set. The\n\t\t\tsupported load balancer types are either an Application Load Balancer or a Network Load Balancer.
" - } - }, - "serviceRegistries": { - "target": "com.amazonaws.ecs#ServiceRegistries", - "traits": { - "smithy.api#documentation": "The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
" - } - }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", - "traits": { - "smithy.api#documentation": "The launch type that new tasks in the task set uses. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
\nIf a launchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.
The capacity provider strategy to use for the task set.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity provider\n\t\t\twith a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProviderProviderAPI operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the list of\n\t\t\tavailable capacity providers for a cluster after the cluster is created.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The platform version that the tasks in the task set uses. A platform version is\n\t\t\tspecified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used.
A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" - } - }, - "clientToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "An identifier that you provide to ensure the idempotency of the request. It must be\n\t\t\tunique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both. When a service is\n\t\t\tdeleted, the tags are deleted.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an\n\t\t\t\tEXTERNAL deployment. A task set includes details such as the desired\n\t\t\tnumber of tasks, how many tasks are running, and whether the task set serves production\n\t\t\ttraffic.
Include service deployments in the result that were created before this time. The\n\t\t\tformat is yyyy-MM-dd HH:mm:ss.SSSSSS.
" - } - }, - "after": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "Include service deployments in the result that were created after this time. The\n\t\t\tformat is yyyy-MM-dd HH:mm:ss.SSSSSS.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The optional filter to narrow the ListServiceDeployment results.
If you do not specify a value, service deployments that were created before the\n\t\t\tcurrent time are included in the result.
" - } - }, - "com.amazonaws.ecs#DeleteAccountSetting": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DeleteAccountSettingRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DeleteAccountSettingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Disables an account setting for a specified user, role, or the root user for an\n\t\t\taccount.
", - "smithy.api#examples": [ - { - "title": "To delete the account settings for a specific IAM user or IAM role", - "documentation": "This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user.", + }, + "com.amazonaws.ecs#StartTask": { + "type": "operation", "input": { - "name": "containerInstanceLongArnFormat", - "principalArn": "arn:aws:iam::The resource name to disable the account setting for. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected.
The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the\n\t\t\troot user. If you specify the root user, it disables the account setting for all users, roles,\n\t\t\tand the root user of the account unless a user or role explicitly overrides these settings.\n\t\t\tIf this field is omitted, the setting is changed only for the authenticated user.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#DeleteAccountSettingResponse": { - "type": "structure", - "members": { - "setting": { - "target": "com.amazonaws.ecs#Setting", - "traits": { - "smithy.api#documentation": "The account setting for the specified principal ARN.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DeleteAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DeleteAttributesRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DeleteAttributesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#TargetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes one or more custom attributes from an Amazon ECS resource.
", - "smithy.api#examples": [ - { - "title": "To delete a custom attribute from an Amazon ECS instance", - "documentation": "This example deletes an attribute named stack from a container instance. ", - "input": { - "attributes": [ + "errors": [ { - "name": "stack", - "targetId": "aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34" - } - ] - }, - "output": { - "attributes": [ + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, { - "name": "stack", - "targetId": "aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", - "value": "production" + "target": "com.amazonaws.ecs#UnsupportedFeatureException" } - ] + ], + "traits": { + "smithy.api#documentation": "Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.
\nOn March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nAlternatively, you can useRunTask to place tasks for you. For more\n\t\t\tinformation, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#examples": [ + { + "title": "To start a new task", + "documentation": "This example starts a new task in the cluster \"MyCluster\" on the specified container instance using the latest revision of the \"hello-world\" task definition.", + "input": { + "cluster": "MyCluster", + "containerInstances": [ + "4c543eed-f83f-47da-b1d8-3d23f1da4c64" + ], + "taskDefinition": "hello-world" + }, + "output": { + "tasks": [ + { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/default/4c543eed-f83f-47da-b1d8-3d23f1da4c64", + "containers": [ + { + "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/e76594d4-27e1-4c74-98b5-46a6435eb769", + "lastStatus": "PENDING", + "name": "wordpress", + "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb" + }, + { + "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/default/b19106ea-4fa8-4f1d-9767-96922c82b070", + "lastStatus": "PENDING", + "name": "mysql", + "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb" + } + ], + "createdAt": 1.479765460842E9, + "desiredStatus": "RUNNING", + "lastStatus": "PENDING", + "overrides": { + "containerOverrides": [ + { + "name": "wordpress" + }, + { + "name": "mysql" + } + ] + }, + "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb", + "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "version": 1 + } + ], + "failures": [] + } + } + ] } - } - ] - } - }, - "com.amazonaws.ecs#DeleteAttributesRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" - } - }, - "attributes": { - "target": "com.amazonaws.ecs#Attributes", - "traits": { - "smithy.api#documentation": "The attributes to delete from your resource. You can specify up to 10 attributes for\n\t\t\teach request. For custom attributes, specify the attribute name and target ID, but don't\n\t\t\tspecify the value. If you specify the target ID using the short form, you must also\n\t\t\tspecify the target type.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#DeleteAttributesResponse": { - "type": "structure", - "members": { - "attributes": { - "target": "com.amazonaws.ecs#Attributes", - "traits": { - "smithy.api#documentation": "A list of attribute objects that were successfully deleted from your resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DeleteCapacityProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DeleteCapacityProviderRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DeleteCapacityProviderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified capacity provider.
\nThe FARGATE and FARGATE_SPOT capacity providers are\n\t\t\t\treserved and can't be deleted. You can disassociate them from a cluster using either\n\t\t\t\t\tPutClusterCapacityProviders or by deleting the cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from\n\t\t\tthe capacity provider strategy from all services. The UpdateService API\n\t\t\tcan be used to remove a capacity provider from a service's capacity provider strategy.\n\t\t\tWhen updating a service, the forceNewDeployment option can be used to\n\t\t\tensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n\t\t\tprovider are transitioned to use the capacity from the remaining capacity providers.\n\t\t\tOnly capacity providers that aren't associated with a cluster can be deleted. To remove\n\t\t\ta capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.
The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#DeleteCapacityProviderResponse": { - "type": "structure", - "members": { - "capacityProvider": { - "target": "com.amazonaws.ecs#CapacityProvider", - "traits": { - "smithy.api#documentation": "The details of the capacity provider.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DeleteCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DeleteClusterRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DeleteClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterContainsContainerInstancesException" - }, - { - "target": "com.amazonaws.ecs#ClusterContainsServicesException" - }, - { - "target": "com.amazonaws.ecs#ClusterContainsTasksException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#UpdateInProgressException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.
You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
", - "smithy.api#examples": [ - { - "title": "To delete an empty cluster", - "documentation": "This example deletes an empty cluster in your default region.", - "input": { - "cluster": "my_cluster" + }, + "com.amazonaws.ecs#StartTaskRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster where to start your task.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + } + }, + "containerInstances": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The container instance IDs or full ARN entries for the container instances where you\n\t\t\twould like to place your task. You can specify up to 10 container instances.
", + "smithy.api#required": {} + } + }, + "enableECSManagedTags": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to use Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "enableExecuteCommand": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether or not the execute command functionality is turned on for the task. If\n\t\t\t\ttrue, this turns on the execute command functionality on all containers\n\t\t\tin the task.
The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.
A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it receives. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.
\nSpecifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags aren't propagated.
" + } + }, + "referenceId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "This parameter is only used by Amazon ECS. It is not intended for use by customers.
" + } + }, + "startedBy": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call with\n\t\t\tthe startedBy value. Up to 36 letters (uppercase and lowercase), numbers,\n\t\t\thyphens (-), forward slash (/), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to start. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.
The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must\n\t\t\tmatch the name from the task definition.
The short name or full Amazon Resource Name (ARN) of the cluster to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#DeleteClusterResponse": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#Cluster", - "traits": { - "smithy.api#documentation": "The full description of the deleted cluster.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DeleteService": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DeleteServiceRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DeleteServiceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#ServiceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you can't delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.
\nWhen you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.
A full description of the tasks that were started. Each task that was successfully\n\t\t\tplaced on your container instances is described.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } }, - "output": {} - } - ] - } - }, - "com.amazonaws.ecs#DeleteServiceRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" - } - }, - "service": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the service to delete.
", - "smithy.api#required": {} - } - }, - "force": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "If true, allows you to delete a service even if it wasn't scaled down to\n\t\t\tzero tasks. It's only necessary to use this if the service uses the REPLICA\n\t\t\tscheduling strategy.
The full description of the deleted service.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DeleteTaskDefinitions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DeleteTaskDefinitionsRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DeleteTaskDefinitionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes one or more task definitions.
\nYou must deregister a task definition revision before you delete it. For more\n\t\t\tinformation, see DeregisterTaskDefinition.
\nWhen you delete a task definition revision, it is immediately transitions from the\n\t\t\t\tINACTIVE to DELETE_IN_PROGRESS. Existing tasks and\n\t\t\tservices that reference a DELETE_IN_PROGRESS task definition revision\n\t\t\tcontinue to run without disruption. Existing services that reference a\n\t\t\t\tDELETE_IN_PROGRESS task definition revision can still scale up or down\n\t\t\tby modifying the service's desired count.
You can't use a DELETE_IN_PROGRESS task definition revision to run new\n\t\t\ttasks or create new services. You also can't update an existing service to reference a\n\t\t\t\tDELETE_IN_PROGRESS task definition revision.
A task definition revision will stay in DELETE_IN_PROGRESS status until\n\t\t\tall the associated tasks and services have been terminated.
When you delete all INACTIVE task definition revisions, the task\n\t\t\tdefinition name is not displayed in the console and not returned in the API. If a task\n\t\t\tdefinition revisions are in the DELETE_IN_PROGRESS state, the task\n\t\t\tdefinition name is displayed in the console and returned in the API. The task definition\n\t\t\tname is retained by Amazon ECS and the revision is incremented the next time you create a\n\t\t\ttask definition with that name.
Stops a running task. Any tags associated with the task will be deleted.
\nWhen you call StopTask on a task, the equivalent of docker\n\t\t\t\tstop is issued to the containers running in the task. This results in a\n\t\t\t\tSIGTERM value and a default 30-second timeout, after which the\n\t\t\t\tSIGKILL value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL value is sent.
For Windows containers, POSIX signals do not work and runtime stops the container by\n\t\t\tsending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown\n\t\t\t\tof (Windows) container #25982 on GitHub.
The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see\n\t\t\t\t\tAmazon ECS Container Agent Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The family and revision (family:revision) or\n\t\t\tfull Amazon Resource Name (ARN) of the task definition to delete. You must specify a\n\t\t\t\trevision.
You can specify up to 10 task definitions as a comma separated list.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#DeleteTaskDefinitionsResponse": { - "type": "structure", - "members": { - "taskDefinitions": { - "target": "com.amazonaws.ecs#TaskDefinitionList", - "traits": { - "smithy.api#documentation": "The list of deleted task definitions.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DeleteTaskSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DeleteTaskSetRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DeleteTaskSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" + "title": "To stop a task", + "documentation": "This example stops a task with ID \"1dc5c17a-422b-4dc4-b493-371970c6c4d6\" in cluster \"MyCluster\".", + "input": { + "cluster": "MyCluster", + "task": "1dc5c17a-422b-4dc4-b493-371970c6c4d6", + "reason": "testing stop task." + }, + "output": { + "task": { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/MyCluster", + "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/MyCluster/5991d8da-1d59-49d2-a31f-4230f9e73140", + "containers": [ + { + "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/4df26bb4-f057-467b-a079-961675296e64", + "lastStatus": "RUNNING", + "name": "simple-app", + "networkBindings": [ + { + "bindIP": "0.0.0.0", + "containerPort": 80, + "hostPort": 32774, + "protocol": "tcp" + } + ], + "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6" + }, + { + "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/e09064f7-7361-4c87-8ab9-8d073bbdbcb9", + "lastStatus": "RUNNING", + "name": "busybox", + "networkBindings": [], + "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6" + } + ], + "createdAt": 1.476822811295E9, + "desiredStatus": "STOPPED", + "lastStatus": "RUNNING", + "overrides": { + "containerOverrides": [ + { + "name": "simple-app" + }, + { + "name": "busybox" + } + ] + }, + "startedAt": 1.476822833998E9, + "startedBy": "ecs-svc/9223370560032507596", + "stoppedReason": "testing stop task.", + "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/1dc5c17a-422b-4dc4-b493-371970c6c4d6", + "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-dynamic-ports:1", + "version": 0 + } + } + } + ] + } }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" + "com.amazonaws.ecs#StopTaskRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + } + }, + "task": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The task ID of the task to stop.
", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "An optional message specified when a task is stopped. For example, if you're using a\n\t\t\tcustom scheduler, you can use this parameter to specify the reason for stopping the task\n\t\t\there, and the message appears in subsequent DescribeTasks>\n\t\t\tAPI operations on this task.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ecs#ServerException" + "com.amazonaws.ecs#StopTaskResponse": { + "type": "structure", + "members": { + "task": { + "target": "com.amazonaws.ecs#Task", + "traits": { + "smithy.api#documentation": "The task that was stopped.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ecs#ServiceNotActiveException" + "com.amazonaws.ecs#String": { + "type": "string" }, - { - "target": "com.amazonaws.ecs#ServiceNotFoundException" + "com.amazonaws.ecs#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#String" + } }, - { - "target": "com.amazonaws.ecs#TaskSetNotFoundException" + "com.amazonaws.ecs#StringMap": { + "type": "map", + "key": { + "target": "com.amazonaws.ecs#String" + }, + "value": { + "target": "com.amazonaws.ecs#String" + } }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a specified task set within a service. This is used when a service uses the\n\t\t\t\tEXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to acknowledge that an attachment changed states.
" } - } - ] - } - }, - "com.amazonaws.ecs#DeleteTaskSetRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset found in to delete.
", - "smithy.api#required": {} - } - }, - "service": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to\n\t\t\tdelete.
", - "smithy.api#required": {} - } - }, - "taskSet": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
", - "smithy.api#required": {} - } - }, - "force": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "If true, you can delete a task set even if it hasn't been scaled down to\n\t\t\tzero.
Details about the task set.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#Deployment": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID of the deployment.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the deployment. The following describes each state.
\nThe most recent deployment of a service.
\nA service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new PRIMARY deployment.
A deployment that has been completely replaced.
\nThe most recent task definition that was specified for the tasks in the service to\n\t\t\tuse.
" - } - }, - "desiredCount": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The most recent desired count of tasks that was specified for the service to deploy or\n\t\t\tmaintain.
" - } - }, - "pendingCount": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of tasks in the deployment that are in the PENDING\n\t\t\tstatus.
The number of tasks in the deployment that are in the RUNNING\n\t\t\tstatus.
The number of consecutively failed tasks in the deployment. A task is considered a\n\t\t\tfailure if the service scheduler can't launch the task, the task doesn't transition to a\n\t\t\t\tRUNNING state, or if it fails any of its defined health checks and is\n\t\t\tstopped.
Once a service deployment has one or more successfully running tasks, the failed\n\t\t\t\ttask count resets to zero and stops being evaluated.
\nThe Unix timestamp for the time when the service deployment was created.
" - } - }, - "updatedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the service deployment was last updated.
" - } - }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", - "traits": { - "smithy.api#documentation": "The capacity provider strategy that the deployment is using.
" - } - }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", - "traits": { - "smithy.api#documentation": "The launch type the tasks in the service are using. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If one isn't specified,\n\t\t\tthe LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service, or tasks are running on. A\n\t\t\tplatform family is specified only for tasks using the Fargate launch type.
\n All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service, for example, \n\t\t\tLINUX..
The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.
The rolloutState of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS) deployment type that aren't behind a\n\t\t\t\tClassic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS state. When the service reaches a steady state, the\n\t\t\tdeployment transitions to a COMPLETED state. If the service fails to reach\n\t\t\ta steady state and circuit breaker is turned on, the deployment transitions to a\n\t\t\t\tFAILED state. A deployment in FAILED state doesn't launch\n\t\t\tany new tasks. For more information, see DeploymentCircuitBreaker.
A description of the rollout state of a deployment.
" - } - }, - "serviceConnectConfiguration": { - "target": "com.amazonaws.ecs#ServiceConnectConfiguration", - "traits": { - "smithy.api#documentation": "The details of the Service Connect configuration that's used by this deployment.\n\t\t\tCompare the configuration between multiple deployments when troubleshooting issues with\n\t\t\tnew deployments.
\nThe configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "serviceConnectResources": { - "target": "com.amazonaws.ecs#ServiceConnectServiceResourceList", - "traits": { - "smithy.api#documentation": "The list of Service Connect resources that are associated with this deployment. Each\n\t\t\tlist entry maps a discovery name to a Cloud Map service name.
" - } - }, - "volumeConfigurations": { - "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", - "traits": { - "smithy.api#documentation": "The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tdifferent settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume\n\t\t\tmust match the name from the task definition.
The Fargate ephemeral storage settings for the deployment.
" - } - }, - "vpcLatticeConfigurations": { - "target": "com.amazonaws.ecs#VpcLatticeConfigurations", - "traits": { - "smithy.api#documentation": "The VPC Lattice configuration for the service deployment.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details of an Amazon ECS service deployment. This is used only when a service uses the\n\t\t\t\tECS deployment controller type.
One or more CloudWatch alarm names. Use a \",\" to separate the alarms.
", - "smithy.api#required": {} - } - }, - "rollback": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is used, when a service deployment fails, the service is rolled back\n\t\t\tto the last deployment that completed successfully.
", - "smithy.api#required": {} - } - }, - "enable": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to use the CloudWatch alarm option in the service deployment\n\t\t\tprocess.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "One of the methods which provide a way for you to quickly identify when a deployment\n\t\t\thas failed, and then to optionally roll back the failure to the last working\n\t\t\tdeployment.
\nWhen the alarms are generated, Amazon ECS sets the service deployment to failed. Set the\n\t\t\trollback parameter to have Amazon ECS to roll back your service to the last completed\n\t\t\tdeployment after a failure.
\nYou can only use the DeploymentAlarms method to detect failures when the\n\t\t\t\tDeploymentController is set to ECS (rolling\n\t\t\tupdate).
For more information, see Rolling\n\t\t\t\tupdate in the \n Amazon Elastic Container Service Developer Guide\n .
" - } - }, - "com.amazonaws.ecs#DeploymentCircuitBreaker": { - "type": "structure", - "members": { - "enable": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to use the deployment circuit breaker logic for the service.
", - "smithy.api#required": {} - } - }, - "rollback": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is on, when a service deployment fails, the service is rolled back to\n\t\t\tthe last deployment that completed successfully.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If it is turned\n\t\t\ton, a service deployment will transition to a failed state and stop launching new tasks.\n\t\t\tYou can also configure Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.
\nFor more information about API failure reasons, see API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#DeploymentConfiguration": { - "type": "structure", - "members": { - "deploymentCircuitBreaker": { - "target": "com.amazonaws.ecs#DeploymentCircuitBreaker", - "traits": { - "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If you use the\n\t\t\tdeployment circuit breaker, a service deployment will transition to a failed state and\n\t\t\tstop launching new tasks. If you use the rollback option, when a service deployment\n\t\t\tfails, the service is rolled back to the last deployment that completed successfully.\n\t\t\tFor more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer\n\t\t\t\tGuide\n
" - } - }, - "maximumPercent": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximumPercent parameter represents an upper limit on the number of\n\t\t\tyour service's tasks that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the\n\t\t\t\tdesiredCount (rounded down to the nearest integer). This parameter\n\t\t\tenables you to define the deployment batch size. For example, if your service is using\n\t\t\tthe REPLICA service scheduler and has a desiredCount of four\n\t\t\ttasks and a maximumPercent value of 200%, the scheduler may start four new\n\t\t\ttasks before stopping the four older tasks (provided that the cluster resources required\n\t\t\tto do this are available). The default maximumPercent value for a service\n\t\t\tusing the REPLICA service scheduler is 200%.
The Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting\n\t\t\treplacement tasks first and then stopping the unhealthy tasks, as long as cluster\n\t\t\tresources for starting replacement tasks are available. For more information about how\n\t\t\tthe scheduler replaces unhealthy tasks, see Amazon ECS\n\t\t\tservices.
\nIf a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types, and tasks in the service use the\n\t\t\tEC2 launch type, the maximum percent\n\t\t\tvalue is set to the default value. The maximum percent\n\t\t\tvalue is used to define the upper limit on the number of the tasks in the service that\n\t\t\tremain in the RUNNING state while the container instances are in the\n\t\t\t\tDRAINING state.
You can't specify a custom maximumPercent value for a service that\n\t\t\t\tuses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\t\tdeployment types and has tasks that use the EC2 launch type.
If the service uses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types, and the tasks in the service use the Fargate launch type, the maximum\n\t\t\tpercent value is not used. The value is still returned when describing your service.
If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimumHealthyPercent represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the RUNNING state during a deployment,\n\t\t\tas a percentage of the desiredCount (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a desiredCount of four tasks and a\n\t\t\t\tminimumHealthyPercent of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks.
If any tasks are unhealthy and if maximumPercent doesn't allow the Amazon ECS\n\t\t\tscheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one\n\t\t\t— using the minimumHealthyPercent as a constraint — to clear up capacity to\n\t\t\tlaunch replacement tasks. For more information about how the scheduler replaces\n\t\t\tunhealthy tasks, see Amazon ECS services .
For services that do not use a load balancer, the following\n\t\t\tshould be noted:
\nA service is considered healthy if all essential containers within the tasks\n\t\t\t\t\tin the service pass their health checks.
\nIf a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for 40 seconds after a task reaches a RUNNING\n\t\t\t\t\tstate before the task is counted towards the minimum healthy percent\n\t\t\t\t\ttotal.
If a task has one or more essential containers with a health check defined,\n\t\t\t\t\tthe service scheduler will wait for the task to reach a healthy status before\n\t\t\t\t\tcounting it towards the minimum healthy percent total. A task is considered\n\t\t\t\t\thealthy when all essential containers within the task have passed their health\n\t\t\t\t\tchecks. The amount of time the service scheduler can wait for is determined by\n\t\t\t\t\tthe container health check settings.
\nFor services that do use a load balancer, the following should be\n\t\t\tnoted:
\nIf a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for the load balancer target group health check to return a\n\t\t\t\t\thealthy status before counting the task towards the minimum healthy percent\n\t\t\t\t\ttotal.
\nIf a task has an essential container with a health check defined, the service\n\t\t\t\t\tscheduler will wait for both the task to reach a healthy status and the load\n\t\t\t\t\tbalancer target group health check to return a healthy status before counting\n\t\t\t\t\tthe task towards the minimum healthy percent total.
\nThe default value for a replica service for minimumHealthyPercent is\n\t\t\t100%. The default minimumHealthyPercent value for a service using the\n\t\t\t\tDAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the\n\t\t\tAPIs and 50% for the Amazon Web Services Management Console.
The minimum number of healthy tasks during a deployment is the\n\t\t\t\tdesiredCount multiplied by the minimumHealthyPercent/100,\n\t\t\trounded up to the nearest integer value.
If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the minimum healthy\n\t\t\t\tpercent value is set to the default value. The minimum healthy percent value is used to define the lower limit on the\n\t\t\tnumber of the tasks in the service that remain in the RUNNING state while\n\t\t\tthe container instances are in the DRAINING state.
You can't specify a custom minimumHealthyPercent value for a service\n\t\t\t\tthat uses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\t\tdeployment types and has tasks that use the EC2 launch type.
If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tFargate launch type, the minimum healthy percent value is not used,\n\t\t\talthough it is returned when describing your service.
Information about the CloudWatch alarms.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during a deployment and\n\t\t\tthe ordering of stopping and starting tasks.
" - } - }, - "com.amazonaws.ecs#DeploymentController": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.ecs#DeploymentControllerType", - "traits": { - "smithy.api#documentation": "The deployment controller type to use.
\nThere are three deployment controller types available:
\nThe rolling update (ECS) deployment type involves replacing\n\t\t\t\t\t\tthe current running version of the container with the latest version. The\n\t\t\t\t\t\tnumber of containers Amazon ECS adds or removes from the service during a rolling\n\t\t\t\t\t\tupdate is controlled by adjusting the minimum and maximum number of healthy\n\t\t\t\t\t\ttasks allowed during a service deployment, as specified in the DeploymentConfiguration.
For more information about rolling deployments, see Deploy\n\t\t\t\t\t\t\tAmazon ECS services by replacing tasks in the Amazon Elastic Container Service Developer Guide.
\nThe blue/green (CODE_DEPLOY) deployment type uses the\n\t\t\t\t\t\tblue/green deployment model powered by CodeDeploy, which allows you to verify a\n\t\t\t\t\t\tnew deployment of a service before sending production traffic to it.
For more information about blue/green deployments, see Validate the state of an Amazon ECS service before deployment in\n\t\t\t\t\t\tthe Amazon Elastic Container Service Developer Guide.
\nThe external (EXTERNAL) deployment type enables you to use\n\t\t\t\t\t\tany third-party deployment controller for full control over the deployment\n\t\t\t\t\t\tprocess for an Amazon ECS service.
For more information about external deployments, see Deploy Amazon ECS services using a third-party controller in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
\nThe deployment controller to use for the service.
" - } - }, - "com.amazonaws.ecs#DeploymentControllerType": { - "type": "enum", - "members": { - "ECS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECS" - } - }, - "CODE_DEPLOY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CODE_DEPLOY" - } - }, - "EXTERNAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXTERNAL" - } - } - } - }, - "com.amazonaws.ecs#DeploymentEphemeralStorage": { - "type": "structure", - "members": { - "kmsKeyId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Specify an Key Management Service key ID to encrypt the ephemeral storage for\n\t\t\tdeployment.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The amount of ephemeral storage to allocate for the deployment.
" - } - }, - "com.amazonaws.ecs#DeploymentRolloutState": { - "type": "enum", - "members": { - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - } - } - }, - "com.amazonaws.ecs#Deployments": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Deployment" - } - }, - "com.amazonaws.ecs#DeregisterContainerInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DeregisterContainerInstanceRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DeregisterContainerInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.
\nIf you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.
\nDeregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.
\nIf you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).
\nThe short name or full ARN of the cluster that hosts the container instance the\n\t\t\tattachment belongs to.
" + } + }, + "attachments": { + "target": "com.amazonaws.ecs#AttachmentStateChanges", + "traits": { + "smithy.api#documentation": "Any attachments associated with the state change request.
", + "smithy.api#required": {} + } + } }, - "output": {} - } - ] - } - }, - "com.amazonaws.ecs#DeregisterContainerInstanceRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tderegister. If you do not specify a cluster, the default cluster is assumed.
" - } - }, - "containerInstance": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The container instance ID or full ARN of the container instance to deregister. For\n\t\t\tmore information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
", - "smithy.api#required": {} - } - }, - "force": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Forces the container instance to be deregistered. If you have tasks running on the\n\t\t\tcontainer instance when you deregister it with the force option, these\n\t\t\ttasks remain running until you terminate the instance or the tasks stop through some\n\t\t\tother means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an\n\t\t\torphaned task on your container instance is part of an Amazon ECS service, then the service\n\t\t\tscheduler starts another copy of that task, on a different container instance if\n\t\t\tpossible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n\t\t\ttarget group are deregistered. They begin connection draining according to the settings\n\t\t\ton the load balancer or target group.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#DeregisterContainerInstanceResponse": { - "type": "structure", - "members": { - "containerInstance": { - "target": "com.amazonaws.ecs#ContainerInstance", - "traits": { - "smithy.api#documentation": "The container instance that was deregistered.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DeregisterTaskDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DeregisterTaskDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DeregisterTaskDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as INACTIVE. Existing tasks and services that\n\t\t\treference an INACTIVE task definition continue to run without disruption.\n\t\t\tExisting services that reference an INACTIVE task definition can still\n\t\t\tscale up or down by modifying the service's desired count. If you want to delete a task\n\t\t\tdefinition revision, you must first deregister the task definition revision.
You can't use an INACTIVE task definition to run new tasks or create new\n\t\t\tservices, and you can't update an existing service to reference an INACTIVE\n\t\t\ttask definition. However, there may be up to a 10-minute window following deregistration\n\t\t\twhere these restrictions have not yet taken effect.
At this time, INACTIVE task definitions remain discoverable in your\n\t\t\t\taccount indefinitely. However, this behavior is subject to change in the future. We\n\t\t\t\tdon't recommend that you rely on INACTIVE task definitions persisting\n\t\t\t\tbeyond the lifecycle of any associated tasks and services.
You must deregister a task definition revision before you delete it. For more\n\t\t\tinformation, see DeleteTaskDefinitions.
", - "smithy.api#examples": [ - { - "title": "To deregister a revision of a task definition", - "documentation": "This example deregisters the first revision of the curler task definition", - "input": { - "taskDefinition": "curler:1" + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#SubmitAttachmentStateChangesResponse": { + "type": "structure", + "members": { + "acknowledgment": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Acknowledgement of the state change.
" + } + } }, - "output": { - "taskDefinition": { - "status": "INACTIVE", - "family": "curler", - "volumes": [], - "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/curler:1", - "containerDefinitions": [ - { - "environment": [], - "name": "curler", - "mountPoints": [], - "image": "curl:latest", - "cpu": 100, - "portMappings": [], - "entryPoint": [], - "memory": 256, - "command": ["curl -v http://example.com/"], - "essential": true, - "volumesFrom": [] - } - ], - "revision": 1 - } + "traits": { + "smithy.api#output": {} } - } - ] - } - }, - "com.amazonaws.ecs#DeregisterTaskDefinitionRequest": { - "type": "structure", - "members": { - "taskDefinition": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull Amazon Resource Name (ARN) of the task definition to deregister. You must specify a\n\t\t\t\trevision.
The full description of the deregistered task.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DescribeCapacityProviders": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DescribeCapacityProvidersRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DescribeCapacityProvidersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Describes one or more of your capacity providers.
", - "smithy.api#examples": [ - { - "title": "To describe a specific capacity provider", - "documentation": "This example retrieves details about the capacity provider MyCapacityProvider", + }, + "com.amazonaws.ecs#SubmitContainerStateChange": { + "type": "operation", "input": { - "capacityProviders": ["MyCapacityProvider"], - "include": ["TAGS"] + "target": "com.amazonaws.ecs#SubmitContainerStateChangeRequest" }, "output": { - "capacityProviders": [ - { - "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider", - "name": "MyCapacityProvider", - "status": "ACTIVE", - "autoScalingGroupProvider": { - "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup", - "managedScaling": { - "status": "ENABLED", - "targetCapacity": 100, - "minimumScalingStepSize": 1, - "maximumScalingStepSize": 1000 - }, - "managedTerminationProtection": "ENABLED" - }, - "tags": [ - { - "key": "environment", - "value": "production" + "target": "com.amazonaws.ecs#SubmitContainerStateChangeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to acknowledge that a container changed states.
" + } + }, + "com.amazonaws.ecs#SubmitContainerStateChangeRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container.
" + } + }, + "task": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
" + } + }, + "containerName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container.
" + } + }, + "runtimeId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID of the Docker container.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the state change request.
" + } + }, + "exitCode": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The exit code that's returned for the state change request.
" + } + }, + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The reason for the state change request.
" + } + }, + "networkBindings": { + "target": "com.amazonaws.ecs#NetworkBindings", + "traits": { + "smithy.api#documentation": "The network bindings of the container.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#SubmitContainerStateChangeResponse": { + "type": "structure", + "members": { + "acknowledgment": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Acknowledgement of the state change.
" } - ] } - ] + }, + "traits": { + "smithy.api#output": {} } - }, - { - "title": "To describe all capacity providers", - "documentation": "This example retrieves details about all capacity providers. ", + }, + "com.amazonaws.ecs#SubmitTaskStateChange": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#SubmitTaskStateChangeRequest" + }, "output": { - "capacityProviders": [ - { - "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider", - "name": "MyCapacityProvider", - "status": "ACTIVE", - "autoScalingGroupProvider": { - "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup", - "managedScaling": { - "status": "ENABLED", - "targetCapacity": 100, - "minimumScalingStepSize": 1, - "maximumScalingStepSize": 1000 - }, - "managedTerminationProtection": "ENABLED" - }, - "tags": [] + "target": "com.amazonaws.ecs#SubmitTaskStateChangeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" }, { - "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE", - "name": "FARGATE", - "status": "ACTIVE", - "tags": [] + "target": "com.amazonaws.ecs#InvalidParameterException" }, { - "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE_SPOT", - "name": "FARGATE_SPOT", - "status": "ACTIVE", - "tags": [] + "target": "com.amazonaws.ecs#ServerException" } - ] + ], + "traits": { + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to acknowledge that a task changed states.
" } - } - ] - } - }, - "com.amazonaws.ecs#DescribeCapacityProvidersRequest": { - "type": "structure", - "members": { - "capacityProviders": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to\n\t\t\t\t100 capacity providers can be described in an action.
Specifies whether or not you want to see the resource tags for the capacity provider.\n\t\t\tIf TAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.
The maximum number of account setting results returned by\n\t\t\t\tDescribeCapacityProviders in paginated output. When this parameter is\n\t\t\tused, DescribeCapacityProviders only returns maxResults\n\t\t\tresults in a single page along with a nextToken response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\tDescribeCapacityProviders request with the returned\n\t\t\t\tnextToken value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then DescribeCapacityProviders returns up to\n\t\t\t10 results and a nextToken value\n\t\t\tif applicable.
The nextToken value returned from a previous paginated\n\t\t\t\tDescribeCapacityProviders request where maxResults was\n\t\t\tused and the results exceeded the value of that parameter. Pagination continues from the\n\t\t\tend of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of capacity providers.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future\n\t\t\t\tDescribeCapacityProviders request. When the results of a\n\t\t\t\tDescribeCapacityProviders request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null\n\t\t\twhen there are no more results to return.
Describes one or more of your clusters.
\nFor CLI examples, see describe-clusters.rst on GitHub.
", - "smithy.api#examples": [ - { - "title": "To describe a cluster", - "documentation": "This example provides a description of the specified cluster in your default region.", - "input": { - "clusters": ["default"] + }, + "com.amazonaws.ecs#SubmitTaskStateChangeRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
" + } + }, + "task": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The task ID or full ARN of the task in the state change request.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The status of the state change request.
" + } + }, + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The reason for the state change request.
" + } + }, + "containers": { + "target": "com.amazonaws.ecs#ContainerStateChanges", + "traits": { + "smithy.api#documentation": "Any containers that's associated with the state change request.
" + } + }, + "attachments": { + "target": "com.amazonaws.ecs#AttachmentStateChanges", + "traits": { + "smithy.api#documentation": "Any attachments associated with the state change request.
" + } + }, + "managedAgents": { + "target": "com.amazonaws.ecs#ManagedAgentStateChanges", + "traits": { + "smithy.api#documentation": "The details for the managed agent that's associated with the task.
" + } + }, + "pullStartedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the container image pull started.
" + } + }, + "pullStoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the container image pull completed.
" + } + }, + "executionStoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task execution stopped.
" + } + } }, - "output": { - "clusters": [ - { - "clusterName": "default", - "status": "ACTIVE", - "clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster/default" + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#SubmitTaskStateChangeResponse": { + "type": "structure", + "members": { + "acknowledgment": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Acknowledgement of the state change.
" + } } - ], - "failures": [] + }, + "traits": { + "smithy.api#output": {} } - } - ] - } - }, - "com.amazonaws.ecs#DescribeClustersRequest": { - "type": "structure", - "members": { - "clusters": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" - } - }, - "include": { - "target": "com.amazonaws.ecs#ClusterFieldList", - "traits": { - "smithy.api#documentation": "Determines whether to include additional information about the clusters in the\n\t\t\tresponse. If this field is omitted, this information isn't included.
\nIf ATTACHMENTS is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included, for example the capacity providers.
If SETTINGS is specified, the settings for the cluster are\n\t\t\tincluded.
If CONFIGURATIONS is specified, the configuration for the cluster is\n\t\t\tincluded.
If STATISTICS is specified, the task and service count is included,\n\t\t\tseparated by launch type.
If TAGS is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.
The list of clusters.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DescribeContainerInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DescribeContainerInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DescribeContainerInstancesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Describes one or more container instances. Returns metadata about each container\n\t\t\tinstance requested.
", - "smithy.api#examples": [ - { - "title": "To describe container instance", - "documentation": "This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.", + }, + "com.amazonaws.ecs#SystemControl": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The namespaced kernel parameter to set a value for.
The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\"\n\t\t\t\t| \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" |\n\t\t\t\t\"kernel.shm_rmid_forced\", and Sysctls that start with\n\t\t\t\t\"fs.mqueue.*\"\n
Valid network namespace values: Sysctls that start with\n\t\t\t\t\"net.*\"\n
All of these values are supported by Fargate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the docker container create command and the\n\t\t\t\t--sysctl option to docker run. For example, you can configure\n\t\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.
We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\tawsvpc or host network mode. Doing this has the following\n\t\t\tdisadvantages:
For tasks that use the awsvpc network mode including Fargate,\n\t\t\t\t\tif you set systemControls for any container, it applies to all\n\t\t\t\t\tcontainers in the task. If you set different systemControls for\n\t\t\t\t\tmultiple containers in a single task, the container that's started last\n\t\t\t\t\tdetermines which systemControls take effect.
For tasks that use the host network mode, the network namespace\n\t\t\t\t\t\tsystemControls aren't supported.
If you're setting an IPC resource namespace to use for the containers in the task, the\n\t\t\tfollowing conditions apply to your system controls. For more information, see IPC mode.
\nFor tasks that use the host IPC mode, IPC namespace\n\t\t\t\t\t\tsystemControls aren't supported.
For tasks that use the task IPC mode, IPC namespace\n\t\t\t\t\t\tsystemControls values apply to all containers within a\n\t\t\t\t\ttask.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
One part of a key-value pair that make up a tag. A key is a general label\n\t\t\tthat acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as\n\t\t\ta descriptor within a tag category (key).
The metadata that you apply to a resource to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define them.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn. If existing tags on a resource aren't specified in the\n\t\t\trequest parameters, they aren't changed. When a resource is deleted, the tags that are\n\t\t\tassociated with that resource are deleted as well.
The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are\n\t\t\tAmazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "The tags to add to the resource. A tag is an array of key-value pairs.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance\n\t\t\tor container instances you are describing were launched in any cluster other than the\n\t\t\tdefault cluster.
" - } - }, - "containerInstances": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
", - "smithy.api#required": {} - } - }, - "include": { - "target": "com.amazonaws.ecs#ContainerInstanceFieldList", - "traits": { - "smithy.api#documentation": "Specifies whether you want to see the resource tags for the container instance. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If\n\t\t\t\tCONTAINER_INSTANCE_HEALTH is specified, the container instance health\n\t\t\tis included in the response. If this field is omitted, tags and container instance\n\t\t\thealth status aren't included in the response.
The list of container instances.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DescribeServiceDeployments": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DescribeServiceDeploymentsRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DescribeServiceDeploymentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#ServiceNotFoundException" - }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Describes one or more of your service deployments.
\nA service deployment happens when you release a software update for the service. For\n\t\t\tmore information, see Amazon ECS service\n\t\t\t\tdeployments.
" - } - }, - "com.amazonaws.ecs#DescribeServiceDeploymentsRequest": { - "type": "structure", - "members": { - "serviceDeploymentArns": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The ARN of the service deployment.
\nYou can specify a maximum of 20 ARNs.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#DescribeServiceDeploymentsResponse": { - "type": "structure", - "members": { - "serviceDeployments": { - "target": "com.amazonaws.ecs#ServiceDeployments", - "traits": { - "smithy.api#documentation": "The list of service deployments described.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
\nIf you decsribe a deployment with a service revision created before October 25, 2024,\n\t\t\tthe call fails. The failure includes the service revision ARN and the reason set to\n\t\t\t\tMISSING.
Describes one or more service revisions.
\nA service revision is a version of the service that includes the values for the Amazon\n\t\t\tECS resources (for example, task definition) and the environment resources (for example,\n\t\t\tload balancers, subnets, and security groups). For more information, see Amazon ECS service revisions.
\nYou can't describe a service revision that was created before October 25, 2024.
" - } - }, - "com.amazonaws.ecs#DescribeServiceRevisionsRequest": { - "type": "structure", - "members": { - "serviceRevisionArns": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The ARN of the service revision.
\nYou can specify a maximum of 20 ARNs.
\nYou can call ListServiceDeployments to get the ARNs.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#DescribeServiceRevisionsResponse": { - "type": "structure", - "members": { - "serviceRevisions": { - "target": "com.amazonaws.ecs#ServiceRevisions", - "traits": { - "smithy.api#documentation": "The list of service revisions described.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DescribeServices": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DescribeServicesRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DescribeServicesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Describes the specified services running in your cluster.
", - "smithy.api#examples": [ - { - "title": "To describe a service", - "documentation": "This example provides descriptive information about the service named ``ecs-simple-service``.", - "input": { - "services": ["ecs-simple-service"] + }, + "com.amazonaws.ecs#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.ecs#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Tag" }, - "output": { - "failures": [], - "services": [ - { - "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", - "createdAt": "2016-08-29T16:25:52.130Z", - "deploymentConfiguration": { - "maximumPercent": 200, - "minimumHealthyPercent": 100 - }, - "deployments": [ - { - "createdAt": "2016-08-29T16:25:52.130Z", - "desiredCount": 1, - "id": "ecs-svc/9223370564341623665", - "pendingCount": 0, - "runningCount": 0, - "status": "PRIMARY", - "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", - "updatedAt": "2016-08-29T16:25:52.130Z" - } - ], - "desiredCount": 1, - "events": [ - { - "createdAt": "2016-08-29T16:25:58.520Z", - "id": "38c285e5-d335-4b68-8b15-e46dedc8e88d", - "message": "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide." - } - ], - "loadBalancers": [], - "pendingCount": 0, - "runningCount": 0, - "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", - "serviceName": "ecs-simple-service", - "status": "ACTIVE", - "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6" - } - ] - } - } - ], - "smithy.waiters#waitable": { - "ServicesInactive": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "failures[].reason", - "expected": "MISSING", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "output": { - "path": "services[].status", - "expected": "INACTIVE", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "ServicesStable": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "failures[].reason", - "expected": "MISSING", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "services[].status", - "expected": "DRAINING", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "services[].status", - "expected": "INACTIVE", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "output": { - "path": "length(services[?!(length(deployments) == `1` && runningCount == desiredCount)]) == `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ecs#DescribeServicesRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are\n\t\t\tdescribing were launched in any cluster other than the default cluster.
" - } - }, - "services": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "A list of services to describe. You may specify up to 10 services to describe in a\n\t\t\tsingle operation.
", - "smithy.api#required": {} - } - }, - "include": { - "target": "com.amazonaws.ecs#ServiceFieldList", - "traits": { - "smithy.api#documentation": "Determines whether you want to see the resource tags for the service. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.
The list of services described.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DescribeTaskDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DescribeTaskDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DescribeTaskDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Describes a task definition. You can specify a family and\n\t\t\t\trevision to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest ACTIVE revision in that\n\t\t\tfamily.
You can only describe INACTIVE task definitions while an active task\n\t\t\t\tor service references them.
Message that describes the cause of the exception.
" + } + } }, - "output": { - "taskDefinition": { - "family": "hello_world", - "taskDefinitionArn": "arn:aws:ecs:us-east-1:The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:
\nIncorrect IAM permissions
\nThe SSM agent is not installed or is not running
\nThere is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for\n\t\t\t\t\tSystems Manager Session Manager
\nFor information about how to troubleshoot the issues, see Troubleshooting issues with ECS\n\t\t\t\tExec in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#error": "client" } - } - ] - } - }, - "com.amazonaws.ecs#DescribeTaskDefinitionRequest": { - "type": "structure", - "members": { - "taskDefinition": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The family for the latest ACTIVE revision,\n\t\t\t\tfamily and revision (family:revision) for a\n\t\t\tspecific revision in the family, or full Amazon Resource Name (ARN) of the task definition to\n\t\t\tdescribe.
Determines whether to see the resource tags for the task definition. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.
The full task definition description.
" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The metadata that's applied to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Describes the task sets in the specified cluster and service. This is used when a\n\t\t\tservice uses the EXTERNAL deployment controller type. For more information,\n\t\t\tsee Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
Message that describes the cause of the exception.
" + } + } }, - "output": { - "taskSets": [ - { - "id": "ecs-svc/1234567890123456789", - "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", - "status": "ACTIVE", - "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", - "computedDesiredCount": 0, - "pendingCount": 0, - "runningCount": 0, - "createdAt": 1.557207715195e9, - "updatedAt": 1.557207740014e9, - "launchType": "EC2", - "networkConfiguration": { - "awsvpcConfiguration": { - "subnets": ["subnet-12344321"], - "securityGroups": ["sg-1234431"], - "assignPublicIp": "DISABLED" - } - }, - "loadBalancers": [], - "serviceRegistries": [], - "scale": { - "value": 0, - "unit": "PERCENT" - }, - "stabilityStatus": "STEADY_STATE", - "stabilityStatusAt": 1.557207740014e9 - } - ], - "failures": [] - } - } - ] - } - }, - "com.amazonaws.ecs#DescribeTaskSetsRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", - "smithy.api#required": {} - } - }, - "service": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
", - "smithy.api#required": {} - } - }, - "taskSets": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The ID or full Amazon Resource Name (ARN) of task sets to\n\t\t\tdescribe.
" - } - }, - "include": { - "target": "com.amazonaws.ecs#TaskSetFieldList", - "traits": { - "smithy.api#documentation": "Specifies whether to see the resource tags for the task set. If TAGS is\n\t\t\tspecified, the tags are included in the response. If this field is omitted, tags aren't\n\t\t\tincluded in the response.
The list of task sets described.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DescribeTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DescribeTasksRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DescribeTasksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Describes a specified task or tasks.
\nCurrently, stopped tasks appear in the returned results for at least one hour.
\nIf you have tasks with tags, and then delete the cluster, the tagged tasks are\n\t\t\treturned in the response. If you create a new cluster with the same name as the deleted\n\t\t\tcluster, the tagged tasks are not included in the response.
", - "smithy.api#examples": [ - { - "title": "To describe a task", - "documentation": "This example provides a description of the specified task, using the task UUID as an identifier.", - "input": { - "tasks": ["c5cba4eb-5dad-405e-96db-71ef8eefe6a8"] + "traits": { + "smithy.api#documentation": "The specified target wasn't found. You can view your available container instances\n\t\t\twith ListContainerInstances. Amazon ECS container instances are cluster-specific and\n\t\t\tRegion-specific.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecs#TargetType": { + "type": "enum", + "members": { + "CONTAINER_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "container-instance" + } + } + } + }, + "com.amazonaws.ecs#Task": { + "type": "structure", + "members": { + "attachments": { + "target": "com.amazonaws.ecs#Attachments", + "traits": { + "smithy.api#documentation": "The Elastic Network Adapter that's associated with the task if the task uses the\n\t\t\t\tawsvpc network mode.
The attributes of the task
" + } + }, + "availabilityZone": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Availability Zone for the task.
" + } + }, + "capacityProviderName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The capacity provider that's associated with the task.
" + } + }, + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the cluster that hosts the task.
" + } + }, + "connectivity": { + "target": "com.amazonaws.ecs#Connectivity", + "traits": { + "smithy.api#documentation": "The connectivity status of a task.
" + } + }, + "connectivityAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task last went into CONNECTED\n\t\t\tstatus.
The ARN of the container instances that host the task.
" + } + }, + "containers": { + "target": "com.amazonaws.ecs#Containers", + "traits": { + "smithy.api#documentation": "The containers that's associated with the task.
" + } + }, + "cpu": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units (for example, 1024). It can also be\n\t\t\texpressed as a string using vCPUs (for example, 1 vCPU or 1\n\t\t\t\tvcpu). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.
If you use the EC2 launch type, this field is optional. Supported values\n\t\t\tare between 128 CPU units (0.125 vCPUs) and 10240\n\t\t\tCPU units (10 vCPUs).
If you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. These values determine the range of supported values for\n\t\t\tthe memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The Unix timestamp for the time when the task was created. More specifically, it's for\n\t\t\tthe time when the task entered the PENDING state.
The desired status of the task. For more information, see Task\n\t\t\tLifecycle.
" + } + }, + "enableExecuteCommand": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Determines whether execute command functionality is turned on for this task. If\n\t\t\t\ttrue, execute command functionality is turned on all the containers in\n\t\t\tthe task.
The Unix timestamp for the time when the task execution stopped.
" + } + }, + "group": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the task group that's associated with the task.
" + } + }, + "healthStatus": { + "target": "com.amazonaws.ecs#HealthStatus", + "traits": { + "smithy.api#documentation": "The health status for the task. It's determined by the health of the essential\n\t\t\tcontainers in the task. If all essential containers in the task are reporting as\n\t\t\t\tHEALTHY, the task status also reports as HEALTHY. If any\n\t\t\tessential containers in the task are reporting as UNHEALTHY or\n\t\t\t\tUNKNOWN, the task status also reports as UNHEALTHY or\n\t\t\t\tUNKNOWN.
The Amazon ECS container agent doesn't monitor or report on Docker health checks that\n\t\t\t\tare embedded in a container image and not specified in the container definition. For\n\t\t\t\texample, this includes those specified in a parent image or from the image's\n\t\t\t\tDockerfile. Health check parameters that are specified in a container definition\n\t\t\t\toverride any Docker health checks that are found in the container image.
\nThe Elastic Inference accelerator that's associated with the task.
" + } + }, + "lastStatus": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The last known status for the task. For more information, see Task\n\t\t\t\tLifecycle.
" + } + }, + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", + "traits": { + "smithy.api#documentation": "The infrastructure where your task runs on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "memory": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The amount of memory (in MiB) that the task uses as expressed in a task definition. It\n\t\t\tcan be expressed as an integer using MiB (for example, 1024). If it's\n\t\t\texpressed as a string using GB (for example, 1GB or 1 GB),\n\t\t\tit's converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
If you use the EC2 launch type, this field is optional.
\nIf you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. The value that you choose determines the range of supported\n\t\t\tvalues for the cpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
One or more container overrides.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The platform version where your task runs on. A platform version is only specified for\n\t\t\ttasks that use the Fargate launch type. If you didn't specify one, the\n\t\t\t\tLATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks are running on. A platform family is specified\n\t\t\tonly for tasks that use the Fargate launch type.
\n All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX.).
The Unix timestamp for the time when the container image pull began.
" + } + }, + "pullStoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the container image pull completed.
" + } + }, + "startedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task started. More specifically, it's for the\n\t\t\ttime when the task transitioned from the PENDING state to the\n\t\t\t\tRUNNING state.
The tag specified when a task is started. If an Amazon ECS service started the task, the\n\t\t\t\tstartedBy parameter contains the deployment ID of that service.
The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.
For more information about stop code, see Stopped tasks\n\t\t\t\terror codes in the Amazon ECS Developer Guide.
" + } + }, + "stoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task was stopped. More specifically, it's for\n\t\t\tthe time when the task transitioned from the RUNNING state to the\n\t\t\t\tSTOPPED state.
The reason that the task was stopped.
" + } + }, + "stoppingAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task stops. More specifically, it's for the\n\t\t\ttime when the task transitions from the RUNNING state to\n\t\t\t\tSTOPPING.
The metadata that you apply to the task to help you categorize and organize the task.\n\t\t\tEach tag consists of a key and an optional value. You define both the key and\n\t\t\tvalue.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The Amazon Resource Name (ARN) of the task.
" + } + }, + "taskDefinitionArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the task definition that creates the task.
" + } + }, + "version": { + "target": "com.amazonaws.ecs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The version counter for the task. Every time a task experiences a change that starts a\n\t\t\tCloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state\n\t\t\twith CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n\t\t\tactions with the version reported in CloudWatch Events for the task (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.
The ephemeral storage settings for the task.
" + } + }, + "fargateEphemeralStorage": { + "target": "com.amazonaws.ecs#TaskEphemeralStorage", + "traits": { + "smithy.api#documentation": "The Fargate ephemeral storage settings for the task.
" + } + } }, - "output": { - "failures": [], - "tasks": [ - { - "taskArn": "arn:aws:ecs:The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required. If you do not specify a\n\t\t\tvalue, the default cluster is used.
A list of up to 100 task IDs or full ARN entries.
", - "smithy.api#required": {} - } - }, - "include": { - "target": "com.amazonaws.ecs#TaskFieldList", - "traits": { - "smithy.api#documentation": "Specifies whether you want to see the resource tags for the task. If TAGS\n\t\t\tis specified, the tags are included in the response. If this field is omitted, tags\n\t\t\taren't included in the response.
The list of tasks.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DesiredStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.ecs#Device": { - "type": "structure", - "members": { - "hostPath": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The path for the device on the host container instance.
", - "smithy.api#required": {} - } - }, - "containerPath": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The path inside the container at which to expose the host device.
" - } - }, - "permissions": { - "target": "com.amazonaws.ecs#DeviceCgroupPermissions", - "traits": { - "smithy.api#documentation": "The explicit permissions to provide to the container for the device. By default, the\n\t\t\tcontainer has permissions for read, write, and\n\t\t\t\tmknod for the device.
An object representing a container instance host device.
" - } - }, - "com.amazonaws.ecs#DeviceCgroupPermission": { - "type": "enum", - "members": { - "READ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "read" - } - }, - "WRITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "write" - } - }, - "MKNOD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mknod" - } - } - } - }, - "com.amazonaws.ecs#DeviceCgroupPermissions": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#DeviceCgroupPermission" - } - }, - "com.amazonaws.ecs#DevicesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Device" - } - }, - "com.amazonaws.ecs#DiscoverPollEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#DiscoverPollEndpointRequest" - }, - "output": { - "target": "com.amazonaws.ecs#DiscoverPollEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nReturns an endpoint for the Amazon ECS agent to poll for updates.
" - } - }, - "com.amazonaws.ecs#DiscoverPollEndpointRequest": { - "type": "structure", - "members": { - "containerInstance": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The container instance ID or full ARN of the container instance. For more\n\t\t\tinformation about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" - } - }, - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs\n\t\t\tto.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#DiscoverPollEndpointResponse": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The endpoint for the Amazon ECS agent to poll.
" - } - }, - "telemetryEndpoint": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The telemetry endpoint for the Amazon ECS agent.
" - } - }, - "serviceConnectEndpoint": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The endpoint for the Amazon ECS agent to poll for Service Connect configuration.\n\t\t\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#DockerLabelsMap": { - "type": "map", - "key": { - "target": "com.amazonaws.ecs#String" - }, - "value": { - "target": "com.amazonaws.ecs#String" - } - }, - "com.amazonaws.ecs#DockerVolumeConfiguration": { - "type": "structure", - "members": { - "scope": { - "target": "com.amazonaws.ecs#Scope", - "traits": { - "smithy.api#documentation": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are\n\t\t\tscoped to a task are automatically provisioned when the task starts and\n\t\t\tdestroyed when the task stops. Docker volumes that are scoped as shared\n\t\t\tpersist after the task stops.
If this value is true, the Docker volume is created if it doesn't already\n\t\t\texist.
This field is only used if the scope is shared.
The Docker volume driver to use. The driver value must match the driver name provided\n\t\t\tby Docker because it is used for task placement. If the driver was installed using the\n\t\t\tDocker plugin CLI, use docker plugin ls to retrieve the driver name from\n\t\t\tyour container instance. If the driver was installed using another method, use Docker\n\t\t\tplugin discovery to retrieve the driver name. This parameter maps to Driver\n\t\t\tin the docker container create command and the xxdriver option to docker\n\t\t\tvolume create.
A map of Docker driver-specific options passed through. This parameter maps to\n\t\t\t\tDriverOpts in the docker create-volume command and the\n\t\t\t\txxopt option to docker volume create.
Custom metadata to add to your Docker volume. This parameter maps to\n\t\t\t\tLabels in the docker container create command and the\n\t\t\t\txxlabel option to docker volume create.
This parameter is specified when you're using Docker volumes. Docker volumes are only\n\t\t\tsupported when you're using the EC2 launch type. Windows containers only\n\t\t\tsupport the use of the local driver. To use bind mounts, specify a\n\t\t\t\thost instead.
The type of volume resource.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The tags applied to this Amazon EBS volume. AmazonECSCreated and\n\t\t\t\tAmazonECSManaged are reserved tags that can't be used.
Determines whether to propagate the tags from the task definition to \u2028the Amazon EBS\n\t\t\tvolume. Tags can only propagate to a SERVICE specified in\n\t\t\t\t\u2028ServiceVolumeConfiguration. If no value is specified, the tags aren't\n\t\t\t\u2028propagated.
The tag specifications of an Amazon EBS volume.
" - } - }, - "com.amazonaws.ecs#EBSTagSpecifications": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#EBSTagSpecification" - } - }, - "com.amazonaws.ecs#EBSVolumeType": { - "type": "string" - }, - "com.amazonaws.ecs#ECSVolumeName": { - "type": "string" - }, - "com.amazonaws.ecs#EFSAuthorizationConfig": { - "type": "structure", - "members": { - "accessPointId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the EFSVolumeConfiguration must either be omitted or set\n\t\t\tto / which will enforce the path set on the EFS access point. If an access\n\t\t\tpoint is used, transit encryption must be on in the EFSVolumeConfiguration.\n\t\t\tFor more information, see Working with Amazon EFS access\n\t\t\t\tpoints in the Amazon Elastic File System User Guide.
Determines whether to use the Amazon ECS task role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on\n\t\t\tin the EFSVolumeConfiguration. If this parameter is omitted, the default\n\t\t\tvalue of DISABLED is used. For more information, see Using\n\t\t\t\tAmazon EFS access points in the Amazon Elastic Container Service Developer Guide.
The authorization configuration details for the Amazon EFS file system.
" - } - }, - "com.amazonaws.ecs#EFSAuthorizationConfigIAM": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.ecs#EFSTransitEncryption": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.ecs#EFSVolumeConfiguration": { - "type": "structure", - "members": { - "fileSystemId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon EFS file system ID to use.
", - "smithy.api#required": {} - } - }, - "rootDirectory": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The directory within the Amazon EFS file system to mount as the root directory inside the\n\t\t\thost. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n\t\t\tSpecifying / will have the same effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the\n\t\t\t\troot directory parameter must either be omitted or set to / which will\n\t\t\t\tenforce the path set on the EFS access point.
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host\n\t\t\tand the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization\n\t\t\tis used. If this parameter is omitted, the default value of DISABLED is\n\t\t\tused. For more information, see Encrypting data in transit in\n\t\t\tthe Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n\t\t\tserver. If you do not specify a transit encryption port, it will use the port selection\n\t\t\tstrategy that the Amazon EFS mount helper uses. For more information, see EFS mount\n\t\t\t\thelper in the Amazon Elastic File System User Guide.
" - } - }, - "authorizationConfig": { - "target": "com.amazonaws.ecs#EFSAuthorizationConfig", - "traits": { - "smithy.api#documentation": "The authorization configuration details for the Amazon EFS file system.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This parameter is specified when you're using an Amazon Elastic File System file system for task\n\t\t\tstorage. For more information, see Amazon EFS volumes in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#EnvironmentFile": { - "type": "structure", - "members": { - "value": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment\n\t\t\tvariable file.
", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.ecs#EnvironmentFileType", - "traits": { - "smithy.api#documentation": "The file type to use. Environment files are objects in Amazon S3. The only supported value\n\t\t\tis s3.
A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored.
If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Use a file to pass\n\t\t\t\tenvironment variables to a container in the Amazon Elastic Container Service Developer Guide.
Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations\n\t\t\tapply.
\nYou must use the following platforms for the Fargate launch type:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
Consider the following when using the Fargate launch type:
\nThe file is handled like a native Docker env-file.
\nThere is no support for shell escape handling.
\nThe container entry point interperts the VARIABLE values.
The total amount, in GiB, of ephemeral storage to set for the task. The minimum\n\t\t\tsupported value is 21 GiB and the maximum supported value is\n\t\t\t\t200 GiB.
The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in\n\t\t\t\ttasks in the Amazon ECS Developer Guide;.
\nFor tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
Runs a command remotely on a container within a task.
\nIf you use a condition key in your IAM policy to refine the conditions for the\n\t\t\tpolicy statement, for example limit the actions to a specific cluster, you receive an\n\t\t\t\tAccessDeniedException when there is a mismatch between the condition\n\t\t\tkey value and the corresponding parameter value.
For information about required permissions and considerations, see Using Amazon ECS\n\t\t\t\tExec for debugging in the Amazon ECS Developer Guide.\n\t\t
", - "smithy.api#examples": [ - { - "title": "To run a command remotely on a container in a task", - "documentation": "This example runs an interactive /bin/sh command on a container MyContainer. ", - "input": { - "cluster": "MyCluster", - "container": "MyContainer", - "command": "/bin/sh", - "interactive": true, - "task": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE" + "traits": { + "smithy.api#documentation": "Details on a task in a cluster.
" + } + }, + "com.amazonaws.ecs#TaskDefinition": { + "type": "structure", + "members": { + "taskDefinitionArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the task definition.
" + } + }, + "containerDefinitions": { + "target": "com.amazonaws.ecs#ContainerDefinitions", + "traits": { + "smithy.api#documentation": "A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task. For more information about container definition parameters and\n\t\t\tdefaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "family": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of a family that this task definition is registered to. Up to 255 characters\n\t\t\tare allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and\n\t\t\tunderscores (_) are allowed.
\nA family groups multiple versions of a task definition. Amazon ECS gives the first task\n\t\t\tdefinition that you registered to a family a revision number of 1. Amazon ECS gives\n\t\t\tsequential revision numbers to each task definition that you add.
" + } + }, + "taskRoleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the\n\t\t\ttask permission to call Amazon Web Services APIs on your behalf. For informationabout the required\n\t\t\tIAM roles for Amazon ECS, see IAM\n\t\t\t\troles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "networkMode": { + "target": "com.amazonaws.ecs#NetworkMode", + "traits": { + "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
The revision of the task in a particular family. The revision is a version number of a\n\t\t\ttask definition in a family. When you register a task definition for the first time, the\n\t\t\trevision is 1. Each time that you register a new revision of a task\n\t\t\tdefinition in the same family, the revision value always increases by one. This is even\n\t\t\tif you deregistered previous revisions in this family.
The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
\nThe host and sourcePath parameters aren't supported for\n\t\t\t\ttasks run on Fargate.
The status of the task definition.
" + } + }, + "requiresAttributes": { + "target": "com.amazonaws.ecs#RequiresAttributes", + "traits": { + "smithy.api#documentation": "The container instance attributes required by your task. When an Amazon EC2 instance is\n\t\t\tregistered to your cluster, the Amazon ECS container agent assigns some standard attributes\n\t\t\tto the instance. You can apply custom attributes. These are specified as key-value pairs\n\t\t\tusing the Amazon ECS console or the PutAttributes\n\t\t\tAPI. These attributes are used when determining task placement for tasks hosted on Amazon EC2\n\t\t\tinstances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
\nThis parameter isn't supported for tasks run on Fargate.
\nAn array of placement constraint objects to use for tasks.
\nThis parameter isn't supported for tasks run on Fargate.
\nAmazon ECS validates the task definition parameters with those supported by the launch\n\t\t\ttype. For more information, see Amazon ECS launch types\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + } + }, + "runtimePlatform": { + "target": "com.amazonaws.ecs#RuntimePlatform", + "traits": { + "smithy.api#documentation": "The operating system that your task definitions are running on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
\nWhen you specify a task in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.
The task launch types the task definition was validated against. The valid values are\n\t\t\t\tEC2, FARGATE, and EXTERNAL. For more\n\t\t\tinformation, see Amazon ECS launch types\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The number of cpu units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the memory parameter.
If you use the EC2 launch type, this field is optional. Supported values\n\t\t\tare between 128 CPU units (0.125 vCPUs) and 10240\n\t\t\tCPU units (10 vCPUs).
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The amount (in MiB) of memory used by the task.
\nIf your tasks runs on Amazon EC2 instances, you must specify either a task-level memory\n\t\t\tvalue or a container-level memory value. This field is optional and any value can be\n\t\t\tused. If a task-level memory value is specified, the container-level memory value is\n\t\t\toptional. For more information regarding container-level memory and memory reservation,\n\t\t\tsee ContainerDefinition.
\nIf your tasks runs on Fargate, this field is required. You must use one of the\n\t\t\tfollowing values. The value you choose determines your range of valid values for the\n\t\t\t\tcpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The Elastic Inference accelerator that's associated with the task.
" + } + }, + "pidMode": { + "target": "com.amazonaws.ecs#PidMode", + "traits": { + "smithy.api#documentation": "The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe configuration details for the App Mesh proxy.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tand at least version 1.26.0-1 of the ecs-init package to use a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS optimized AMI\n\t\t\tversion 20190301 or later, they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The Unix timestamp for the time when the task definition was registered.
" + } + }, + "deregisteredAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task definition was deregistered.
" + } + }, + "registeredBy": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The principal that registered the task definition.
" + } + }, + "ephemeralStorage": { + "target": "com.amazonaws.ecs#EphemeralStorage", + "traits": { + "smithy.api#documentation": "The ephemeral storage settings to use for tasks run with the task definition.
" + } + }, + "enableFaultInjection": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Enables fault injection and allows for fault injection requests to be accepted from the task's containers. \n\t\t\tThe default value is false.
Specify an Key Management Service key ID to encrypt the data between the local client\n\t\t\tand the container.
" - } - }, - "logging": { - "target": "com.amazonaws.ecs#ExecuteCommandLogging", - "traits": { - "smithy.api#documentation": "The log setting to use for redirecting logs for your execute command results. The\n\t\t\tfollowing log settings are available.
\n\n NONE: The execute command session is not logged.
\n DEFAULT: The awslogs configuration in the task\n\t\t\t\t\tdefinition is used. If no logging parameter is specified, it defaults to this\n\t\t\t\t\tvalue. If no awslogs log driver is configured in the task\n\t\t\t\t\tdefinition, the output won't be logged.
\n OVERRIDE: Specify the logging details as a part of\n\t\t\t\t\t\tlogConfiguration. If the OVERRIDE logging option\n\t\t\t\t\tis specified, the logConfiguration is required.
The log configuration for the results of the execute command actions. The logs can be\n\t\t\tsent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is\n\t\t\tspecified, a logConfiguration must be provided.
The details of the execute command configuration.
" - } - }, - "com.amazonaws.ecs#ExecuteCommandLogConfiguration": { - "type": "structure", - "members": { - "cloudWatchLogGroupName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the CloudWatch log group to send logs to.
\nThe CloudWatch log group must already be created.
\nDetermines whether to use encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be off.
" - } - }, - "s3BucketName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the S3 bucket to send logs to.
\nThe S3 bucket must already be created.
\nDetermines whether to use encryption on the S3 logs. If not specified, encryption is\n\t\t\tnot used.
" - } - }, - "s3KeyPrefix": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "An optional folder in the S3 bucket to place logs in.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The log configuration for the results of the execute command actions. The logs can be\n\t\t\tsent to CloudWatch Logs or an Amazon S3 bucket.
" - } - }, - "com.amazonaws.ecs#ExecuteCommandLogging": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } - }, - "OVERRIDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OVERRIDE" - } - } - } - }, - "com.amazonaws.ecs#ExecuteCommandRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) or short name of the cluster the task is running in.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" - } - }, - "container": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the container to execute the command on. A container name only needs to be\n\t\t\tspecified for tasks containing multiple containers.
" - } - }, - "command": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The command to run on the container.
", - "smithy.api#required": {} - } - }, - "interactive": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Use this flag to run your command in interactive mode.
", - "smithy.api#required": {} - } - }, - "task": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) or ID of the task the container is part of.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#ExecuteCommandResponse": { - "type": "structure", - "members": { - "clusterArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster.
" - } - }, - "containerArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container.
" - } - }, - "containerName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the container.
" - } - }, - "interactive": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether the execute command session is running in interactive mode. Amazon ECS\n\t\t\tonly supports initiating interactive sessions, so you must specify true for\n\t\t\tthis value.
The details of the SSM session that was created for this instance of\n\t\t\texecute-command.
" - } - }, - "taskArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig": { - "type": "structure", - "members": { - "credentialsParameter": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The authorization credential option to use. The authorization credential options can\n\t\t\tbe provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store\n\t\t\tparameter. The ARN refers to the stored credentials.
", - "smithy.api#required": {} - } - }, - "domain": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on\n\t\t\tAmazon EC2.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API\n\t\t\t\tReference.
\nFor more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration": { - "type": "structure", - "members": { - "fileSystemId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon FSx for Windows File Server file system ID to use.
", - "smithy.api#required": {} - } - }, - "rootDirectory": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory\n\t\t\tinside the host.
", - "smithy.api#required": {} - } - }, - "authorizationConfig": { - "target": "com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig", - "traits": { - "smithy.api#documentation": "The authorization configuration details for the Amazon FSx for Windows File Server file system.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "This parameter is specified when you're using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
\nFor more information and the input format, see Amazon FSx for Windows File Server volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#Failure": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the failed resource.
" - } - }, - "reason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The reason for the failure.
" - } - }, - "detail": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The details of the failure.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A failed resource. For a list of common causes, see API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#Failures": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Failure" - } - }, - "com.amazonaws.ecs#FirelensConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.ecs#FirelensConfigurationType", - "traits": { - "smithy.api#documentation": "The log router to use. The valid values are fluentd or\n\t\t\t\tfluentbit.
The options to use when configuring the log router. This field is optional and can be\n\t\t\tused to specify a custom configuration file or to add additional metadata, such as the\n\t\t\ttask, task definition, cluster, and container instance details to the log event. If\n\t\t\tspecified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}.\n\t\t\tFor more information, see Creating\n\t\t\t\ta task definition that uses a FireLens configuration in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file\n\t\t\t\ttype.
The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom log routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#FirelensConfigurationOptionsMap": { - "type": "map", - "key": { - "target": "com.amazonaws.ecs#String" - }, - "value": { - "target": "com.amazonaws.ecs#String" - } - }, - "com.amazonaws.ecs#FirelensConfigurationType": { - "type": "enum", - "members": { - "FLUENTD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fluentd" - } - }, - "FLUENTBIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fluentbit" - } - } - } - }, - "com.amazonaws.ecs#GetTaskProtection": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#GetTaskProtectionRequest" - }, - "output": { - "target": "com.amazonaws.ecs#GetTaskProtectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves the protection status of tasks in an Amazon ECS service.
", - "smithy.api#examples": [ - { - "title": "To get the protection status of a task", - "documentation": "In this example, we get the protection status for a single task.", - "input": { - "cluster": "test-task-protection", - "tasks": ["b8b1cf532d0e46ba8d44a40d1de16772"] + "traits": { + "smithy.api#documentation": "The details of a task definition which describes the container and volume definitions\n\t\t\tof an Amazon Elastic Container Service task. You can specify which Docker images to use, the required\n\t\t\tresources, and other configurations related to launching the task definition through an\n\t\t\tAmazon ECS service or task.
" + } + }, + "com.amazonaws.ecs#TaskDefinitionFamilyStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.ecs#TaskDefinitionField": { + "type": "enum", + "members": { + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGS" + } + } + } + }, + "com.amazonaws.ecs#TaskDefinitionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#TaskDefinitionField" + } + }, + "com.amazonaws.ecs#TaskDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#TaskDefinition" + } + }, + "com.amazonaws.ecs#TaskDefinitionPlacementConstraint": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraintType", + "traits": { + "smithy.api#documentation": "The type of constraint. The MemberOf constraint restricts selection to be\n\t\t\tfrom a group of valid candidates.
A cluster query language expression to apply to the constraint. For more information,\n\t\t\tsee Cluster query language in the Amazon Elastic Container Service Developer Guide.
" + } + } }, - "output": { - "protectedTasks": [ - { - "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772", - "protectionEnabled": true, - "expirationDate": "2022-11-02T06:56:32.553Z" + "traits": { + "smithy.api#documentation": "The constraint on task placement in the task definition. For more information, see\n\t\t\t\tTask placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\nTask placement constraints aren't supported for tasks run on Fargate.
\nThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", - "smithy.api#required": {} - } - }, - "tasks": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "A list of up to 100 task IDs or full ARN entries.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#GetTaskProtectionResponse": { - "type": "structure", - "members": { - "protectedTasks": { - "target": "com.amazonaws.ecs#ProtectedTasks", - "traits": { - "smithy.api#documentation": "A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is turned on for a task, the value is true. Otherwise,\n\t\t\t\t\tit is false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#GpuIds": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#String" - } - }, - "com.amazonaws.ecs#HealthCheck": { - "type": "structure", - "members": { - "command": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with CMD to run the command arguments\n\t\t\tdirectly, or CMD-SHELL to run the command with the container's default\n\t\t\tshell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list\n\t\t\tof commands in double quotes and brackets.
\n\n [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n
You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.
\n\n CMD-SHELL, curl -f http://localhost/ || exit 1\n
An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the docker container create\n\t\t\tcommand.
The time period in seconds between each health check execution. You may specify\n\t\t\tbetween 5 and 300 seconds. The default value is 30 seconds.
" - } - }, - "timeout": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The time period in seconds to wait for a health check to succeed before it is\n\t\t\tconsidered a failure. You may specify between 2 and 60 seconds. The default value is\n\t\t\t5.
" - } - }, - "retries": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The number of times to retry a failed health check before the container is considered\n\t\t\tunhealthy. You may specify between 1 and 10 retries. The default value is 3.
" - } - }, - "startPeriod": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The optional grace period to provide containers time to bootstrap before failed health\n\t\t\tchecks count towards the maximum number of retries. You can specify between 0 and 300\n\t\t\tseconds. By default, the startPeriod is off.
If a health check succeeds within the startPeriod, then the container\n\t\t\t\tis considered healthy and any subsequent failures count toward the maximum number of\n\t\t\t\tretries.
An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile). This configuration maps to the HEALTHCHECK parameter of docker\n\t\t\trun.
The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.
\nYou can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.
\nThe health check is designed to make sure that your containers survive agent restarts,\n\t\t\tupgrades, or temporary unavailability.
\nAmazon ECS performs health checks on containers with the default that launched the\n\t\t\tcontainer instance or the task.
\nThe following describes the possible healthStatus values for a\n\t\t\tcontainer:
\n HEALTHY-The container health check has passed\n\t\t\t\t\tsuccessfully.
\n UNHEALTHY-The container health check has failed.
\n UNKNOWN-The container health check is being evaluated,\n\t\t\t\t\tthere's no container health check defined, or Amazon ECS doesn't have the health\n\t\t\t\t\tstatus of the container.
The following describes the possible healthStatus values based on the\n\t\t\tcontainer health checker status of essential containers in the task with the following\n\t\t\tpriority order (high to low):
\n UNHEALTHY-One or more essential containers have failed\n\t\t\t\t\ttheir health check.
\n UNKNOWN-Any essential container running within the task is\n\t\t\t\t\tin an UNKNOWN state and no other essential containers have an\n\t\t\t\t\t\tUNHEALTHY state.
\n HEALTHY-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.
Consider the following task health example with 2 containers.
\nIf Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, the task health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, the task health is UNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tthe task health is UNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tthe task health is HEALTHY.
Consider the following task health example with 3 containers.
\nIf Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is UNKNOWN, the task health is\n\t\t\t\t\t\tUNHEALTHY.
If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.
If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tUNKNOWN.
If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is UNKNOWN, the task health is\n\t\t\t\t\tUNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tHEALTHY.
If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.
\nThe following are notes about container health check support:
\nIf the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this\n\t\t\t\t\twon't cause a container to transition to an UNHEALTHY status. This\n\t\t\t\t\tis by design, to ensure that containers remain running during agent restarts or\n\t\t\t\t\ttemporary unavailability. The health check status is the \"last heard from\"\n\t\t\t\t\tresponse from the Amazon ECS agent, so if the container was considered\n\t\t\t\t\t\tHEALTHY prior to the disconnect, that status will remain until\n\t\t\t\t\tthe agent reconnects and another health check occurs. There are no assumptions\n\t\t\t\t\tmade about the status of the container health checks.
Container health checks require version 1.17.0 or greater of the\n\t\t\t\t\tAmazon ECS container agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS container agent.
Container health checks are supported for Fargate tasks if\n\t\t\t\t\tyou're using platform version 1.1.0 or greater. For more\n\t\t\t\t\tinformation, see Fargate\n\t\t\t\t\t\tplatform versions.
Container health checks aren't supported for tasks that are part of a service\n\t\t\t\t\tthat's configured to use a Classic Load Balancer.
\nThe hostname to use in the /etc/hosts entry.
The IP address to use in the /etc/hosts entry.
Hostnames and IP address entries that are added to the /etc/hosts file of\n\t\t\ta container via the extraHosts parameter of its ContainerDefinition.
When the host parameter is used, specify a sourcePath to\n\t\t\tdeclare the path on the host container instance that's presented to the container. If\n\t\t\tthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n\t\t\t\thost parameter contains a sourcePath file location, then\n\t\t\tthe data volume persists at the specified location on the host container instance until\n\t\t\tyou delete it manually. If the sourcePath value doesn't exist on the host\n\t\t\tcontainer instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.
If you're using the Fargate launch type, the sourcePath\n\t\t\tparameter is not supported.
Details on a container instance bind mount host volume.
" - } - }, - "com.amazonaws.ecs#IAMRoleArn": { - "type": "string" - }, - "com.amazonaws.ecs#InferenceAccelerator": { - "type": "structure", - "members": { - "deviceName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Elastic Inference accelerator device name. The deviceName must also\n\t\t\tbe referenced in a container definition as a ResourceRequirement.
The Elastic Inference accelerator type to use.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#InferenceAcceleratorOverride": { - "type": "structure", - "members": { - "deviceName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Elastic Inference accelerator device name to override for the task. This parameter\n\t\t\tmust match a deviceName specified in the task definition.
The Elastic Inference accelerator type to use.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details on an Elastic Inference accelerator task override. This parameter is used to\n\t\t\toverride the Elastic Inference accelerator specified in the task definition. For more\n\t\t\tinformation, see Working with Amazon\n\t\t\t\tElastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#InferenceAcceleratorOverrides": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#InferenceAcceleratorOverride" - } - }, - "com.amazonaws.ecs#InferenceAccelerators": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#InferenceAccelerator" - } - }, - "com.amazonaws.ecs#InstanceHealthCheckResult": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.ecs#InstanceHealthCheckType", - "traits": { - "smithy.api#documentation": "The type of container instance health status that was verified.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#InstanceHealthCheckState", - "traits": { - "smithy.api#documentation": "The container instance health status.
" - } - }, - "lastUpdated": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for when the container instance health status was last\n\t\t\tupdated.
" - } - }, - "lastStatusChange": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for when the container instance health status last changed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the result of a container instance health status check.
" - } - }, - "com.amazonaws.ecs#InstanceHealthCheckResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#InstanceHealthCheckResult" - } - }, - "com.amazonaws.ecs#InstanceHealthCheckState": { - "type": "enum", - "members": { - "OK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OK" - } - }, - "IMPAIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPAIRED" - } - }, - "INSUFFICIENT_DATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSUFFICIENT_DATA" - } - }, - "INITIALIZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIALIZING" - } - } - } - }, - "com.amazonaws.ecs#InstanceHealthCheckType": { - "type": "enum", - "members": { - "CONTAINER_RUNTIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINER_RUNTIME" - } - } - } - }, - "com.amazonaws.ecs#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.ecs#IntegerList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#BoxedInteger" - } - }, - "com.amazonaws.ecs#InvalidParameterException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified parameter isn't valid. Review the available parameters for the API\n\t\t\trequest.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#IpcMode": { - "type": "enum", - "members": { - "HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "host" - } - }, - "TASK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "task" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "none" - } - } - } - }, - "com.amazonaws.ecs#KernelCapabilities": { - "type": "structure", - "members": { - "add": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The Linux capabilities for the container that have been added to the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapAdd in the\n\t\t\tdocker container create command and the --cap-add option to docker\n\t\t\trun.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel\n\t\t\t\tcapability.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n
The Linux capabilities for the container that have been removed from the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapDrop in the\n\t\t\tdocker container create command and the --cap-drop option to docker\n\t\t\trun.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n
The Linux capabilities to add or remove from the default Docker configuration for a\n\t\t\tcontainer defined in the task definition. For more detailed information about these\n\t\t\tLinux capabilities, see the capabilities(7) Linux manual page.
" - } - }, - "com.amazonaws.ecs#KeyValuePair": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the\n\t\t\tenvironment variable.
" - } - }, - "value": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the\n\t\t\tenvironment variable.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A key-value pair object.
" - } - }, - "com.amazonaws.ecs#LaunchType": { - "type": "enum", - "members": { - "EC2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2" - } - }, - "FARGATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FARGATE" - } - }, - "EXTERNAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXTERNAL" - } - } - } - }, - "com.amazonaws.ecs#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The limit for the resource was exceeded.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#LinuxParameters": { - "type": "structure", - "members": { - "capabilities": { - "target": "com.amazonaws.ecs#KernelCapabilities", - "traits": { - "smithy.api#documentation": "The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker.
\nFor tasks that use the Fargate launch type,\n\t\t\t\t\tcapabilities is supported for all platform versions but the\n\t\t\t\t\tadd parameter is only supported if using platform version 1.4.0 or\n\t\t\t\tlater.
Any host devices to expose to the container. This parameter maps to\n\t\t\t\tDevices in the docker container create command and the\n\t\t\t\t--device option to docker run.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tdevices parameter isn't supported.
Run an init process inside the container that forwards signals and reaps\n\t\t\tprocesses. This parameter maps to the --init option to docker run.\n\t\t\tThis parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The value for the size (in MiB) of the /dev/shm volume. This parameter\n\t\t\tmaps to the --shm-size option to docker run.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tsharedMemorySize parameter is not supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the --tmpfs option to docker run.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\ttmpfs parameter isn't supported.
The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the --memory-swap option to docker run where the value would\n\t\t\tbe the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not\n\t\t\tuse swap. Accepted values are 0 or any positive integer. If the\n\t\t\t\tmaxSwap parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A maxSwap value\n\t\t\tmust be set for the swappiness parameter to be used.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tmaxSwap parameter isn't supported.
If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't\n\t\t\t\tsupported.
This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\tswappiness value of 0 will cause swapping to not happen\n\t\t\tunless absolutely necessary. A swappiness value of 100 will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t0 and 100. If the swappiness parameter is not\n\t\t\tspecified, a default value of 60 is used. If a value is not specified for\n\t\t\t\tmaxSwap then this parameter is ignored. This parameter maps to the\n\t\t\t\t--memory-swappiness option to docker run.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tswappiness parameter isn't supported.
If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't\n\t\t\t\tsupported.
The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
" - } - }, - "com.amazonaws.ecs#ListAccountSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#ListAccountSettingsRequest" - }, - "output": { - "target": "com.amazonaws.ecs#ListAccountSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the account settings for a specified principal.
", - "smithy.api#examples": [ - { - "title": "To view the effective account settings for a specific IAM user or IAM role", - "documentation": "This example displays the effective account settings for the specified user or role.", - "input": { - "effectiveSettings": true, - "principalArn": "arn:aws:iam::The total amount, in GiB, of the ephemeral storage to set for the task. The minimum\n\t\t\tsupported value is 20 GiB and the maximum supported value is\u2028\n\t\t\t\t200 GiB.
Specify an Key Management Service key ID to encrypt the ephemeral storage for the\n\t\t\ttask.
" + } + } }, - "output": { - "settings": [ - { - "name": "containerInstanceLongArnFormat", - "value": "disabled", - "principalArn": "arn:aws:iam::The amount of ephemeral storage to allocate for the task.
" + } + }, + "com.amazonaws.ecs#TaskField": { + "type": "enum", + "members": { + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGS" + } + } + } + }, + "com.amazonaws.ecs#TaskFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#TaskField" + } + }, + "com.amazonaws.ecs#TaskFilesystemType": { + "type": "enum", + "members": { + "EXT3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ext3" + } }, - { - "name": "serviceLongArnFormat", - "value": "enabled", - "principalArn": "arn:aws:iam::Indicates whether the volume should be encrypted. If no value is specified, encryption\n\t\t\tis turned on by default. This parameter maps 1:1 with the Encrypted\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When\n\t\t\tencryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key\n\t\t\tfor Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe volume type. This parameter maps 1:1 with the VolumeType parameter of\n\t\t\tthe CreateVolume API in the Amazon EC2 API Reference. For more\n\t\t\tinformation, see Amazon EBS volume types in\n\t\t\tthe Amazon EC2 User Guide.
The following are the supported volume types.
\nGeneral Purpose SSD: gp2|gp3\n
Provisioned IOPS SSD: io1|io2\n
Throughput Optimized HDD: st1\n
Cold HDD: sc1\n
Magnetic: standard\n
The magnetic volume type is not supported on Fargate.
\nThe size of the volume in GiB. You must specify either a volume size or a snapshot ID.\n\t\t\tIf you specify a snapshot ID, the snapshot size is used for the volume size by default.\n\t\t\tYou can optionally specify a volume size greater than or equal to the snapshot size.\n\t\t\tThis parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot\n\t\t\tID or a volume size. This parameter maps 1:1 with the SnapshotId parameter\n\t\t\tof the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3,\n\t\t\tio1, and io2 volumes, this represents the number of IOPS that\n\t\t\tare provisioned for the volume. For gp2 volumes, this represents the\n\t\t\tbaseline performance of the volume and the rate at which the volume accumulates I/O\n\t\t\tcredits for bursting.
The following are the supported values for each volume type.
\n\n gp3: 3,000 - 16,000 IOPS
\n io1: 100 - 64,000 IOPS
\n io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The\n\t\t\tdefault for gp3 volumes is 3,000 IOPS. This parameter is not\n\t\t\tsupported for st1, sc1, or standard volume\n\t\t\ttypes.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.\n\t\t\tThis parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This\n\t\t\tparameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS\n\t\t\tinfrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend\n\t\t\tusing the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM\n\t\t\tpolicy with this role. For more information, see Amazon ECS\n\t\t\t\tinfrastructure IAM role in the Amazon ECS Developer\n\t\t\tGuide.
The termination policy for the volume when the task exits. This provides a way to\n\t\t\tcontrol whether Amazon ECS terminates the Amazon EBS volume when the task stops.
" + } + }, + "filesystemType": { + "target": "com.amazonaws.ecs#TaskFilesystemType", + "traits": { + "smithy.api#documentation": "The Linux filesystem type for the volume. For volumes created from a snapshot, you\n\t\t\tmust specify the same filesystem type that the volume was using when the snapshot was\n\t\t\tcreated. If there is a filesystem type mismatch, the task will fail to start.
\nThe available filesystem types are\u2028 ext3, ext4, and\n\t\t\t\txfs. If no value is specified, the xfs filesystem type is\n\t\t\tused by default.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask.
" + } + }, + "com.amazonaws.ecs#TaskManagedEBSVolumeTerminationPolicy": { + "type": "structure", + "members": { + "deleteOnTermination": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether the volume should be deleted on when the task stops. If a value of\n\t\t\t\ttrue is specified, \u2028Amazon ECS deletes the Amazon EBS volume on your behalf when\n\t\t\tthe task goes into the STOPPED state. If no value is specified, the\n\t\t\t\u2028default value is true is used. When set to false, Amazon ECS\n\t\t\tleaves the volume in your \u2028account.
The termination policy for the Amazon EBS volume when the task exits. For more information,\n\t\t\tsee Amazon ECS volume termination policy.
" + } + }, + "com.amazonaws.ecs#TaskOverride": { + "type": "structure", + "members": { + "containerOverrides": { + "target": "com.amazonaws.ecs#ContainerOverrides", + "traits": { + "smithy.api#documentation": "One or more container overrides that are sent to a task.
" + } + }, + "cpu": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The CPU override for the task.
" + } + }, + "inferenceAcceleratorOverrides": { + "target": "com.amazonaws.ecs#InferenceAcceleratorOverrides", + "traits": { + "smithy.api#documentation": "The Elastic Inference accelerator override for the task.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role override for the task. For more information,\n\t\t\tsee Amazon ECS task\n\t\t\t\texecution IAM role in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "memory": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The memory override for the task.
" + } + }, + "taskRoleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in\n\t\t\tthis task are granted the permissions that are specified in this role. For more\n\t\t\tinformation, see IAM Role for Tasks\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + } + }, + "ephemeralStorage": { + "target": "com.amazonaws.ecs#EphemeralStorage", + "traits": { + "smithy.api#documentation": "The ephemeral storage setting override for the task.
\nThis parameter is only supported for tasks hosted on Fargate that\n\t\t\t\tuse the following platform versions:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The overrides that are associated with a task.
" + } + }, + "com.amazonaws.ecs#TaskSet": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ID of the task set.
" + } + }, + "taskSetArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task set.
" + } + }, + "serviceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service the task set exists in.
" + } + }, + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists\n\t\t\tin.
" + } + }, + "startedBy": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The tag specified when a task set is started. If an CodeDeploy deployment created the task\n\t\t\tset, the startedBy parameter is CODE_DEPLOY. If an external\n\t\t\tdeployment created the task set, the startedBy field isn't used.
The external ID associated with the task set.
\nIf an CodeDeploy deployment created a task set, the externalId parameter\n\t\t\tcontains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the externalId parameter contains the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
The status of the task set. The following describes each state.
\nThe task set is serving production traffic.
\nThe task set isn't serving production traffic.
\nThe tasks in the task set are being stopped, and their corresponding\n\t\t\t\t\t\ttargets are being deregistered from their target group.
\nThe task definition that the task set is using.
" + } + }, + "computedDesiredCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The computed desired count for the task set. This is calculated by multiplying the\n\t\t\tservice's desiredCount by the task set's scale percentage. The\n\t\t\tresult is always rounded up. For example, if the computed desired count is 1.2, it\n\t\t\trounds up to 2 tasks.
The number of tasks in the task set that are in the PENDING status during\n\t\t\ta deployment. A task in the PENDING state is preparing to enter the\n\t\t\t\tRUNNING state. A task set enters the PENDING status when\n\t\t\tit launches for the first time or when it's restarted after being in the\n\t\t\t\tSTOPPED state.
The number of tasks in the task set that are in the RUNNING status during\n\t\t\ta deployment. A task in the RUNNING state is running and ready for\n\t\t\tuse.
The Unix timestamp for the time when the task set was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task set was last updated.
" + } + }, + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", + "traits": { + "smithy.api#documentation": "The launch type the tasks in the task set are using. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "The capacity provider strategy that are associated with the task set.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Fargate platform version where the tasks in the task set are running. A platform\n\t\t\tversion is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "platformFamily": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The operating system that your tasks in the set are running on. A platform family is\n\t\t\tspecified only for tasks that use the Fargate launch type.
\nAll tasks in the set must have the same value.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for the task set.
" + } + }, + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", + "traits": { + "smithy.api#documentation": "Details on a load balancer that are used with a task set.
" + } + }, + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", + "traits": { + "smithy.api#documentation": "The details for the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
" + } + }, + "scale": { + "target": "com.amazonaws.ecs#Scale", + "traits": { + "smithy.api#documentation": "A floating-point percentage of your desired number of tasks to place and keep running\n\t\t\tin the task set.
" + } + }, + "stabilityStatus": { + "target": "com.amazonaws.ecs#StabilityStatus", + "traits": { + "smithy.api#documentation": "The stability status. This indicates whether the task set has reached a steady state.\n\t\t\tIf the following conditions are met, the task set are in\n\t\t\tSTEADY_STATE:
The task runningCount is equal to the\n\t\t\t\t\t\tcomputedDesiredCount.
The pendingCount is 0.
There are no tasks that are running on container instances in the\n\t\t\t\t\t\tDRAINING status.
All tasks are reporting a healthy status from the load balancers, service\n\t\t\t\t\tdiscovery, and container health checks.
\nIf any of those conditions aren't met, the stability status returns\n\t\t\t\tSTABILIZING.
The Unix timestamp for the time when the task set stability status was\n\t\t\tretrieved.
" + } }, - { - "name": "serviceLongArnFormat", - "value": "enabled", - "principalArn": "arn:aws:iam::The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The name of the account setting you want to list the settings for.
" - } - }, - "value": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The value of the account settings to filter results with. You must also specify an\n\t\t\taccount setting name to use this parameter.
" - } - }, - "principalArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the principal, which can be a user, role, or the root user. If this field is\n\t\t\tomitted, the account settings are listed only for the authenticated user.
\nFederated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nDetermines whether to return the effective settings. If true, the account\n\t\t\tsettings for the root user or the default setting for the principalArn are\n\t\t\treturned. If false, the account settings for the principalArn\n\t\t\tare returned if they're set. Otherwise, no account settings are returned.
The nextToken value returned from a ListAccountSettings\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it's possible the number\n\t\t\tof results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of account setting results returned by\n\t\t\t\tListAccountSettings in paginated output. When this parameter is used,\n\t\t\t\tListAccountSettings only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListAccountSettings\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter isn't used, then ListAccountSettings returns up to\n\t\t\t10 results and a nextToken value\n\t\t\tif applicable.
The account settings for the resource.
" - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future\n\t\t\t\tListAccountSettings request. When the results of a\n\t\t\t\tListAccountSettings request exceed maxResults, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.
Lists the attributes for Amazon ECS resources within a specified target type and cluster.\n\t\t\tWhen you specify a target type and cluster, ListAttributes returns a list\n\t\t\tof attribute objects, one for each attribute on each resource. You can filter the list\n\t\t\tof results to a single attribute name to only return results that have that name. You\n\t\t\tcan also filter the results by attribute name and value. You can do this, for example,\n\t\t\tto see which container instances in a cluster are running a Linux AMI\n\t\t\t\t(ecs.os-type=linux).
The Fargate ephemeral storage settings for the task set.
" + } } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "attributes", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.ecs#ListAttributesRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" - } - }, - "targetType": { - "target": "com.amazonaws.ecs#TargetType", - "traits": { - "smithy.api#documentation": "The type of the target to list attributes with.
", - "smithy.api#required": {} - } - }, - "attributeName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the attribute to filter the results with.
" - } - }, - "attributeValue": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The value of the attribute to filter results with. You must also specify an attribute\n\t\t\tname to use this parameter.
" - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a ListAttributes request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results that ListAttributes returned in\n\t\t\tpaginated output. When this parameter is used, ListAttributes only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListAttributes request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter isn't used, then ListAttributes returns up to\n\t\t\t100 results and a nextToken value if applicable.
A list of attribute objects that meet the criteria of the request.
" - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future ListAttributes\n\t\t\trequest. When the results of a ListAttributes request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
Returns a list of existing clusters.
", - "smithy.api#examples": [ - { - "title": "To list your available clusters", - "documentation": "This example lists all of your available clusters in your default region.", - "output": { - "clusterArns": [ - "arn:aws:ecs:us-east-1:The nextToken value returned from a ListClusters request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results that ListClusters returned in\n\t\t\tpaginated output. When this parameter is used, ListClusters only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListClusters request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter isn't used, then ListClusters returns up to 100\n\t\t\tresults and a nextToken value if applicable.
The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your\n\t\t\taccount.
" - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future ListClusters\n\t\t\trequest. When the results of a ListClusters request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
Returns a list of container instances in a specified cluster. You can filter the\n\t\t\tresults of a ListContainerInstances operation with cluster query language\n\t\t\tstatements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tlist. If you do not specify a cluster, the default cluster is assumed.
" - } - }, - "filter": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "You can filter the results of a ListContainerInstances operation with\n\t\t\tcluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The nextToken value returned from a ListContainerInstances\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls are needed. If maxResults was provided, it's possible the number of\n\t\t\tresults to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of container instance results that\n\t\t\t\tListContainerInstances returned in paginated output. When this\n\t\t\tparameter is used, ListContainerInstances only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListContainerInstances request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListContainerInstances returns up to 100 results and\n\t\t\ta nextToken value if applicable.
Filters the container instances by status. For example, if you specify the\n\t\t\t\tDRAINING status, the results include only container instances that have\n\t\t\tbeen set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the\n\t\t\tdefault is to include container instances set to all states other than\n\t\t\t\tINACTIVE.
The list of container instances with full ARN entries for each container instance\n\t\t\tassociated with the specified cluster.
" - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future\n\t\t\t\tListContainerInstances request. When the results of a\n\t\t\t\tListContainerInstances request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null\n\t\t\twhen there are no more results to return.
This operation lists all the service deployments that meet the specified filter\n\t\t\tcriteria.
\nA service deployment happens when you release a software update for the service. You\n\t\t\troute traffic from the running service revisions to the new service revison and control\n\t\t\tthe number of running tasks.
\nThis API returns the values that you use for the request parameters in DescribeServiceRevisions.
", - "smithy.api#examples": [ - { - "title": "To list service deployments that meet the specified criteria", - "documentation": "This example lists all successful service deployments for the service \"sd-example\" in the cluster \"example\".", - "input": { - "service": "sd-example", - "cluster": "example", - "status": ["SUCCESSFUL"] }, - "output": { - "serviceDeployments": [ - { - "serviceDeploymentArn": "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5", - "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example", - "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/example", - "targetServiceRevisionArn": "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095", - "status": "SUCCESSFUL" - } - ] + "traits": { + "smithy.api#documentation": "Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
The ARN or name of the service
", - "smithy.api#required": {} - } - }, - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The cluster that hosts the service. This can either be the cluster name or ARN.\n\t\t\tStarting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n\t\t\tElastic Inference (EI), and will help current customers migrate their workloads to\n\t\t\toptions that offer better price and performance. If you don't specify a cluster,\n\t\t\t\tdefault is used.
An optional filter you can use to narrow the results. If you do not specify a status,\n\t\t\tthen all status values are included in the result.
" - } - }, - "createdAt": { - "target": "com.amazonaws.ecs#CreatedAt", - "traits": { - "smithy.api#documentation": "An optional filter you can use to narrow the results by the service creation date. If\n\t\t\tyou do not specify a value, the result includes all services created before the current\n\t\t\ttime. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
" - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a ListServiceDeployments\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls are needed. If you provided maxResults, it's possible the number of\n\t\t\tresults is fewer than maxResults.
The maximum number of service deployment results that\n\t\t\t\tListServiceDeployments returned in paginated output. When this\n\t\t\tparameter is used, ListServiceDeployments only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListServiceDeployments request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and 100. If this parameter\n\t\t\tisn't used, then ListServiceDeployments returns up to 20 results and a\n\t\t\t\tnextToken value if applicable.
An overview of the service deployment, including the following properties:
\nThe ARN of the service deployment.
\nThe ARN of the service being deployed.
\nThe ARN of the cluster that hosts the service in the service\n\t\t\t\t\tdeployment.
\nThe time that the service deployment started.
\nThe time that the service deployment completed.
\nThe service deployment status.
\nInformation about why the service deployment is in the current state.
\nThe ARN of the service revision that is being deployed.
\nThe nextToken value to include in a future\n\t\t\t\tListServiceDeployments request. When the results of a\n\t\t\t\tListServiceDeployments request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null when there\n\t\t\tare no more results to return.
Returns a list of services. You can filter the results by cluster, launch type, and\n\t\t\tscheduling strategy.
", - "smithy.api#examples": [ - { - "title": "To list the services in a cluster", - "documentation": "This example lists the services running in the default cluster for an account.", - "output": { - "serviceArns": ["arn:aws:ecs:us-east-1:012345678910:service/default/my-http-service"] - } - } - ], - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "serviceArns", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.ecs#ListServicesByNamespace": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#ListServicesByNamespaceRequest" - }, - "output": { - "target": "com.amazonaws.ecs#ListServicesByNamespaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#NamespaceNotFoundException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "This operation lists all of the services that are associated with a Cloud Map\n\t\t\tnamespace. This list might include services in different clusters. In contrast,\n\t\t\t\tListServices can only list services in one cluster at a time. If you\n\t\t\tneed to filter the list of services in a single cluster by various parameters, use\n\t\t\t\tListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value that's returned from a\n\t\t\t\tListServicesByNamespace request. It indicates that more results are\n\t\t\tavailable to fulfill the request and further calls are needed. If\n\t\t\t\tmaxResults is returned, it is possible the number of results is less\n\t\t\tthan maxResults.
The maximum number of service results that ListServicesByNamespace\n\t\t\treturns in paginated output. When this parameter is used,\n\t\t\t\tListServicesByNamespace only returns maxResults results in\n\t\t\ta single page along with a nextToken response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\t\tListServicesByNamespace request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListServicesByNamespace returns up to\n\t\t\t10 results and a nextToken\n\t\t\tvalue if applicable.
The list of full ARN entries for each service that's associated with the specified\n\t\t\tnamespace.
" - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future\n\t\t\t\tListServicesByNamespace request. When the results of a\n\t\t\t\tListServicesByNamespace request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. When there are no more results\n\t\t\tto return, this value is null.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the\n\t\t\t\tListServices results. If you do not specify a cluster, the default cluster is assumed.
The nextToken value returned from a ListServices request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of service results that ListServices returned in\n\t\t\tpaginated output. When this parameter is used, ListServices only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListServices request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If\n\t\t\tthis parameter isn't used, then ListServices returns up to\n\t\t\t10 results and a nextToken value if\n\t\t\tapplicable.
The launch type to use when filtering the ListServices results.
The scheduling strategy to use when filtering the ListServices\n\t\t\tresults.
The list of full ARN entries for each service that's associated with the specified\n\t\t\tcluster.
" - } - }, - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future ListServices\n\t\t\trequest. When the results of a ListServices request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
List the tags for an Amazon ECS resource.
", - "smithy.api#examples": [ - { - "title": "To list the tags for a cluster.", - "documentation": "This example lists the tags for the 'dev' cluster.", - "input": { - "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev" - }, - "output": { - "tags": [ - { - "key": "team", - "value": "dev" + }, + "com.amazonaws.ecs#TaskSetField": { + "type": "enum", + "members": { + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGS" + } } - ] - } - } - ] - } - }, - "com.amazonaws.ecs#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the\n\t\t\tsupported resources are Amazon ECS tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The tags for the resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#ListTaskDefinitionFamilies": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#ListTaskDefinitionFamiliesRequest" - }, - "output": { - "target": "com.amazonaws.ecs#ListTaskDefinitionFamiliesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of task definition families that are registered to your account. This\n\t\t\tlist includes task definition families that no longer have any ACTIVE task\n\t\t\tdefinition revisions.
You can filter out task definition families that don't contain any ACTIVE\n\t\t\ttask definition revisions by setting the status parameter to\n\t\t\t\tACTIVE. You can also filter the results with the\n\t\t\t\tfamilyPrefix parameter.
The familyPrefix is a string that's used to filter the results of\n\t\t\t\tListTaskDefinitionFamilies. If you specify a familyPrefix,\n\t\t\tonly task definition family names that begin with the familyPrefix string\n\t\t\tare returned.
The task definition family status to filter the\n\t\t\t\tListTaskDefinitionFamilies results with. By default, both\n\t\t\t\tACTIVE and INACTIVE task definition families are listed.\n\t\t\tIf this parameter is set to ACTIVE, only task definition families that have\n\t\t\tan ACTIVE task definition revision are returned. If this parameter is set\n\t\t\tto INACTIVE, only task definition families that do not have any\n\t\t\t\tACTIVE task definition revisions are returned. If you paginate the\n\t\t\tresulting output, be sure to keep the status value constant in each\n\t\t\tsubsequent request.
The nextToken value returned from a\n\t\t\t\tListTaskDefinitionFamilies request indicating that more results are\n\t\t\tavailable to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be\n\t\t\tfewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task definition family results that\n\t\t\t\tListTaskDefinitionFamilies returned in paginated output. When this\n\t\t\tparameter is used, ListTaskDefinitions only returns maxResults\n\t\t\tresults in a single page along with a nextToken response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\tListTaskDefinitionFamilies request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitionFamilies returns up to 100 results\n\t\t\tand a nextToken value if applicable.
The list of task definition family names that match the\n\t\t\t\tListTaskDefinitionFamilies request.
The nextToken value to include in a future\n\t\t\t\tListTaskDefinitionFamilies request. When the results of a\n\t\t\t\tListTaskDefinitionFamilies request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null\n\t\t\twhen there are no more results to return.
Returns a list of task definitions that are registered to your account. You can filter\n\t\t\tthe results by family name with the familyPrefix parameter or by status\n\t\t\twith the status parameter.
The full family name to filter the ListTaskDefinitions results with.\n\t\t\tSpecifying a familyPrefix limits the listed task definitions to task\n\t\t\tdefinition revisions that belong to that family.
The task definition status to filter the ListTaskDefinitions results\n\t\t\twith. By default, only ACTIVE task definitions are listed. By setting this\n\t\t\tparameter to INACTIVE, you can view task definitions that are\n\t\t\t\tINACTIVE as long as an active task or service still references them. If\n\t\t\tyou paginate the resulting output, be sure to keep the status value\n\t\t\tconstant in each subsequent request.
The order to sort the results in. Valid values are ASC and\n\t\t\t\tDESC. By default, (ASC) task definitions are listed\n\t\t\tlexicographically by family name and in ascending numerical order by revision so that\n\t\t\tthe newest task definitions in a family are listed last. Setting this parameter to\n\t\t\t\tDESC reverses the sort order on family name and revision. This is so\n\t\t\tthat the newest task definitions in a family are listed first.
The nextToken value returned from a ListTaskDefinitions\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task definition results that ListTaskDefinitions\n\t\t\treturned in paginated output. When this parameter is used,\n\t\t\t\tListTaskDefinitions only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListTaskDefinitions\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitions returns up to 100 results and a\n\t\t\t\tnextToken value if applicable.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions\n\t\t\trequest.
The nextToken value to include in a future\n\t\t\t\tListTaskDefinitions request. When the results of a\n\t\t\t\tListTaskDefinitions request exceed maxResults, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.
Returns a list of tasks. You can filter the results by cluster, task definition\n\t\t\tfamily, container instance, launch type, what IAM principal started the task, or by\n\t\t\tthe desired status of the task.
\nRecently stopped tasks might appear in the returned results.
", - "smithy.api#examples": [ - { - "title": "To list the tasks on a particular container instance", - "documentation": "This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.", - "input": { - "cluster": "default", - "containerInstance": "f6bbb147-5370-4ace-8c73-c7181ded911f" - }, - "output": { - "taskArns": ["arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84"] + }, + "com.amazonaws.ecs#TaskSetFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#TaskSetField" } - }, - { - "title": "To list the tasks in a cluster", - "documentation": "This example lists all of the tasks in a cluster.", - "input": { - "cluster": "default" - }, - "output": { - "taskArns": [ - "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84", - "arn:aws:ecs:us-east-1:012345678910:task/default/6b809ef6-c67e-4467-921f-ee261c15a0a1" - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "taskArns", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.ecs#ListTasksRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the\n\t\t\t\tListTasks results. If you do not specify a cluster, the default cluster is assumed.
The container instance ID or full ARN of the container instance to use when\n\t\t\tfiltering the ListTasks results. Specifying a\n\t\t\t\tcontainerInstance limits the results to tasks that belong to that\n\t\t\tcontainer instance.
The name of the task definition family to use when filtering the\n\t\t\t\tListTasks results. Specifying a family limits the results\n\t\t\tto tasks that belong to that family.
The nextToken value returned from a ListTasks request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it's possible the number of results\n\t\t\tto be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task results that ListTasks returned in paginated\n\t\t\toutput. When this parameter is used, ListTasks only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListTasks request with the returned nextToken value.\n\t\t\tThis value can be between 1 and 100. If this parameter\n\t\t\tisn't used, then ListTasks returns up to 100 results and\n\t\t\ta nextToken value if applicable.
The startedBy value to filter the task results with. Specifying a\n\t\t\t\tstartedBy value limits the results to tasks that were started with that\n\t\t\tvalue.
When you specify startedBy as the filter, it must be the only filter that\n\t\t\tyou use.
The name of the service to use when filtering the ListTasks results.\n\t\t\tSpecifying a serviceName limits the results to tasks that belong to that\n\t\t\tservice.
The task desired status to use when filtering the ListTasks results.\n\t\t\tSpecifying a desiredStatus of STOPPED limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to STOPPED. This can be useful\n\t\t\tfor debugging tasks that aren't starting properly or have died or finished. The default\n\t\t\tstatus filter is RUNNING, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to RUNNING.
Although you can filter results based on a desired status of PENDING,\n\t\t\t\tthis doesn't return any results. Amazon ECS never sets the desired status of a task to\n\t\t\t\tthat value (only a task's lastStatus may have a value of\n\t\t\t\t\tPENDING).
The launch type to use when filtering the ListTasks results.
The list of task ARN entries for the ListTasks request.
The nextToken value to include in a future ListTasks\n\t\t\trequest. When the results of a ListTasks request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.
\nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
\nFor services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.
The name of the load balancer to associate with the Amazon ECS service or task set.
\nIf you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be\n\t\t\tomitted.
" - } - }, - "containerName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the container (as it appears in a container definition) to associate with\n\t\t\tthe load balancer.
\nYou need to specify the container name when configuring the target group for an Amazon ECS\n\t\t\tload balancer.
" - } - }, - "containerPort": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The port on the container to associate with the load balancer. This port must\n\t\t\tcorrespond to a containerPort in the task definition the tasks in the\n\t\t\tservice are using. For tasks that use the EC2 launch type, the container\n\t\t\tinstance they're launched on must allow ingress traffic on the hostPort of\n\t\t\tthe port mapping.
The load balancer configuration to use with a service or task set.
\nWhen you add, update, or remove a load balancer configuration, Amazon ECS starts a new\n\t\t\tdeployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and\n\t\t\tderegister from load balancers.
\nWe recommend that you verify this on a test environment before you update the Elastic Load Balancing\n\t\t\tconfiguration.
\nA service-linked role is required for services that use multiple target groups. For\n\t\t\tmore information, see Using\n\t\t\t\tservice-linked roles in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#LoadBalancers": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#LoadBalancer" - } - }, - "com.amazonaws.ecs#LogConfiguration": { - "type": "structure", - "members": { - "logDriver": { - "target": "com.amazonaws.ecs#LogDriver", - "traits": { - "smithy.api#documentation": "The log driver to use for the container.
\nFor tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\tsplunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\tjson-file, journald, syslog,\n\t\t\t\tsplunk, and awsfirelens.
For more information about using the awslogs log driver, see Send\n\t\t\t\tAmazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Send\n\t\t\t\tAmazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.
If you have a custom driver that isn't listed, you can fork the Amazon ECS container\n\t\t\t\tagent project that's available\n\t\t\t\t\ton GitHub and customize it to work with that driver. We encourage you to\n\t\t\t\tsubmit pull requests for changes that you would like to have included. However, we\n\t\t\t\tdon't currently provide support for running modified copies of this software.
\nThe configuration options to send to the log driver.
\nThe options you can specify depend on the log driver. Some of the options you can\n\t\t\tspecify when you use the awslogs log driver to route logs to Amazon CloudWatch\n\t\t\tinclude the following:
Required: No
\nSpecify whether you want the log group to be created automatically. If\n\t\t\t\t\t\tthis option isn't specified, it defaults to false.
Your IAM policy must include the logs:CreateLogGroup\n\t\t\t\t\t\t\tpermission before you attempt to use\n\t\t\t\t\t\t\tawslogs-create-group.
Required: Yes
\nSpecify the Amazon Web Services Region that the awslogs log driver is to\n\t\t\t\t\t\tsend your Docker logs to. You can choose to send all of your logs from\n\t\t\t\t\t\tclusters in different Regions to a single region in CloudWatch Logs. This is so that\n\t\t\t\t\t\tthey're all visible in one location. Otherwise, you can separate them by\n\t\t\t\t\t\tRegion for more granularity. Make sure that the specified log group exists\n\t\t\t\t\t\tin the Region that you specify with this option.
Required: Yes
\nMake sure to specify a log group that the awslogs log driver\n\t\t\t\t\t\tsends its log streams to.
Required: Yes, when using the Fargate launch\n\t\t\t\t\t\t\ttype.Optional for the EC2 launch type,\n\t\t\t\t\t\t\trequired for the Fargate launch type.
\nUse the awslogs-stream-prefix option to associate a log\n\t\t\t\t\t\tstream with the specified prefix, the container name, and the ID of the\n\t\t\t\t\t\tAmazon ECS task that the container belongs to. If you specify a prefix with this\n\t\t\t\t\t\toption, then the log stream takes the format\n\t\t\t\t\t\t\tprefix-name/container-name/ecs-task-id.
If you don't specify a prefix with this option, then the log stream is\n\t\t\t\t\t\tnamed after the container ID that's assigned by the Docker daemon on the\n\t\t\t\t\t\tcontainer instance. Because it's difficult to trace logs back to the\n\t\t\t\t\t\tcontainer that sent them with just the Docker container ID (which is only\n\t\t\t\t\t\tavailable on the container instance), we recommend that you specify a prefix\n\t\t\t\t\t\twith this option.
\nFor Amazon ECS services, you can use the service name as the prefix. Doing so,\n\t\t\t\t\t\tyou can trace log streams to the service that the container belongs to, the\n\t\t\t\t\t\tname of the container that sent them, and the ID of the task that the\n\t\t\t\t\t\tcontainer belongs to.
\nYou must specify a stream-prefix for your logs to have your logs appear in\n\t\t\t\t\t\tthe Log pane when using the Amazon ECS console.
\nRequired: No
\nThis option defines a multiline start pattern in Python\n\t\t\t\t\t\t\tstrftime format. A log message consists of a line that\n\t\t\t\t\t\tmatches the pattern and any following lines that don’t match the pattern.\n\t\t\t\t\t\tThe matched line is the delimiter between log messages.
One example of a use case for using this format is for parsing output such\n\t\t\t\t\t\tas a stack dump, which might otherwise be logged in multiple entries. The\n\t\t\t\t\t\tcorrect pattern allows it to be captured in a single entry.
\nFor more information, see awslogs-datetime-format.
\nYou cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.
Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.
\nRequired: No
\nThis option defines a multiline start pattern that uses a regular\n\t\t\t\t\t\texpression. A log message consists of a line that matches the pattern and\n\t\t\t\t\t\tany following lines that don’t match the pattern. The matched line is the\n\t\t\t\t\t\tdelimiter between log messages.
\nFor more information, see awslogs-multiline-pattern.
\nThis option is ignored if awslogs-datetime-format is also\n\t\t\t\t\t\tconfigured.
You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.
Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.
\nRequired: No
\nValid values: non-blocking | blocking\n
This option defines the delivery mode of log messages from the container\n\t\t\t\t\t\tto CloudWatch Logs. The delivery mode you choose affects application availability when\n\t\t\t\t\t\tthe flow of logs from container to CloudWatch is interrupted.
\nIf you use the blocking mode and the flow of logs to CloudWatch is\n\t\t\t\t\t\tinterrupted, calls from container code to write to the stdout\n\t\t\t\t\t\tand stderr streams will block. The logging thread of the\n\t\t\t\t\t\tapplication will block as a result. This may cause the application to become\n\t\t\t\t\t\tunresponsive and lead to container healthcheck failure.
If you use the non-blocking mode, the container's logs are\n\t\t\t\t\t\tinstead stored in an in-memory intermediate buffer configured with the\n\t\t\t\t\t\t\tmax-buffer-size option. This prevents the application from\n\t\t\t\t\t\tbecoming unresponsive when logs cannot be sent to CloudWatch. We recommend using\n\t\t\t\t\t\tthis mode if you want to ensure service availability and are okay with some\n\t\t\t\t\t\tlog loss. For more information, see Preventing log loss with non-blocking mode in the awslogs\n\t\t\t\t\t\t\tcontainer log driver.
Required: No
\nDefault value: 1m\n
When non-blocking mode is used, the\n\t\t\t\t\t\t\tmax-buffer-size log option controls the size of the buffer\n\t\t\t\t\t\tthat's used for intermediate message storage. Make sure to specify an\n\t\t\t\t\t\tadequate buffer size based on your application. When the buffer fills up,\n\t\t\t\t\t\tfurther logs cannot be stored. Logs that cannot be stored are lost.
To route logs using the splunk log router, you need to specify a\n\t\t\t\tsplunk-token and a splunk-url.
When you use the awsfirelens log router to route logs to an Amazon Web Services Service\n\t\t\tor Amazon Web Services Partner Network destination for log storage and analytics, you can set the\n\t\t\t\tlog-driver-buffer-limit option to limit the number of events that are\n\t\t\tbuffered in memory, before being sent to the log router container. It can help to\n\t\t\tresolve potential log loss issue because high throughput might result in memory running\n\t\t\tout for the buffer inside of Docker.
Other options you can specify when using awsfirelens to route logs depend\n\t\t\ton the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region\n\t\t\twith region and a name for the log stream with\n\t\t\tdelivery_stream.
When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with\n\t\t\t\tregion and a data stream name with stream.
When you export logs to Amazon OpenSearch Service, you can specify options like Name,\n\t\t\t\tHost (OpenSearch Service endpoint without protocol), Port,\n\t\t\t\tIndex, Type, Aws_auth,\n\t\t\t\tAws_region, Suppress_Type_Name, and\n\t\t\ttls. For more information, see Under the hood: FireLens for Amazon ECS Tasks.
When you export logs to Amazon S3, you can specify the bucket using the bucket\n\t\t\toption. You can also specify region, total_file_size,\n\t\t\t\tupload_timeout, and use_put_object as options.
This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The secrets to pass to the log configuration. For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the docker container create command and the --log-driver option to\n\t\t\tdocker run.
By default, containers use the same logging driver that the Docker daemon uses.\n\t\t\tHowever, the container might use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition.
\nUnderstand the following when specifying a log configuration for your\n\t\t\tcontainers.
\nAmazon ECS currently supports a subset of the logging drivers available to the\n\t\t\t\t\tDocker daemon. Additional log drivers may be available in future releases of the\n\t\t\t\t\tAmazon ECS container agent.
\nFor tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\t\t\tsplunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\t\t\tjson-file, journald,syslog,\n\t\t\t\t\t\tsplunk, and awsfirelens.
This parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.
\nFor tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must\n\t\t\t\t\tregister the available logging drivers with the\n\t\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\t\tcontainers placed on that instance can use these log configuration options. For\n\t\t\t\t\tmore information, see Amazon ECS container agent configuration in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
For tasks that are on Fargate, because you don't have access to the\n\t\t\t\t\tunderlying infrastructure your tasks are hosted on, any additional software\n\t\t\t\t\tneeded must be installed outside of the task. For example, the Fluentd output\n\t\t\t\t\taggregators or a remote host running Logstash to send Gelf logs to.
\nThe Unix timestamp for the time when the managed agent was last started.
" - } - }, - "name": { - "target": "com.amazonaws.ecs#ManagedAgentName", - "traits": { - "smithy.api#documentation": "The name of the managed agent. When the execute command feature is turned on, the\n\t\t\tmanaged agent name is ExecuteCommandAgent.
The reason for why the managed agent is in the state it is in.
" - } - }, - "lastStatus": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The last known status of the managed agent.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the managed agent status for the container.
" - } - }, - "com.amazonaws.ecs#ManagedAgentName": { - "type": "enum", - "members": { - "ExecuteCommandAgent": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExecuteCommandAgent" - } - } - } - }, - "com.amazonaws.ecs#ManagedAgentStateChange": { - "type": "structure", - "members": { - "containerName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the container that's associated with the managed agent.
", - "smithy.api#required": {} - } - }, - "managedAgentName": { - "target": "com.amazonaws.ecs#ManagedAgentName", - "traits": { - "smithy.api#documentation": "The name of the managed agent.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the managed agent.
", - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The reason for the status of the managed agent.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing a change in state for a managed agent.
" - } - }, - "com.amazonaws.ecs#ManagedAgentStateChanges": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ManagedAgentStateChange" - } - }, - "com.amazonaws.ecs#ManagedAgents": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ManagedAgent" - } - }, - "com.amazonaws.ecs#ManagedDraining": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.ecs#ManagedScaling": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.ecs#ManagedScalingStatus", - "traits": { - "smithy.api#documentation": "Determines whether to use managed scaling for the capacity provider.
" - } - }, - "targetCapacity": { - "target": "com.amazonaws.ecs#ManagedScalingTargetCapacity", - "traits": { - "smithy.api#documentation": "The target capacity utilization as a percentage for the capacity provider. The\n\t\t\tspecified value must be greater than 0 and less than or equal to\n\t\t\t\t100. For example, if you want the capacity provider to maintain 10%\n\t\t\tspare capacity, then that means the utilization is 90%, so use a\n\t\t\t\ttargetCapacity of 90. The default value of\n\t\t\t\t100 percent results in the Amazon EC2 instances in your Auto Scaling group\n\t\t\tbeing completely used.
The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.
\nIf you use a capacity provider with an Auto Scaling group configured with more than\n\t\t\tone Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum\n\t\t\tscaling step size value and will ignore both the maximum scaling step size as well as\n\t\t\tthe capacity demand.
" - } - }, - "maximumScalingStepSize": { - "target": "com.amazonaws.ecs#ManagedScalingStepSize", - "traits": { - "smithy.api#documentation": "The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this\n\t\t\tparameter is omitted, the default value of 10000 is used.
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute\n\t\t\tto CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value\n\t\t\tof 300 seconds is used.
The managed scaling settings for the Auto Scaling group capacity provider.
\nWhen managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is off, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.
" - } - }, - "com.amazonaws.ecs#ManagedScalingInstanceWarmupPeriod": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 10000 - } - } - }, - "com.amazonaws.ecs#ManagedScalingStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.ecs#ManagedScalingStepSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.ecs#ManagedScalingTargetCapacity": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.ecs#ManagedStorageConfiguration": { - "type": "structure", - "members": { - "kmsKeyId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Specify a Key Management Service key ID to encrypt the managed storage.
" - } - }, - "fargateEphemeralStorageKmsKeyId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Specify the Key Management Service key ID for the Fargate ephemeral storage.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The managed storage configuration for the cluster.
" - } - }, - "com.amazonaws.ecs#ManagedTerminationProtection": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.ecs#MissingVersionException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Amazon ECS can't determine the current version of the Amazon ECS container agent on the\n\t\t\tcontainer instance and doesn't have enough information to proceed with an update. This\n\t\t\tcould be because the agent running on the container instance is a previous or custom\n\t\t\tversion that doesn't use our version information.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#MountPoint": { - "type": "structure", - "members": { - "sourceVolume": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the volume to mount. Must be a volume name referenced in the\n\t\t\t\tname parameter of task definition volume.
The path on the container to mount the host volume at.
" - } - }, - "readOnly": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "If this value is true, the container has read-only access to the volume.\n\t\t\tIf this value is false, then the container can write to the volume. The\n\t\t\tdefault value is false.
The details for a volume mount point that's used in a container definition.
" - } - }, - "com.amazonaws.ecs#MountPointList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#MountPoint" - } - }, - "com.amazonaws.ecs#NamespaceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified namespace wasn't found.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#NetworkBinding": { - "type": "structure", - "members": { - "bindIP": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The IP address that the container is bound to on the container instance.
" - } - }, - "containerPort": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The port number on the container that's used with the network binding.
" - } - }, - "hostPort": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The port number on the host that's used with the network binding.
" - } - }, - "protocol": { - "target": "com.amazonaws.ecs#TransportProtocol", - "traits": { - "smithy.api#documentation": "The protocol used for the network binding.
" - } - }, - "containerPortRange": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The port number range on the container that's bound to the dynamically mapped host\n\t\t\tport range.
\nThe following rules apply when you specify a containerPortRange:
You must use either the bridge network mode or the awsvpc\n\t\t\t\t\tnetwork mode.
This parameter is available for both the EC2 and Fargate launch types.
\nThis parameter is available for both the Linux and Windows operating systems.
\nThe container instance must have at least version 1.67.0 of the container agent\n\t\t\t\t\tand at least version 1.67.0-1 of the ecs-init package
You can specify a maximum of 100 port ranges per container.
\nYou do not specify a hostPortRange. The value of the hostPortRange is set\n\t\t\t\t\tas follows:
For containers in a task with the awsvpc network mode,\n\t\t\t\t\t\t\tthe hostPortRange is set to the same value as the\n\t\t\t\t\t\t\t\tcontainerPortRange. This is a static mapping\n\t\t\t\t\t\t\tstrategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange valid values are between 1 and\n\t\t\t\t\t65535.
A port can only be included in one port mapping per container.
\nYou cannot specify overlapping port ranges.
\nThe first port in the range must be less than last port in the range.
\nDocker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
\nFor more information, see Issue #11185 on the Github website.
\nFor information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
\nYou can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.
The port number range on the host that's used with the network binding. This is\n\t\t\tassigned is assigned by Docker and delivered by the Amazon ECS agent.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details on the network bindings between a container and its host container instance.\n\t\t\tAfter a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\t\tDescribeTasks API\n\t\t\tresponses.
The VPC subnets and security groups that are associated with a task.
\nAll specified subnets and security groups must be from the same VPC.
\nThe network configuration for a task or service.
" - } - }, - "com.amazonaws.ecs#NetworkInterface": { - "type": "structure", - "members": { - "attachmentId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The attachment ID for the network interface.
" - } - }, - "privateIpv4Address": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The private IPv4 address for the network interface.
" - } - }, - "ipv6Address": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The private IPv6 address for the network interface.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the elastic network interface for tasks that use the\n\t\t\t\tawsvpc network mode.
Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "There's no update available for this Amazon ECS container agent. This might be because the\n\t\t\tagent is already running the latest version or because it's so old that there's no\n\t\t\tupdate path to the current version.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#OSFamily": { - "type": "enum", - "members": { - "WINDOWS_SERVER_2019_FULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2019_FULL" - } - }, - "WINDOWS_SERVER_2019_CORE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2019_CORE" - } - }, - "WINDOWS_SERVER_2016_FULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2016_FULL" - } - }, - "WINDOWS_SERVER_2004_CORE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2004_CORE" - } - }, - "WINDOWS_SERVER_2022_CORE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2022_CORE" - } - }, - "WINDOWS_SERVER_2022_FULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2022_FULL" - } - }, - "WINDOWS_SERVER_20H2_CORE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_20H2_CORE" - } - }, - "LINUX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINUX" - } - } - } - }, - "com.amazonaws.ecs#PidMode": { - "type": "enum", - "members": { - "HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "host" - } - }, - "TASK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "task" - } - } - } - }, - "com.amazonaws.ecs#PlacementConstraint": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.ecs#PlacementConstraintType", - "traits": { - "smithy.api#documentation": "The type of constraint. Use distinctInstance to ensure that each task in\n\t\t\ta particular group is running on a different container instance. Use\n\t\t\t\tmemberOf to restrict the selection to a group of valid\n\t\t\tcandidates.
A cluster query language expression to apply to the constraint. The expression can\n\t\t\thave a maximum length of 2000 characters. You can't specify an expression if the\n\t\t\tconstraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\nIf you're using the Fargate launch type, task placement constraints\n\t\t\t\taren't supported.
\nThe type of placement strategy. The random placement strategy randomly\n\t\t\tplaces tasks on available candidates. The spread placement strategy spreads\n\t\t\tplacement across available candidates evenly based on the field parameter.\n\t\t\tThe binpack strategy places tasks on available candidates that have the\n\t\t\tleast available amount of the resource that's specified with the field\n\t\t\tparameter. For example, if you binpack on memory, a task is placed on the instance with\n\t\t\tthe least amount of remaining memory but still enough to run the task.
The field to apply the placement strategy against. For the spread\n\t\t\tplacement strategy, valid values are instanceId (or host,\n\t\t\twhich has the same effect), or any platform or custom attribute that's applied to a\n\t\t\tcontainer instance, such as attribute:ecs.availability-zone. For the\n\t\t\t\tbinpack placement strategy, valid values are cpu and\n\t\t\t\tmemory. For the random placement strategy, this field is\n\t\t\tnot used.
The task placement strategy for a task or service. For more information, see Task placement strategies in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#PlacementStrategyType": { - "type": "enum", - "members": { - "RANDOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "random" - } - }, - "SPREAD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spread" - } - }, - "BINPACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "binpack" - } - } - } - }, - "com.amazonaws.ecs#PlatformDevice": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID for the GPUs on the container instance. The available GPU IDs can also be\n\t\t\tobtained on the container instance in the\n\t\t\t\t/var/lib/ecs/gpu/nvidia_gpu_info.json file.
The type of device that's available on the container instance. The only supported\n\t\t\tvalue is GPU.
The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" - } - }, - "com.amazonaws.ecs#PlatformDeviceType": { - "type": "enum", - "members": { - "GPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GPU" - } - } - } - }, - "com.amazonaws.ecs#PlatformDevices": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#PlatformDevice" - } - }, - "com.amazonaws.ecs#PlatformTaskDefinitionIncompatibilityException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified platform version doesn't satisfy the required capabilities of the task\n\t\t\tdefinition.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#PlatformUnknownException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified platform version doesn't exist.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#PortMapping": { - "type": "structure", - "members": { - "containerPort": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The port number on the container that's bound to the user-specified or automatically\n\t\t\tassigned host port.
\nIf you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort.
If you use containers in a task with the bridge network mode and you\n\t\t\tspecify a container port and not a host port, your container automatically receives a\n\t\t\thost port in the ephemeral port range. For more information, see hostPort.\n\t\t\tPort mappings that are automatically assigned in this way do not count toward the 100\n\t\t\treserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
\nIf you specify a containerPortRange, leave this field empty and the value\n\t\t\tof the hostPort is set as follows:
For containers in a task with the awsvpc network mode, the\n\t\t\t\t\t\thostPort is set to the same value as the\n\t\t\t\t\t\tcontainerPort. This is a static mapping strategy.
For containers in a task with the bridge network mode, the Amazon ECS\n\t\t\t\t\tagent finds open ports on the host and automatically binds them to the container\n\t\t\t\t\tports. This is a dynamic mapping strategy.
If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.
If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535\n\t\t\t(Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port\n\t\t\tin the ephemeral port range as these are reserved for automatic assignment. In general,\n\t\t\tports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\t\tremainingResources of DescribeContainerInstances output. A container instance can have up to 100\n\t\t\treserved ports at a time. This number includes the default reserved ports. Automatically\n\t\t\tassigned ports aren't included in the 100 reserved ports quota.
The protocol used for the port mapping. Valid values are tcp and\n\t\t\t\tudp. The default is tcp. protocol is\n\t\t\timmutable in a Service Connect service. Updating this field requires a service deletion\n\t\t\tand redeployment.
The name that's used for the port mapping. This parameter is the name that you use in\n\t\t\tthe serviceConnectConfiguration and the\n\t\t\t\tvpcLatticeConfigurations of a service. The name can include up to 64\n\t\t\tcharacters. The characters can include lowercase letters, numbers, underscores (_), and\n\t\t\thyphens (-). The name can't start with a hyphen.
The application protocol that's used for the port mapping. This parameter only applies\n\t\t\tto Service Connect. We recommend that you set this parameter to be consistent with the\n\t\t\tprotocol that your application uses. If you set this parameter, Amazon ECS adds\n\t\t\tprotocol-specific connection handling to the Service Connect proxy. If you set this\n\t\t\tparameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
\nIf you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't\n\t\t\tadd protocol-specific telemetry for TCP.
\n\n appProtocol is immutable in a Service Connect service. Updating this\n\t\t\tfield requires a service deletion and redeployment.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "containerPortRange": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The port number range on the container that's bound to the dynamically mapped host\n\t\t\tport range.
\nThe following rules apply when you specify a containerPortRange:
You must use either the bridge network mode or the awsvpc\n\t\t\t\t\tnetwork mode.
This parameter is available for both the EC2 and Fargate launch types.
\nThis parameter is available for both the Linux and Windows operating systems.
\nThe container instance must have at least version 1.67.0 of the container agent\n\t\t\t\t\tand at least version 1.67.0-1 of the ecs-init package
You can specify a maximum of 100 port ranges per container.
\nYou do not specify a hostPortRange. The value of the hostPortRange is set\n\t\t\t\t\tas follows:
For containers in a task with the awsvpc network mode,\n\t\t\t\t\t\t\tthe hostPortRange is set to the same value as the\n\t\t\t\t\t\t\t\tcontainerPortRange. This is a static mapping\n\t\t\t\t\t\t\tstrategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange valid values are between 1 and\n\t\t\t\t\t65535.
A port can only be included in one port mapping per container.
\nYou cannot specify overlapping port ranges.
\nThe first port in the range must be less than last port in the range.
\nDocker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
\nFor more information, see Issue #11185 on the Github website.
\nFor information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
\nYou can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.
Port mappings allow containers to access ports on the host container instance to send\n\t\t\tor receive traffic. Port mappings are specified as part of the container\n\t\t\tdefinition.
\nIf you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort. The\n\t\t\t\thostPort can be left blank or it must be the same value as the\n\t\t\t\tcontainerPort.
Most fields of this parameter (containerPort, hostPort,\n\t\t\t\tprotocol) maps to PortBindings in the docker container\n\t\t\tcreate command and the --publish option to docker run. If the\n\t\t\tnetwork mode of a task definition is set to host, host ports must either be\n\t\t\tundefined or match the container port in the port mapping.
You can't expose the same container port for multiple protocols. If you attempt\n\t\t\t\tthis, an error is returned.
\nAfter a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\t\tDescribeTasks API\n\t\t\tresponses.
The task ARN.
" - } - }, - "protectionEnabled": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "The protection status of the task. If scale-in protection is on for a task, the value\n\t\t\tis true. Otherwise, it is false.
The epoch time when protection for the task will expire.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the protection status details for a task. You can set the\n\t\t\tprotection status with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection API.
" - } - }, - "com.amazonaws.ecs#ProtectedTasks": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ProtectedTask" - } - }, - "com.amazonaws.ecs#ProxyConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.ecs#ProxyConfigurationType", - "traits": { - "smithy.api#documentation": "The proxy type. The only supported value is APPMESH.
The name of the container that will serve as the App Mesh proxy.
", - "smithy.api#required": {} - } - }, - "properties": { - "target": "com.amazonaws.ecs#ProxyConfigurationProperties", - "traits": { - "smithy.api#documentation": "The set of network configuration parameters to provide the Container Network Interface\n\t\t\t(CNI) plugin, specified as key-value pairs.
\n\n IgnoredUID - (Required) The user ID (UID) of the proxy\n\t\t\t\t\tcontainer as defined by the user parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredGID is specified, this field can be empty.
\n IgnoredGID - (Required) The group ID (GID) of the proxy\n\t\t\t\t\tcontainer as defined by the user parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredUID is specified, this field can be empty.
\n AppPorts - (Required) The list of ports that the\n\t\t\t\t\tapplication uses. Network traffic to these ports is forwarded to the\n\t\t\t\t\t\tProxyIngressPort and ProxyEgressPort.
\n ProxyIngressPort - (Required) Specifies the port that\n\t\t\t\t\tincoming traffic to the AppPorts is directed to.
\n ProxyEgressPort - (Required) Specifies the port that\n\t\t\t\t\toutgoing traffic from the AppPorts is directed to.
\n EgressIgnoredPorts - (Required) The egress traffic going to\n\t\t\t\t\tthe specified ports is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort. It can be an empty list.
\n EgressIgnoredIPs - (Required) The egress traffic going to\n\t\t\t\t\tthe specified IP addresses is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort. It can be an empty list.
The configuration details for the App Mesh proxy.
\nFor tasks that use the EC2 launch type, the container instances require\n\t\t\tat least version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init package to use a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS optimized AMI version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n
Modifies an account setting. Account settings are set on a per-Region basis.
\nIf you change the root user account setting, the default settings are reset for users and\n\t\t\troles that do not have specified individual account settings. For more information, see\n\t\t\t\tAccount\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.
", - "smithy.api#examples": [ - { - "title": "To modify the account settings for a specific IAM user or IAM role", - "documentation": "This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", - "input": { - "name": "containerInstanceLongArnFormat", - "value": "enabled", - "principalArn": "arn:aws:iam::Message that describes the cause of the exception.
" + } + } }, - "output": { - "setting": { - "name": "serviceLongArnFormat", - "value": "enabled", - "principalArn": "arn:aws:iam::The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and\n\t\t\tRegion.
", + "smithy.api#error": "client" } - } - ] - } - }, - "com.amazonaws.ecs#PutAccountSettingDefault": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#PutAccountSettingDefaultRequest" - }, - "output": { - "target": "com.amazonaws.ecs#PutAccountSettingDefaultResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies an account setting for all users on an account for whom no individual account\n\t\t\tsetting has been specified. Account settings are set on a per-Region basis.
", - "smithy.api#examples": [ - { - "title": "To modify the default account settings for all IAM users or roles on an account", - "documentation": "This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", - "input": { - "name": "serviceLongArnFormat", - "value": "enabled" - }, - "output": { - "setting": { - "name": "serviceLongArnFormat", - "value": "enabled", - "principalArn": "arn:aws:iam::The resource name for which to modify the account setting.
\nThe following are the valid values for the account setting name.
\n\n serviceLongArnFormat - When modified, the Amazon Resource Name\n\t\t\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting\n\t\t\t\t\tmust be set for each Amazon ECS resource separately. The ARN and resource ID format\n\t\t\t\t\tof a resource is defined by the opt-in status of the user or role that created\n\t\t\t\t\tthe resource. You must turn on this setting to use Amazon ECS features such as\n\t\t\t\t\tresource tagging.
\n taskLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the\n\t\t\t\t\troot user for an account is affected. The opt-in and opt-out account setting must\n\t\t\t\t\tbe set for each Amazon ECS resource separately. The ARN and resource ID format of a\n\t\t\t\t\tresource is defined by the opt-in status of the user or role that created the\n\t\t\t\t\tresource. You must turn on this setting to use Amazon ECS features such as resource\n\t\t\t\t\ttagging.
\n containerInstanceLongArnFormat - When modified, the Amazon\n\t\t\t\t\tResource Name (ARN) and resource ID format of the resource type for a specified\n\t\t\t\t\tuser, role, or the root user for an account is affected. The opt-in and opt-out\n\t\t\t\t\taccount setting must be set for each Amazon ECS resource separately. The ARN and\n\t\t\t\t\tresource ID format of a resource is defined by the opt-in status of the user or\n\t\t\t\t\trole that created the resource. You must turn on this setting to use Amazon ECS\n\t\t\t\t\tfeatures such as resource tagging.
\n awsvpcTrunking - When modified, the elastic network interface\n\t\t\t\t\t(ENI) limit for any new container instances that support the feature is changed.\n\t\t\t\t\tIf awsvpcTrunking is turned on, any new container instances that\n\t\t\t\t\tsupport the feature are launched have the increased ENI limits available to\n\t\t\t\t\tthem. For more information, see Elastic\n\t\t\t\t\t\tNetwork Interface Trunking in the Amazon Elastic Container Service Developer Guide.
\n containerInsights - Container Insights with enhanced\n\t\t\t\t\tobservability provides all the Container Insights metrics, plus additional task\n\t\t\t\t\tand container metrics. This version supports enhanced observability for Amazon ECS\n\t\t\t\t\tclusters using the Amazon EC2 and Fargate launch types. After you configure\n\t\t\t\t\tContainer Insights with enhanced observability on Amazon ECS, Container Insights\n\t\t\t\t\tauto-collects detailed infrastructure telemetry from the cluster level down to\n\t\t\t\t\tthe container level in your environment and displays these critical performance\n\t\t\t\t\tdata in curated dashboards removing the heavy lifting in observability set-up.
To use Container Insights with enhanced observability, set the\n\t\t\t\t\t\tcontainerInsights account setting to\n\t\t\t\t\tenhanced.
To use Container Insights, set the containerInsights account\n\t\t\t\t\tsetting to enabled.
For more information, see Monitor Amazon ECS containers using Container Insights with enhanced\n\t\t\t\t\t\tobservability in the Amazon Elastic Container Service Developer Guide.
\n\n dualStackIPv6 - When turned on, when using a VPC in dual stack\n\t\t\t\t\tmode, your tasks using the awsvpc network mode can have an IPv6\n\t\t\t\t\taddress assigned. For more information on using IPv6 with tasks launched on\n\t\t\t\t\tAmazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6\n\t\t\t\t\twith tasks launched on Fargate, see Using a VPC in dual-stack mode.
\n fargateFIPSMode - If you specify fargateFIPSMode,\n\t\t\t\t\tFargate FIPS 140 compliance is affected.
\n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a\n\t\t\t\t\tsecurity or infrastructure update is needed for an Amazon ECS task hosted on\n\t\t\t\t\tFargate, the tasks need to be stopped and new tasks launched to replace them.\n\t\t\t\t\tUse fargateTaskRetirementWaitPeriod to configure the wait time to\n\t\t\t\t\tretire a Fargate task. For information about the Fargate tasks maintenance,\n\t\t\t\t\tsee Amazon Web Services Fargate\n\t\t\t\t\t\ttask maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n tagResourceAuthorization - Amazon ECS is introducing tagging\n\t\t\t\t\tauthorization for resource creation. Users must have permissions for actions\n\t\t\t\t\tthat create the resource, such as ecsCreateCluster. If tags are\n\t\t\t\t\tspecified when you create a resource, Amazon Web Services performs additional authorization to\n\t\t\t\t\tverify if users or roles have permissions to create tags. Therefore, you must\n\t\t\t\t\tgrant explicit permissions to use the ecs:TagResource action. For\n\t\t\t\t\tmore information, see Grant permission to tag resources on creation in the\n\t\t\t\t\t\tAmazon ECS Developer Guide.
\n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled, disabled, on, enhanced,\n\t\t\tand off.
When you specify fargateTaskRetirementWaitPeriod for the\n\t\t\t\tname, the following are the valid values:
\n 0 - Amazon Web Services sends the notification, and immediately retires the\n\t\t\t\t\taffected tasks.
\n 7 - Amazon Web Services sends the notification, and waits 7 calendar days to\n\t\t\t\t\tretire the tasks.
\n 14 - Amazon Web Services sends the notification, and waits 14 calendar days to\n\t\t\t\t\tretire the tasks.
The current setting for a resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#PutAccountSettingRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#SettingName", - "traits": { - "smithy.api#documentation": "The Amazon ECS account setting name to modify.
\nThe following are the valid values for the account setting name.
\n\n serviceLongArnFormat - When modified, the Amazon Resource Name\n\t\t\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting\n\t\t\t\t\tmust be set for each Amazon ECS resource separately. The ARN and resource ID format\n\t\t\t\t\tof a resource is defined by the opt-in status of the user or role that created\n\t\t\t\t\tthe resource. You must turn on this setting to use Amazon ECS features such as\n\t\t\t\t\tresource tagging.
\n taskLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the\n\t\t\t\t\troot user for an account is affected. The opt-in and opt-out account setting must\n\t\t\t\t\tbe set for each Amazon ECS resource separately. The ARN and resource ID format of a\n\t\t\t\t\tresource is defined by the opt-in status of the user or role that created the\n\t\t\t\t\tresource. You must turn on this setting to use Amazon ECS features such as resource\n\t\t\t\t\ttagging.
\n fargateFIPSMode - When turned on, you can run Fargate workloads\n\t\t\t\t\tin a manner that is compliant with Federal Information Processing Standard\n\t\t\t\t\t(FIPS-140). For more information, see Fargate\n\t\t\t\t\t\tFederal Information Processing Standard (FIPS-140).
\n containerInstanceLongArnFormat - When modified, the Amazon\n\t\t\t\t\tResource Name (ARN) and resource ID format of the resource type for a specified\n\t\t\t\t\tuser, role, or the root user for an account is affected. The opt-in and opt-out\n\t\t\t\t\taccount setting must be set for each Amazon ECS resource separately. The ARN and\n\t\t\t\t\tresource ID format of a resource is defined by the opt-in status of the user or\n\t\t\t\t\trole that created the resource. You must turn on this setting to use Amazon ECS\n\t\t\t\t\tfeatures such as resource tagging.
\n awsvpcTrunking - When modified, the elastic network interface\n\t\t\t\t\t(ENI) limit for any new container instances that support the feature is changed.\n\t\t\t\t\tIf awsvpcTrunking is turned on, any new container instances that\n\t\t\t\t\tsupport the feature are launched have the increased ENI limits available to\n\t\t\t\t\tthem. For more information, see Elastic\n\t\t\t\t\t\tNetwork Interface Trunking in the Amazon Elastic Container Service Developer Guide.
\n containerInsights - Container Insights with enhanced\n\t\t\t\t\tobservability provides all the Container Insights metrics, plus additional task\n\t\t\t\t\tand container metrics. This version supports enhanced observability for Amazon ECS\n\t\t\t\t\tclusters using the Amazon EC2 and Fargate launch types. After you configure\n\t\t\t\t\tContainer Insights with enhanced observability on Amazon ECS, Container Insights\n\t\t\t\t\tauto-collects detailed infrastructure telemetry from the cluster level down to\n\t\t\t\t\tthe container level in your environment and displays these critical performance\n\t\t\t\t\tdata in curated dashboards removing the heavy lifting in observability set-up.
To use Container Insights with enhanced observability, set the\n\t\t\t\t\t\tcontainerInsights account setting to\n\t\t\t\t\tenhanced.
To use Container Insights, set the containerInsights account\n\t\t\t\t\tsetting to enabled.
For more information, see Monitor Amazon ECS containers using Container Insights with enhanced\n\t\t\t\t\t\tobservability in the Amazon Elastic Container Service Developer Guide.
\n\n dualStackIPv6 - When turned on, when using a VPC in dual stack\n\t\t\t\t\tmode, your tasks using the awsvpc network mode can have an IPv6\n\t\t\t\t\taddress assigned. For more information on using IPv6 with tasks launched on\n\t\t\t\t\tAmazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6\n\t\t\t\t\twith tasks launched on Fargate, see Using a VPC in dual-stack mode.
\n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a\n\t\t\t\t\tsecurity or infrastructure update is needed for an Amazon ECS task hosted on\n\t\t\t\t\tFargate, the tasks need to be stopped and new tasks launched to replace them.\n\t\t\t\t\tUse fargateTaskRetirementWaitPeriod to configure the wait time to\n\t\t\t\t\tretire a Fargate task. For information about the Fargate tasks maintenance,\n\t\t\t\t\tsee Amazon Web Services Fargate\n\t\t\t\t\t\ttask maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n tagResourceAuthorization - Amazon ECS is introducing tagging\n\t\t\t\t\tauthorization for resource creation. Users must have permissions for actions\n\t\t\t\t\tthat create the resource, such as ecsCreateCluster. If tags are\n\t\t\t\t\tspecified when you create a resource, Amazon Web Services performs additional authorization to\n\t\t\t\t\tverify if users or roles have permissions to create tags. Therefore, you must\n\t\t\t\t\tgrant explicit permissions to use the ecs:TagResource action. For\n\t\t\t\t\tmore information, see Grant permission to tag resources on creation in the\n\t\t\t\t\t\tAmazon ECS Developer Guide.
\n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled, disabled, enhanced, on,\n\t\t\tand off.
When you specify fargateTaskRetirementWaitPeriod for the\n\t\t\t\tname, the following are the valid values:
\n 0 - Amazon Web Services sends the notification, and immediately retires the\n\t\t\t\t\taffected tasks.
\n 7 - Amazon Web Services sends the notification, and waits 7 calendar days to\n\t\t\t\t\tretire the tasks.
\n 14 - Amazon Web Services sends the notification, and waits 14 calendar days to\n\t\t\t\t\tretire the tasks.
The ARN of the principal, which can be a user, role, or the root user. If you specify\n\t\t\tthe root user, it modifies the account setting for all users, roles, and the root user of the\n\t\t\taccount unless a user or role explicitly overrides these settings. If this field is\n\t\t\tomitted, the setting is changed only for the authenticated user.
\nYou must use the root user when you set the Fargate wait time\n\t\t\t\t\t(fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nThe current account setting for a resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#PutAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#PutAttributesRequest" - }, - "output": { - "target": "com.amazonaws.ecs#PutAttributesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AttributeLimitExceededException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#TargetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,\n\t\t\tit's created. If the attribute exists, its value is replaced with the specified value.\n\t\t\tTo delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
", - "smithy.api#examples": [ - { - "title": "To create or update an attribute on a resource", - "documentation": "This example adds an attribute \"stack\" with the value \"production\" to a container instance.", - "input": { - "cluster": "MyCluster", - "attributes": [ - { - "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", - "name": "stack", - "value": "production" - } - ] - }, - "output": { - "attributes": [ - { - "name": "stack", - "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", - "value": "production" + }, + "com.amazonaws.ecs#TaskStopCode": { + "type": "enum", + "members": { + "TASK_FAILED_TO_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TaskFailedToStart" + } + }, + "ESSENTIAL_CONTAINER_EXITED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EssentialContainerExited" + } + }, + "USER_INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UserInitiated" + } + }, + "SERVICE_SCHEDULER_INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceSchedulerInitiated" + } + }, + "SPOT_INTERRUPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SpotInterruption" + } + }, + "TERMINATION_NOTICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TerminationNotice" + } } - ] } - } - ] - } - }, - "com.amazonaws.ecs#PutAttributesRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" - } - }, - "attributes": { - "target": "com.amazonaws.ecs#Attributes", - "traits": { - "smithy.api#documentation": "The attributes to apply to your resource. You can specify up to 10 custom attributes\n\t\t\tfor each resource. You can specify up to 10 attributes in a single call.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#PutAttributesResponse": { - "type": "structure", - "members": { - "attributes": { - "target": "com.amazonaws.ecs#Attributes", - "traits": { - "smithy.api#documentation": "The attributes applied to your resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#PutClusterCapacityProviders": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#PutClusterCapacityProvidersRequest" - }, - "output": { - "target": "com.amazonaws.ecs#PutClusterCapacityProvidersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ResourceInUseException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#UpdateInProgressException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.
\nYou must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers that are associated with a\n\t\t\tcluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the\n\t\t\tcluster. You can only disassociate an existing capacity provider from a cluster if it's\n\t\t\tnot being used by any existing tasks.
\nWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tWe recommend that you define a default capacity provider strategy for your cluster.\n\t\t\tHowever, you must specify an empty array ([]) to bypass defining a default\n\t\t\tstrategy.
The name of the volume. This value must match the volume name from the\n\t\t\t\tVolume object in the task definition.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are\n\t\t\tcreated.
" + } } - ] }, - "output": { - "cluster": { - "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", - "clusterName": "MyCluster", - "status": "ACTIVE", - "registeredContainerInstancesCount": 0, - "runningTasksCount": 0, - "pendingTasksCount": 0, - "activeServicesCount": 0, - "statistics": [], - "tags": [], - "settings": [ - { - "name": "containerInsights", - "value": "enabled" - } - ], - "capacityProviders": ["MyCapacityProvider1", "MyCapacityProvider2"], - "defaultCapacityProviderStrategy": [ - { - "capacityProvider": "MyCapacityProvider1", - "weight": 1, - "base": 0 - }, - { - "capacityProvider": "MyCapacityProvider2", - "weight": 1, - "base": 0 - } - ], - "attachments": [ - { - "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918", - "type": "as_policy", - "status": "ACTIVE", - "details": [ - { - "name": "capacityProviderName", - "value": "MyCapacityProvider1" - }, - { - "name": "scalingPolicyName", - "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" - } - ] - }, - { - "id": "ae592060-2382-4663-9476-b015c685593c", - "type": "as_policy", - "status": "ACTIVE", - "details": [ - { - "name": "capacityProviderName", - "value": "MyCapacityProvider2" - }, - { - "name": "scalingPolicyName", - "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" - } - ] - } - ], - "attachmentsStatus": "UPDATE_IN_PROGRESS" - } + "traits": { + "smithy.api#documentation": "Configuration settings for the task volume that was configuredAtLaunch\n\t\t\tthat weren't set during RegisterTaskDef.
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n\t\t\tsettings for. If you don't specify a cluster, the default cluster is assumed.
", - "smithy.api#required": {} - } - }, - "capacityProviders": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The name of one or more capacity providers to associate with the cluster.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The capacity provider strategy to use by default for the cluster.
\nWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified then the default capacity provider strategy for the cluster is\n\t\t\tused.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity provider\n\t\t\twith a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
Details about the cluster.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#RegisterContainerInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#RegisterContainerInstanceRequest" - }, - "output": { - "target": "com.amazonaws.ecs#RegisterContainerInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nRegisters an EC2 instance into the specified cluster. This instance becomes available\n\t\t\tto place containers on.
" - } - }, - "com.amazonaws.ecs#RegisterContainerInstanceRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance\n\t\t\twith. If you do not specify a cluster, the default cluster is assumed.
" - } - }, - "instanceIdentityDocument": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The instance identity document for the EC2 instance to register. This document can be\n\t\t\tfound by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/document/\n
The instance identity document signature for the EC2 instance to register. This\n\t\t\tsignature can be found by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/signature/\n
The resources available on the instance.
" - } - }, - "versionInfo": { - "target": "com.amazonaws.ecs#VersionInfo", - "traits": { - "smithy.api#documentation": "The version information for the Amazon ECS container agent and Docker daemon that runs on\n\t\t\tthe container instance.
" - } - }, - "containerInstanceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the container instance (if it was previously registered).
" - } - }, - "attributes": { - "target": "com.amazonaws.ecs#Attributes", - "traits": { - "smithy.api#documentation": "The container instance attributes that this container instance supports.
" - } - }, - "platformDevices": { - "target": "com.amazonaws.ecs#PlatformDevices", - "traits": { - "smithy.api#documentation": "The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The container instance that was registered.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#RegisterTaskDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#RegisterTaskDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.ecs#RegisterTaskDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
You can specify a role for your task with the taskRoleArn parameter. When\n\t\t\tyou specify a role for a task, its containers can then use the latest versions of the\n\t\t\tCLI or SDKs to make API requests to the Amazon Web Services services that are specified in the\n\t\t\tpolicy that's associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with the task\n\t\t\tdefinition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The amount of time in seconds a connection will stay active while idle. A value of\n\t\t\t\t0 can be set to disable idleTimeout.
The idleTimeout default for\n\t\t\t\tHTTP/HTTP2/GRPC is 5 minutes.
The idleTimeout default for TCP is 1 hour.
The amount of time waiting for the upstream to respond with a complete response per\n\t\t\trequest. A value of 0 can be set to disable perRequestTimeout.\n\t\t\t\tperRequestTimeout can only be set if Service Connect\n\t\t\t\tappProtocol isn't TCP. Only idleTimeout is\n\t\t\tallowed for TCP\n appProtocol.
An object that represents the timeout configurations for Service Connect.
\nIf idleTimeout is set to a time that is less than\n\t\t\t\t\tperRequestTimeout, the connection will close when the\n\t\t\t\t\tidleTimeout is reached and not the\n\t\t\t\tperRequestTimeout.
You must specify a family for a task definition. You can use it track\n\t\t\tmultiple versions of the same task definition. The family is used as a name\n\t\t\tfor your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can\n\t\t\tassume. All containers in this task are granted the permissions that are specified in\n\t\t\tthis role. For more information, see IAM Roles for\n\t\t\t\tTasks in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "networkMode": { - "target": "com.amazonaws.ecs#NetworkMode", - "traits": { - "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task.
", - "smithy.api#required": {} - } - }, - "volumes": { - "target": "com.amazonaws.ecs#VolumeList", - "traits": { - "smithy.api#documentation": "A list of volume definitions in JSON format that containers in your task might\n\t\t\tuse.
" - } - }, - "placementConstraints": { - "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", - "traits": { - "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify a\n\t\t\tmaximum of 10 constraints for each task. This limit includes constraints in the task\n\t\t\tdefinition and those specified at runtime.
" - } - }, - "requiresCompatibilities": { - "target": "com.amazonaws.ecs#CompatibilityList", - "traits": { - "smithy.api#documentation": "The task launch type that Amazon ECS validates the task definition against. A client\n\t\t\texception is returned if the task definition doesn't validate against the\n\t\t\tcompatibilities specified. If no value is specified, the parameter is omitted from the\n\t\t\tresponse.
" - } - }, - "cpu": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, 1024) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU or 1 vcpu) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\nIf you're using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128 CPU units (0.125 vCPUs) and\n\t\t\t\t10240 CPU units (10 vCPUs). If you do not specify a value,\n\t\t\tthe parameter is ignored.
If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB (for example ,1024) or as a string using GB (for example,\n\t\t\t\t1GB or 1 GB) in a task definition. String values are\n\t\t\tconverted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\nIf using the EC2 launch type, this field is optional.
\nIf using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values. This determines your range of supported values for the\n\t\t\t\tcpu parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The metadata that you apply to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both of them.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe configuration details for the App Mesh proxy.
\nFor tasks hosted on Amazon EC2 instances, the container instances require at least version\n\t\t\t\t1.26.0 of the container agent and at least version\n\t\t\t\t1.26.0-1 of the ecs-init package to use a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS-optimized\n\t\t\tAMI version 20190301 or later, then they contain the required versions of\n\t\t\tthe container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
The Elastic Inference accelerators to use for the containers in the task.
" - } - }, - "ephemeralStorage": { - "target": "com.amazonaws.ecs#EphemeralStorage", - "traits": { - "smithy.api#documentation": "The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in\n\t\t\t\ttasks in the Amazon ECS Developer Guide.
\nFor tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The operating system that your tasks definitions run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
" - } - }, - "enableFaultInjection": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Enables fault injection when you register your task definition and allows for fault injection requests \n\t\t\tto be accepted from the task's containers. The default value is false.
The full description of the registered task definition.
" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The list of tags associated with the task definition.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#RepositoryCredentials": { - "type": "structure", - "members": { - "credentialsParameter": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.
\nWhen you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same\n\t\t\t\tRegion as the task that you're launching then you can use either the full ARN or\n\t\t\t\tthe name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN\n\t\t\t\tof the secret.
\nThe repository credentials for private registry authentication.
" - } - }, - "com.amazonaws.ecs#RequiresAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Attribute" - } - }, - "com.amazonaws.ecs#Resource": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the resource, such as CPU, MEMORY,\n\t\t\t\tPORTS, PORTS_UDP, or a user-defined resource.
The type of the resource. Valid values: INTEGER, DOUBLE,\n\t\t\t\tLONG, or STRINGSET.
When the doubleValue type is set, the value of the resource must be a\n\t\t\tdouble precision floating-point type.
When the longValue type is set, the value of the resource must be an\n\t\t\textended precision floating-point type.
When the integerValue type is set, the value of the resource must be an\n\t\t\tinteger.
When the stringSetValue type is set, the value of the resource must be a\n\t\t\tstring type.
Describes the resources available for a container instance.
" - } - }, - "com.amazonaws.ecs#ResourceIds": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#String" - } - }, - "com.amazonaws.ecs#ResourceInUseException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified resource is in-use and can't be removed.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified resource wasn't found.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#ResourceRequirement": { - "type": "structure", - "members": { - "value": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The value for the specified resource type.
\nWhen the type is GPU, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the\n\t\t\t\tdeviceName for an InferenceAccelerator specified in a task definition.
The type of resource to assign to a container.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The type and amount of a resource to assign to a container. The supported resource\n\t\t\ttypes are GPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with Amazon Elastic\n\t\t\t\tInference on Amazon ECS in the Amazon Elastic Container Service Developer Guide\n
" - } - }, - "com.amazonaws.ecs#ResourceRequirements": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ResourceRequirement" - } - }, - "com.amazonaws.ecs#ResourceType": { - "type": "enum", - "members": { - "GPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GPU" - } - }, - "INFERENCE_ACCELERATOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InferenceAccelerator" - } - } - } - }, - "com.amazonaws.ecs#Resources": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Resource" - } - }, - "com.amazonaws.ecs#Rollback": { - "type": "structure", - "members": { - "reason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The reason the rollback happened. For example, the circuit breaker initiated the\n\t\t\trollback operation.
" - } - }, - "startedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "Time time that the rollback started. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
" - } - }, - "serviceRevisionArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the service revision deployed as part of the rollback.
\nWhen the type is GPU, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the\n\t\t\t\tdeviceName for an InferenceAccelerator specified in a task definition.
Information about the service deployment rollback.
" - } - }, - "com.amazonaws.ecs#RunTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#RunTaskRequest" - }, - "output": { - "target": "com.amazonaws.ecs#RunTaskResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#BlockedException" }, - { - "target": "com.amazonaws.ecs#ClientException" + "com.amazonaws.ecs#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.ecs#Tmpfs": { + "type": "structure", + "members": { + "containerPath": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The absolute file path where the tmpfs volume is to be mounted.
", + "smithy.api#required": {} + } + }, + "size": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum size (in MiB) of the tmpfs volume.
", + "smithy.api#required": {} + } + }, + "mountOptions": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The list of tmpfs volume mount options.
\nValid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n\t\t\t\t\"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n\t\t\t\t\"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n\t\t\t\t\"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n\t\t\t\t\"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n\t\t\t\t| \"nr_inodes\" | \"nr_blocks\" | \"mpol\"\n
The container path, mount options, and size of the tmpfs mount.
" + } }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" + "com.amazonaws.ecs#TmpfsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Tmpfs" + } }, - { - "target": "com.amazonaws.ecs#ConflictException" + "com.amazonaws.ecs#TransportProtocol": { + "type": "enum", + "members": { + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tcp" + } + }, + "UDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "udp" + } + } + } }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" + "com.amazonaws.ecs#Ulimit": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#UlimitName", + "traits": { + "smithy.api#documentation": "The type of the ulimit.
The soft limit for the ulimit type. The value can be specified in bytes,\n\t\t\tseconds, or as a count, depending on the type of the\n\t\t\tulimit.
The hard limit for the ulimit type. The value can be specified in bytes,\n\t\t\tseconds, or as a count, depending on the type of the\n\t\t\tulimit.
The ulimit settings to pass to the container.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 65535 and the default hard limit\n\t\t\t\t\t\t\tis 65535.
You can specify the ulimit settings for a container in a task\n\t\t\tdefinition.
Message that describes the cause of the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified task isn't supported in this Region.
", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Starts a new task using the specified task definition.
\nOn March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.
\nAlternatively, you can use StartTask to use your own scheduler or place\n\t\t\ttasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
\nThe Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.
\nTo manage eventual consistency, you can do the following:
\nConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\nAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\nThe capacity provider strategy to use for the task.
\nIf a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.
A capacity provider strategy can contain a maximum of 20 capacity providers.
" - } - }, - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to run your task on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" - } - }, - "count": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The number of instantiations of the specified task to place on your cluster. You can\n\t\t\tspecify up to 10 tasks for each call.
" - } - }, - "enableECSManagedTags": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether to use Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "enableExecuteCommand": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to use the execute command functionality for the containers in this\n\t\t\ttask. If true, this enables execute command functionality on all containers\n\t\t\tin the task.
If true, then the task definition must have a task role, or you must\n\t\t\tprovide one as an override.
The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
The infrastructure to run your standalone task on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
\nThe FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.
Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS Developer Guide.
\nThe EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.
The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.
When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.
The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it isn't supported for other network modes. For more information,\n\t\t\tsee Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\tformatting characters of the override structure.
" - } - }, - "placementConstraints": { - "target": "com.amazonaws.ecs#PlacementConstraints", - "traits": { - "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify up to 10\n\t\t\tconstraints for each task (including constraints in the task definition and those\n\t\t\tspecified at runtime).
" - } - }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", - "traits": { - "smithy.api#documentation": "The placement strategy objects to use for the task. You can specify a maximum of 5\n\t\t\tstrategy rules for each task.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The platform version the task uses. A platform version is only specified for tasks\n\t\t\thosted on Fargate. If one isn't specified, the LATEST\n\t\t\tplatform version is used. For more information, see Fargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.
Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use theTagResource API action.
\nAn error will be received if you specify the SERVICE option when\n\t\t\t\trunning a task.
This parameter is only used by Amazon ECS. It is not intended for use by customers.
" - } - }, - "startedBy": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call with\n\t\t\tthe startedBy value. Up to 128 letters (uppercase and lowercase), numbers,\n\t\t\thyphens (-), forward slash (/), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.
The full ARN value must match the value that you specified as the\n\t\t\t\tResource of the principal's permissions policy.
When you specify a task definition, you must either specify a specific revision, or\n\t\t\tall revisions in the ARN.
\nTo specify a specific revision, include the revision number in the ARN. For example,\n\t\t\tto specify revision 2, use\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.
To specify all revisions, use the wildcard (*) in the ARN. For example, to specify\n\t\t\tall revisions, use\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "An identifier that you provide to ensure the idempotency of the request. It must be\n\t\t\tunique and is case sensitive. Up to 64 characters are allowed. The valid characters are\n\t\t\tcharacters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "volumeConfigurations": { - "target": "com.amazonaws.ecs#TaskVolumeConfigurations", - "traits": { - "smithy.api#documentation": "The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name of the volume must\n\t\t\tmatch the name from the task definition.
A full description of the tasks that were run. The tasks that were successfully placed\n\t\t\ton your cluster are described here.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
\nFor information about how to address failures, see Service event messages and API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#RuntimePlatform": { - "type": "structure", - "members": { - "cpuArchitecture": { - "target": "com.amazonaws.ecs#CPUArchitecture", - "traits": { - "smithy.api#documentation": "The CPU architecture.
\nYou can run your Linux tasks on an ARM-based platform by setting the value to\n\t\t\t\tARM64. This option is available for tasks that run on Linux Amazon EC2\n\t\t\tinstance or Linux containers on Fargate.
The operating system.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the platform for the Amazon ECS service or task.
\nFor more information about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.
The value, specified as a percent total of a service's desiredCount, to\n\t\t\tscale the task set. Accepted values are numbers between 0 and 100.
The unit of measure for the scale value.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" - } - }, - "com.amazonaws.ecs#ScaleUnit": { - "type": "enum", - "members": { - "PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT" - } - } - } - }, - "com.amazonaws.ecs#SchedulingStrategy": { - "type": "enum", - "members": { - "REPLICA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLICA" - } - }, - "DAEMON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAEMON" - } - } - } - }, - "com.amazonaws.ecs#Scope": { - "type": "enum", - "members": { - "TASK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "task" - } - }, - "SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "shared" - } - } - } - }, - "com.amazonaws.ecs#Secret": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the secret.
", - "smithy.api#required": {} - } - }, - "valueFrom": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The secret to expose to the container. The supported values are either the full ARN\n\t\t\tof the Secrets Manager secret or the full ARN of the parameter in the SSM\n\t\t\tParameter Store.
\nFor information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or\n\t\t\t\tRequired IAM permissions for Amazon ECS secrets (for Systems Manager Parameter\n\t\t\tstore) in the Amazon Elastic Container Service Developer Guide.
\nIf the SSM Parameter Store parameter exists in the same Region as the task\n\t\t\t\tyou're launching, then you can use either the full ARN or name of the parameter.\n\t\t\t\tIf the parameter exists in a different Region, then the full ARN must be\n\t\t\t\tspecified.
\nAn object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:
\nTo inject sensitive data into your containers as environment variables, use\n\t\t\t\t\tthe secrets container definition parameter.
To reference sensitive information in the log configuration of a container,\n\t\t\t\t\tuse the secretOptions container definition parameter.
For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#SecretList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Secret" - } - }, - "com.amazonaws.ecs#SensitiveString": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ecs#ServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "These errors are usually caused by a server issue.
", - "smithy.api#error": "server" - } - }, - "com.amazonaws.ecs#Service": { - "type": "structure", - "members": { - "serviceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN that identifies the service. For more information about the ARN format,\n\t\t\tsee Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" - } - }, - "serviceName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster. However, you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
" - } - }, - "clusterArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that hosts the service.
" - } - }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", - "traits": { - "smithy.api#documentation": "A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.
" - } - }, - "serviceRegistries": { - "target": "com.amazonaws.ecs#ServiceRegistries", - "traits": { - "smithy.api#documentation": "The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the service. The valid values are ACTIVE,\n\t\t\t\tDRAINING, or INACTIVE.
The desired number of instantiations of the task definition to keep running on the\n\t\t\tservice. This value is specified when the service is created with CreateService , and it can be modified with UpdateService.
" - } - }, - "runningCount": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The launch type the service is using. When using the DescribeServices API, this field\n\t\t\tis omitted if the service was created using a capacity provider strategy.
" - } - }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", - "traits": { - "smithy.api#documentation": "The capacity provider strategy the service uses. When using the DescribeServices API,\n\t\t\tthis field is omitted if the service was created using a launch type.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The platform version to run your service on. A platform version is only specified for\n\t\t\ttasks that are hosted on Fargate. If one isn't specified, the LATEST\n\t\t\tplatform version is used. For more information, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
\n All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX).
The task definition to use for tasks in the service. This value is specified when the\n\t\t\tservice is created with CreateService,\n\t\t\tand it can be modified with UpdateService.
" - } - }, - "deploymentConfiguration": { - "target": "com.amazonaws.ecs#DeploymentConfiguration", - "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" - } - }, - "taskSets": { - "target": "com.amazonaws.ecs#TaskSets", - "traits": { - "smithy.api#documentation": "Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
The current state of deployments for the service.
" - } - }, - "roleArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM role that's associated with the service. It allows the Amazon ECS\n\t\t\tcontainer agent to register container instances with an Elastic Load Balancing load balancer.
" - } - }, - "events": { - "target": "com.amazonaws.ecs#ServiceEvents", - "traits": { - "smithy.api#documentation": "The event stream for your service. A maximum of 100 of the latest events are\n\t\t\tdisplayed.
" - } - }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the service was created.
" - } - }, - "placementConstraints": { - "target": "com.amazonaws.ecs#PlacementConstraints", - "traits": { - "smithy.api#documentation": "The placement constraints for the tasks in the service.
" - } - }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", - "traits": { - "smithy.api#documentation": "The placement strategy that determines how tasks for the service are placed.
" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started.
" - } - }, - "schedulingStrategy": { - "target": "com.amazonaws.ecs#SchedulingStrategy", - "traits": { - "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available.
\n\n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement\n\t\t\t\t\tdecisions.
\n DAEMON-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance. This task meets all of the task\n\t\t\t\t\tplacement constraints that you specify in your cluster. The service scheduler\n\t\t\t\t\talso evaluates the task placement constraints for running tasks. It stop tasks\n\t\t\t\t\tthat don't meet the placement constraints.
Fargate tasks don't support the DAEMON\n\t\t\t\t\t\tscheduling strategy.
The deployment controller type the service is using.
" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define bot the key and\n\t\t\tvalue.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The principal that created the service.
" - } - }, - "enableECSManagedTags": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to use Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "propagateTags": { - "target": "com.amazonaws.ecs#PropagateTags", - "traits": { - "smithy.api#documentation": "Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.
" - } - }, - "enableExecuteCommand": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, the execute command functionality is turned on for all containers\n\t\t\tin tasks as part of the service.
Indicates whether to use Availability Zone rebalancing for the service.
\nFor more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details on a service within a cluster.
" - } - }, - "com.amazonaws.ecs#ServiceConnectClientAlias": { - "type": "structure", - "members": { - "port": { - "target": "com.amazonaws.ecs#PortNumber", - "traits": { - "smithy.api#documentation": "The listening port number for the Service Connect proxy. This port is available\n\t\t\tinside of all of the tasks within the same namespace.
\nTo avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tport that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
", - "smithy.api#required": {} - } - }, - "dnsName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The dnsName is the name that you use in the applications of client tasks\n\t\t\tto connect to this service. The name must be a valid DNS name but doesn't need to be\n\t\t\tfully-qualified. The name can include up to 127 characters. The name can include\n\t\t\tlowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name\n\t\t\tcan't start with a hyphen.
If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tname that the client application uses by default. For example, a few common names are\n\t\t\t\tdatabase, db, or the lowercase name of a database, such as\n\t\t\t\tmysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks\n\t\t\t(\"clients\") can use to connect to this service.
\nEach name and port mapping must be unique within the namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#ServiceConnectClientAliasList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceConnectClientAlias" - } - }, - "com.amazonaws.ecs#ServiceConnectConfiguration": { - "type": "structure", - "members": { - "enabled": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether to use Service Connect with this service.
", - "smithy.api#required": {} - } - }, - "namespace": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in\n\t\t\tthe same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't\n\t\t\taffect Service Connect. For more information about Cloud Map, see Working\n\t\t\t\twith Services in the Cloud Map Developer Guide.
" - } - }, - "services": { - "target": "com.amazonaws.ecs#ServiceConnectServiceList", - "traits": { - "smithy.api#documentation": "The list of Service Connect service objects. These are names and aliases (also known\n\t\t\tas endpoints) that are used by other Amazon ECS services to connect to this service.\n\t\t\t
\nThis field is not required for a \"client\" Amazon ECS service that's a member of a namespace\n\t\t\tonly to connect to other services within the namespace. An example of this would be a\n\t\t\tfrontend application that accepts incoming requests from either a load balancer that's\n\t\t\tattached to the service or by other means.
\nAn object selects a port from the task definition, assigns a name for the Cloud Map\n\t\t\tservice, and a list of aliases (endpoints) and ports for client applications to refer to\n\t\t\tthis service.
" - } - }, - "logConfiguration": { - "target": "com.amazonaws.ecs#LogConfiguration" - } - }, - "traits": { - "smithy.api#documentation": "The Service Connect configuration of your Amazon ECS service. The configuration for this\n\t\t\tservice to discover and connect to services, and be discovered by, and connected from,\n\t\t\tother services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#ServiceConnectService": { - "type": "structure", - "members": { - "portName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The portName must match the name of one of the portMappings\n\t\t\tfrom all the containers in the task definition of this Amazon ECS service.
The discoveryName is the name of the new Cloud Map service that Amazon ECS creates\n\t\t\tfor this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,\n\t\t\tnumbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
The list of client aliases for this Service Connect service. You use these to assign\n\t\t\tnames that can be used by client applications. The maximum number of client aliases that\n\t\t\tyou can have in this list is 1.
\nEach alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS\n\t\t\ttasks (\"clients\") can use to connect to this service.
\nEach name and port mapping must be unique within the namespace.
\nFor each ServiceConnectService, you must provide at least one\n\t\t\t\tclientAlias with one port.
The port number for the Service Connect proxy to listen on.
\nUse the value of this field to bypass the proxy for traffic on the port number\n\t\t\tspecified in the named portMapping in the task definition of this\n\t\t\tapplication, and then use it in your VPC security groups to allow traffic into the proxy\n\t\t\tfor this Amazon ECS service.
In awsvpc mode and Fargate, the default value is the container port\n\t\t\tnumber. The container port number is in the portMapping in the task\n\t\t\tdefinition. In bridge mode, the default value is the ephemeral port of the\n\t\t\tService Connect proxy.
A reference to an object that represents the configured timeouts for\n\t\t\tService Connect.
" - } - }, - "tls": { - "target": "com.amazonaws.ecs#ServiceConnectTlsConfiguration", - "traits": { - "smithy.api#documentation": "A reference to an object that represents a Transport Layer Security (TLS)\n\t\t\tconfiguration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "com.amazonaws.ecs#ServiceConnectServiceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceConnectService" - } - }, - "com.amazonaws.ecs#ServiceConnectServiceResource": { - "type": "structure", - "members": { - "discoveryName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The discovery name of this Service Connect resource.
\nThe discoveryName is the name of the new Cloud Map service that Amazon ECS creates\n\t\t\tfor this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,\n\t\t\tnumbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this\n\t\t\tService Connect resource. You can use this ARN in other integrations with Cloud Map.\n\t\t\tHowever, Service Connect can't ensure connectivity outside of Amazon ECS.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Service Connect resource. Each configuration maps a discovery name to a\n\t\t\tCloud Map service name. The data is stored in Cloud Map as part of the\n\t\t\tService Connect configuration for each discovery name of this Amazon ECS service.
\nA task can resolve the dnsName for each of the clientAliases\n\t\t\tof a service. However a task can't resolve the discovery names. If you want to connect\n\t\t\tto a service, refer to the ServiceConnectConfiguration of that service for\n\t\t\tthe list of clientAliases that you can use.
The ARN of the Amazon Web Services Private Certificate Authority certificate.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The certificate root authority that secures your service.
" - } - }, - "com.amazonaws.ecs#ServiceConnectTlsConfiguration": { - "type": "structure", - "members": { - "issuerCertificateAuthority": { - "target": "com.amazonaws.ecs#ServiceConnectTlsCertificateAuthority", - "traits": { - "smithy.api#documentation": "The signer certificate authority.
", - "smithy.api#required": {} - } - }, - "kmsKey": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service key.
" - } - }, - "roleArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The key that encrypts and decrypts your resources for Service Connect TLS.
" - } - }, - "com.amazonaws.ecs#ServiceDeployment": { - "type": "structure", - "members": { - "serviceDeploymentArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the service deployment.
" - } - }, - "serviceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the service for this service deployment.
" - } - }, - "clusterArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the cluster that hosts the service.
" - } - }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The time the service deployment was created. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" - } - }, - "startedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The time the service deployment statred. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" - } - }, - "finishedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The time the service deployment finished. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" - } - }, - "stoppedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The time the service deployment stopped. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
\nThe service deployment stops when any of the following actions happen:
\nA user manually stops the deployment
\nThe rollback option is not in use for the failure detection mechanism (the\n\t\t\t\t\tcircuit breaker or alarm-based) and the service fails.
\nThe time that the service deployment was last updated. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" - } - }, - "sourceServiceRevisions": { - "target": "com.amazonaws.ecs#ServiceRevisionsSummaryList", - "traits": { - "smithy.api#documentation": "The currently deployed workload configuration.
" - } - }, - "targetServiceRevision": { - "target": "com.amazonaws.ecs#ServiceRevisionSummary", - "traits": { - "smithy.api#documentation": "The workload configuration being deployed.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#ServiceDeploymentStatus", - "traits": { - "smithy.api#documentation": "The service deployment state.
" - } - }, - "statusReason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Information about why the service deployment is in the current status. For example,\n\t\t\tthe circuit breaker detected a failure.
" - } - }, - "deploymentConfiguration": { - "target": "com.amazonaws.ecs#DeploymentConfiguration" - }, - "rollback": { - "target": "com.amazonaws.ecs#Rollback", - "traits": { - "smithy.api#documentation": "The rollback options the service deployment uses when the deployment fails.
" - } - }, - "deploymentCircuitBreaker": { - "target": "com.amazonaws.ecs#ServiceDeploymentCircuitBreaker", - "traits": { - "smithy.api#documentation": "The circuit breaker configuration that determines a service deployment failed.
" - } - }, - "alarms": { - "target": "com.amazonaws.ecs#ServiceDeploymentAlarms", - "traits": { - "smithy.api#documentation": "The CloudWatch alarms that determine when a service deployment fails.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the service deployment.
\nService deployments provide a comprehensive view of your deployments. For information\n\t\t\tabout service deployments, see View service history\n\t\t\t\tusing Amazon ECS service deployments in the\n\t\t\t\n Amazon Elastic Container Service Developer Guide\n .
" - } - }, - "com.amazonaws.ecs#ServiceDeploymentAlarms": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus", - "traits": { - "smithy.api#documentation": "The status of the alarms check. Amazon ECS is not using alarms for service deployment\n\t\t\tfailures when the status is DISABLED.
The name of the CloudWatch alarms that determine when a service deployment failed. A\n\t\t\t\",\" separates the alarms.
" - } - }, - "triggeredAlarmNames": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "One or more CloudWatch alarm names that have been triggered during the service\n\t\t\tdeployment. A \",\" separates the alarm names.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The CloudWatch alarms used to determine a service deployment failed.
\nAmazon ECS considers the service deployment as failed when any of the alarms move to\n\t\t\tthe ALARM state. For more information, see How CloudWatch\n\t\t\t\talarms detect Amazon ECS deployment failures in the Amazon ECS Developer\n\t\t\tGuide.
The ARN of the service deployment.
" - } - }, - "serviceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the service for this service deployment.
" - } - }, - "clusterArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the cluster that hosts the service.
" - } - }, - "startedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the service deployment statred. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" - } - }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the service deployment was created. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" - } - }, - "finishedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the service deployment completed. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" - } - }, - "targetServiceRevisionArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the service revision being deplyed.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#ServiceDeploymentStatus", - "traits": { - "smithy.api#documentation": "The status of the service deployment
" - } - }, - "statusReason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Information about why the service deployment is in the current status. For example,\n\t\t\tthe circuit breaker detected a deployment failure.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The service deployment properties that are retured when you call\n\t\t\t\tListServiceDeployments.
This provides a high-level overview of the service deployment.
" - } - }, - "com.amazonaws.ecs#ServiceDeploymentCircuitBreaker": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus", - "traits": { - "smithy.api#documentation": "The circuit breaker status. Amazon ECS is not using the circuit breaker for service\n\t\t\tdeployment failures when the status is DISABLED.
The number of times the circuit breaker detected a service deploymeny failure.
" - } - }, - "threshold": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The threshhold which determines that the service deployment failed.
\nThe deployment circuit breaker calculates the threshold value, and then uses the value\n\t\t\tto determine when to move the deployment to a FAILED state. The deployment circuit\n\t\t\tbreaker has a minimum threshold of 3 and a maximum threshold of 200. and uses the values\n\t\t\tin the following formula to determine the deployment failure.
\n\n 0.5 * desired task count\n
Information about the circuit breaker used to determine when a service deployment has\n\t\t\tfailed.
\nThe deployment circuit breaker is the rolling update mechanism that determines if the\n\t\t\ttasks reach a steady state. The deployment circuit breaker has an option that will\n\t\t\tautomatically roll back a failed deployment to the last cpompleted service revision. For\n\t\t\tmore information, see How the Amazon\n\t\t\t\tECS deployment circuit breaker detects failures in the Amazon ECS\n\t\t\t\tDeveloper Guide.
" - } - }, - "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus": { - "type": "enum", - "members": { - "TRIGGERED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRIGGERED" - } - }, - "MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONITORING" - } - }, - "MONITORING_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONITORING_COMPLETE" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.ecs#ServiceDeploymentStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESSFUL" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - }, - "STOP_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOP_REQUESTED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "ROLLBACK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" - } - }, - "ROLLBACK_SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_SUCCESSFUL" - } - }, - "ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_FAILED" - } - } - } - }, - "com.amazonaws.ecs#ServiceDeploymentStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceDeploymentStatus" - } - }, - "com.amazonaws.ecs#ServiceDeployments": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceDeployment" - } - }, - "com.amazonaws.ecs#ServiceDeploymentsBrief": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceDeploymentBrief" - } - }, - "com.amazonaws.ecs#ServiceEvent": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID string for the event.
" - } - }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the event was triggered.
" - } - }, - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The event message.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details for an event that's associated with a service.
" - } - }, - "com.amazonaws.ecs#ServiceEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceEvent" - } - }, - "com.amazonaws.ecs#ServiceField": { - "type": "enum", - "members": { - "TAGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TAGS" - } - } - } - }, - "com.amazonaws.ecs#ServiceFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceField" - } - }, - "com.amazonaws.ecs#ServiceManagedEBSVolumeConfiguration": { - "type": "structure", - "members": { - "encrypted": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Indicates whether the volume should be encrypted. If no value is specified, encryption\n\t\t\tis turned on by default. This parameter maps 1:1 with the Encrypted\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When\n\t\t\tencryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key\n\t\t\tfor Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe volume type. This parameter maps 1:1 with the VolumeType parameter of\n\t\t\tthe CreateVolume API in the Amazon EC2 API Reference. For more\n\t\t\tinformation, see Amazon EBS volume types in\n\t\t\tthe Amazon EC2 User Guide.
The following are the supported volume types.
\nGeneral Purpose SSD: gp2|gp3\n
Provisioned IOPS SSD: io1|io2\n
Throughput Optimized HDD: st1\n
Cold HDD: sc1\n
Magnetic: standard\n
The magnetic volume type is not supported on Fargate.
\nThe size of the volume in GiB. You must specify either a volume size or a snapshot ID.\n\t\t\tIf you specify a snapshot ID, the snapshot size is used for the volume size by default.\n\t\t\tYou can optionally specify a volume size greater than or equal to the snapshot size.\n\t\t\tThis parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot\n\t\t\tID or a volume size. This parameter maps 1:1 with the SnapshotId parameter\n\t\t\tof the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3,\n\t\t\tio1, and io2 volumes, this represents the number of IOPS that\n\t\t\tare provisioned for the volume. For gp2 volumes, this represents the\n\t\t\tbaseline performance of the volume and the rate at which the volume accumulates I/O\n\t\t\tcredits for bursting.
The following are the supported values for each volume type.
\n\n gp3: 3,000 - 16,000 IOPS
\n io1: 100 - 64,000 IOPS
\n io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The\n\t\t\tdefault for gp3 volumes is 3,000 IOPS. This parameter is not\n\t\t\tsupported for st1, sc1, or standard volume\n\t\t\ttypes.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.\n\t\t\tThis parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This\n\t\t\tparameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS\n\t\t\tinfrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend\n\t\t\tusing the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM\n\t\t\tpolicy with this role. For more information, see Amazon ECS\n\t\t\t\tinfrastructure IAM role in the Amazon ECS Developer\n\t\t\tGuide.
The filesystem type for the volume. For volumes created from a snapshot, you must\n\t\t\tspecify the same filesystem type that the volume was using when the snapshot was\n\t\t\tcreated. If there is a filesystem type mismatch, the task will fail to start.
\nThe available Linux filesystem types are\u2028 ext3, ext4, and\n\t\t\t\txfs. If no value is specified, the xfs filesystem type is\n\t\t\tused by default.
The available Windows filesystem types are NTFS.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask in the service. For information about the supported launch types and operating\n\t\t\tsystems, see Supported operating systems and launch types in the Amazon Elastic Container Service\n\t\t\t\tDeveloper Guide.
\nMany of these parameters map 1:1 with the Amazon EBS CreateVolume API request\n\t\t\tparameters.
Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified service isn't active. You can't update a service that's inactive. If you\n\t\t\thave previously deleted a service, you can re-create it with CreateService.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#ServiceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region\n\t\t\tspecific.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#ServiceRegistries": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceRegistry" - } - }, - "com.amazonaws.ecs#ServiceRegistry": { - "type": "structure", - "members": { - "registryArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is\n\t\t\tCloud Map. For more information, see CreateService.
" - } - }, - "port": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The port value used if your service discovery service specified an SRV record. This\n\t\t\tfield might be used if both the awsvpc network mode and SRV records are\n\t\t\tused.
The container name value to be used for your service discovery service. It's already\n\t\t\tspecified in the task definition. If the task definition that your service task\n\t\t\tspecifies uses the bridge or host network mode, you must\n\t\t\tspecify a containerName and containerPort combination from the\n\t\t\ttask definition. If the task definition that your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.
The port value to be used for your service discovery service. It's already specified\n\t\t\tin the task definition. If the task definition your service task specifies uses the\n\t\t\t\tbridge or host network mode, you must specify a\n\t\t\t\tcontainerName and containerPort combination from the task\n\t\t\tdefinition. If the task definition your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.
The details for the service registry.
\nEach service may be associated with one service registry. Multiple service registries\n\t\t\tfor each service are not supported.
\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts a\n\t\t\tnew deployment. New tasks are registered and deregistered to the updated service\n\t\t\tregistry configuration.
" - } - }, - "com.amazonaws.ecs#ServiceRevision": { - "type": "structure", - "members": { - "serviceRevisionArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the service revision.
" - } - }, - "serviceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the service for the service revision.
" - } - }, - "clusterArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the cluster that hosts the service.
" - } - }, - "taskDefinition": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The task definition the service revision uses.
" - } - }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", - "traits": { - "smithy.api#documentation": "The capacity provider strategy the service revision uses.
" - } - }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", - "traits": { - "smithy.api#documentation": "The launch type the service revision uses.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "For the Fargate launch type, the platform version the service revision uses.
" - } - }, - "platformFamily": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The platform family the service revision uses.
" - } - }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", - "traits": { - "smithy.api#documentation": "The load balancers the service revision uses.
" - } - }, - "serviceRegistries": { - "target": "com.amazonaws.ecs#ServiceRegistries", - "traits": { - "smithy.api#documentation": "The service registries (for Service Discovery) the service revision uses.
" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration" - }, - "containerImages": { - "target": "com.amazonaws.ecs#ContainerImages", - "traits": { - "smithy.api#documentation": "The container images the service revision uses.
" - } - }, - "guardDutyEnabled": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether Runtime Monitoring is turned on.
" - } - }, - "serviceConnectConfiguration": { - "target": "com.amazonaws.ecs#ServiceConnectConfiguration" - }, - "volumeConfigurations": { - "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", - "traits": { - "smithy.api#documentation": "The volumes that are configured at deployment that the service revision uses.
" - } - }, - "fargateEphemeralStorage": { - "target": "com.amazonaws.ecs#DeploymentEphemeralStorage" - }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the service revision was created. The format is yyyy-mm-dd\n\t\t\tHH:mm:ss.SSSSS.
" - } - }, - "vpcLatticeConfigurations": { - "target": "com.amazonaws.ecs#VpcLatticeConfigurations", - "traits": { - "smithy.api#documentation": "The VPC Lattice configuration for the service revision.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the service revision.
\nA service revision contains a record of the workload configuration Amazon ECS is attempting\n\t\t\tto deploy. Whenever you create or deploy a service, Amazon ECS automatically creates and\n\t\t\tcaptures the configuration that you're trying to deploy in the service revision. For\n\t\t\tinformation about service revisions, see Amazon ECS service\n\t\t\t\trevisions in the \n Amazon Elastic Container Service Developer Guide\n .
" - } - }, - "com.amazonaws.ecs#ServiceRevisionSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the service revision.
" - } - }, - "requestedTaskCount": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of requested tasks for the service revision.
" - } - }, - "runningTaskCount": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of running tasks for the service revision.
" - } - }, - "pendingTaskCount": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of pending tasks for the service revision.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The information about the number of requested, pending, and running tasks for a\n\t\t\tservice revision.
" - } - }, - "com.amazonaws.ecs#ServiceRevisions": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceRevision" - } - }, - "com.amazonaws.ecs#ServiceRevisionsSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceRevisionSummary" - } - }, - "com.amazonaws.ecs#ServiceVolumeConfiguration": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#ECSVolumeName", - "traits": { - "smithy.api#documentation": "The name of the volume. This value must match the volume name from the\n\t\t\t\tVolume object in the task definition.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console\n\t\t\tonce they are created.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for a volume specified in the task definition as a volume that is\n\t\t\tconfigured at launch time. Currently, the only supported volume type is an Amazon EBS\n\t\t\tvolume.
" - } - }, - "com.amazonaws.ecs#ServiceVolumeConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ServiceVolumeConfiguration" - } - }, - "com.amazonaws.ecs#Services": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Service" - } - }, - "com.amazonaws.ecs#Session": { - "type": "structure", - "members": { - "sessionId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID of the execute command session.
" - } - }, - "streamUrl": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "A URL to the managed agent on the container that the SSM Session Manager client uses\n\t\t\tto send commands and receive output from the container.
" - } - }, - "tokenValue": { - "target": "com.amazonaws.ecs#SensitiveString", - "traits": { - "smithy.api#documentation": "An encrypted token value containing session and caller information. It's used to\n\t\t\tauthenticate the connection to the container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details for the execute command session.
" - } - }, - "com.amazonaws.ecs#Setting": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#SettingName", - "traits": { - "smithy.api#documentation": "The Amazon ECS resource name.
" - } - }, - "value": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Determines whether the account setting is on or off for the specified resource.
" - } - }, - "principalArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the principal. It can be a user, role, or the root user. If this field is\n\t\t\tomitted, the authenticated user is assumed.
" - } - }, - "type": { - "target": "com.amazonaws.ecs#SettingType", - "traits": { - "smithy.api#documentation": "Indicates whether Amazon Web Services manages the account setting, or if the user manages it.
\n\n aws_managed account settings are read-only, as Amazon Web Services manages such on the\n\t\t\tcustomer's behalf. Currently, the guardDutyActivate account setting is the\n\t\t\tonly one Amazon Web Services manages.
The current account setting for a resource.
" - } - }, - "com.amazonaws.ecs#SettingName": { - "type": "enum", - "members": { - "SERVICE_LONG_ARN_FORMAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "serviceLongArnFormat" - } - }, - "TASK_LONG_ARN_FORMAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "taskLongArnFormat" - } - }, - "CONTAINER_INSTANCE_LONG_ARN_FORMAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "containerInstanceLongArnFormat" - } - }, - "AWSVPC_TRUNKING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "awsvpcTrunking" - } - }, - "CONTAINER_INSIGHTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "containerInsights" - } - }, - "FARGATE_FIPS_MODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fargateFIPSMode" - } - }, - "TAG_RESOURCE_AUTHORIZATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tagResourceAuthorization" - } - }, - "FARGATE_TASK_RETIREMENT_WAIT_PERIOD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fargateTaskRetirementWaitPeriod" - } - }, - "GUARD_DUTY_ACTIVATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "guardDutyActivate" - } - } - } - }, - "com.amazonaws.ecs#SettingType": { - "type": "enum", - "members": { - "USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "user" - } - }, - "AWS_MANAGED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aws_managed" - } - } - } - }, - "com.amazonaws.ecs#Settings": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Setting" - } - }, - "com.amazonaws.ecs#SortOrder": { - "type": "enum", - "members": { - "ASC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASC" - } - }, - "DESC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESC" - } - } - } - }, - "com.amazonaws.ecs#StabilityStatus": { - "type": "enum", - "members": { - "STEADY_STATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STEADY_STATE" - } - }, - "STABILIZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STABILIZING" - } - } - } - }, - "com.amazonaws.ecs#StartTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#StartTaskRequest" - }, - "output": { - "target": "com.amazonaws.ecs#StartTaskResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.
\nOn March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nAlternatively, you can useRunTask to place tasks for you. For more\n\t\t\tinformation, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
", - "smithy.api#examples": [ - { - "title": "To start a new task", - "documentation": "This example starts a new task in the cluster \"MyCluster\" on the specified container instance using the latest revision of the \"hello-world\" task definition.", + "target": "com.amazonaws.ecs#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes specified tags from a resource.
", + "smithy.api#examples": [ + { + "title": "To untag a cluster.", + "documentation": "This example deletes the 'team' tag from the 'dev' cluster.", + "input": { + "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev", + "tagKeys": [ + "team" + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.ecs#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources\n\t\t\tare Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.ecs#TagKeys", + "traits": { + "smithy.api#documentation": "The keys of the tags to be removed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#UpdateCapacityProvider": { + "type": "operation", "input": { - "cluster": "MyCluster", - "containerInstances": ["4c543eed-f83f-47da-b1d8-3d23f1da4c64"], - "taskDefinition": "hello-world" + "target": "com.amazonaws.ecs#UpdateCapacityProviderRequest" }, "output": { - "tasks": [ + "target": "com.amazonaws.ecs#UpdateCapacityProviderResponse" + }, + "errors": [ { - "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", - "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/default/4c543eed-f83f-47da-b1d8-3d23f1da4c64", - "containers": [ - { - "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/e76594d4-27e1-4c74-98b5-46a6435eb769", - "lastStatus": "PENDING", - "name": "wordpress", - "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb" - }, + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the parameters for a capacity provider.
", + "smithy.api#examples": [ { - "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/default/b19106ea-4fa8-4f1d-9767-96922c82b070", - "lastStatus": "PENDING", - "name": "mysql", - "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb" - } - ], - "createdAt": 1.479765460842e9, - "desiredStatus": "RUNNING", - "lastStatus": "PENDING", - "overrides": { - "containerOverrides": [ - { - "name": "wordpress" - }, - { - "name": "mysql" - } - ] - }, - "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb", - "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", - "version": 1 + "title": "To update a capacity provider's parameters", + "documentation": "This example updates the targetCapacity and instanceWarmupPeriod parameters for the capacity provider MyCapacityProvider to 90 and 150 respectively.", + "input": { + "name": "MyCapacityProvider", + "autoScalingGroupProvider": { + "managedScaling": { + "status": "ENABLED", + "targetCapacity": 90, + "instanceWarmupPeriod": 150 + } + } + }, + "output": { + "capacityProvider": { + "capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider", + "name": "MyCapacityProvider", + "status": "ACTIVE", + "autoScalingGroupProvider": { + "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG", + "managedScaling": { + "status": "ENABLED", + "targetCapacity": 90, + "minimumScalingStepSize": 1, + "maximumScalingStepSize": 10000, + "instanceWarmupPeriod": 150 + }, + "managedTerminationProtection": "ENABLED" + }, + "updateStatus": "UPDATE_COMPLETE", + "tags": [] + } + } + } + ] + } + }, + "com.amazonaws.ecs#UpdateCapacityProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the capacity provider to update.
", + "smithy.api#required": {} + } + }, + "autoScalingGroupProvider": { + "target": "com.amazonaws.ecs#AutoScalingGroupProviderUpdate", + "traits": { + "smithy.api#documentation": "An object that represent the parameters to update for the Auto Scaling group capacity\n\t\t\tprovider.
", + "smithy.api#required": {} + } } - ], - "failures": [] + }, + "traits": { + "smithy.api#input": {} } - } - ] - } - }, - "com.amazonaws.ecs#StartTaskRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster where to start your task.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" - } - }, - "containerInstances": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The container instance IDs or full ARN entries for the container instances where you\n\t\t\twould like to place your task. You can specify up to 10 container instances.
", - "smithy.api#required": {} - } - }, - "enableECSManagedTags": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether to use Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "enableExecuteCommand": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Whether or not the execute command functionality is turned on for the task. If\n\t\t\t\ttrue, this turns on the execute command functionality on all containers\n\t\t\tin the task.
The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.
A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it receives. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.
\nSpecifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags aren't propagated.
" - } - }, - "referenceId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "This parameter is only used by Amazon ECS. It is not intended for use by customers.
" - } - }, - "startedBy": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call with\n\t\t\tthe startedBy value. Up to 36 letters (uppercase and lowercase), numbers,\n\t\t\thyphens (-), forward slash (/), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to start. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.
The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must\n\t\t\tmatch the name from the task definition.
A full description of the tasks that were started. Each task that was successfully\n\t\t\tplaced on your container instances is described.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#Statistics": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#KeyValuePair" - } - }, - "com.amazonaws.ecs#StopTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#StopTaskRequest" - }, - "output": { - "target": "com.amazonaws.ecs#StopTaskResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Stops a running task. Any tags associated with the task will be deleted.
\nWhen you call StopTask on a task, the equivalent of docker\n\t\t\t\tstop is issued to the containers running in the task. This results in a\n\t\t\t\tSIGTERM value and a default 30-second timeout, after which the\n\t\t\t\tSIGKILL value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL value is sent.
For Windows containers, POSIX signals do not work and runtime stops the container by\n\t\t\tsending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown\n\t\t\t\tof (Windows) container #25982 on GitHub.
The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see\n\t\t\t\t\tAmazon ECS Container Agent Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
Details about the capacity provider.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#UpdateCluster": { + "type": "operation", "input": { - "cluster": "MyCluster", - "task": "1dc5c17a-422b-4dc4-b493-371970c6c4d6", - "reason": "testing stop task." + "target": "com.amazonaws.ecs#UpdateClusterRequest" }, "output": { - "task": { - "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/MyCluster", - "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/MyCluster/5991d8da-1d59-49d2-a31f-4230f9e73140", - "containers": [ - { - "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/4df26bb4-f057-467b-a079-961675296e64", - "lastStatus": "RUNNING", - "name": "simple-app", - "networkBindings": [ - { - "bindIP": "0.0.0.0", - "containerPort": 80, - "hostPort": 32774, - "protocol": "tcp" - } - ], - "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6" - }, - { - "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/e09064f7-7361-4c87-8ab9-8d073bbdbcb9", - "lastStatus": "RUNNING", - "name": "busybox", - "networkBindings": [], - "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6" - } - ], - "createdAt": 1.476822811295e9, - "desiredStatus": "STOPPED", - "lastStatus": "RUNNING", - "overrides": { - "containerOverrides": [ + "target": "com.amazonaws.ecs#UpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#NamespaceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the cluster.
", + "smithy.api#examples": [ { - "name": "simple-app" + "title": "To update a cluster's observability settings.", + "documentation": "This example turns on enhanced containerInsights in an existing cluster. ", + "input": { + "cluster": "ECS-project-update-cluster", + "settings": [ + { + "name": "containerInsights", + "value": "enhanced" + } + ] + }, + "output": { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster", + "clusterName": "ECS-project-update-cluster", + "status": "ACTIVE", + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "pendingTasksCount": 0, + "activeServicesCount": 0, + "statistics": [], + "tags": [], + "settings": [ + { + "name": "containerInsights", + "value": "enhanced" + } + ], + "capacityProviders": [ + "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" + ], + "defaultCapacityProviderStrategy": [ + { + "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", + "weight": 1, + "base": 0 + } + ], + "attachments": [ + { + "id": "069d002b-7634-42e4-b1d4-544f4c8f6380", + "type": "as_policy", + "status": "CREATED", + "details": [ + { + "name": "capacityProviderName", + "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" + }, + { + "name": "scalingPolicyName", + "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93" + } + ] + }, + { + "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a", + "type": "managed_draining", + "status": "CREATED", + "details": [ + { + "name": "capacityProviderName", + "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" + }, + { + "name": "autoScalingLifecycleHookName", + "value": "ecs-managed-draining-termination-hook" + } + ] + }, + { + "id": "45d0b36f-8cff-46b6-9380-1288744802ab", + "type": "sc", + "status": "ATTACHED", + "details": [] + } + ], + "attachmentsStatus": "UPDATE_COMPLETE", + "serviceConnectDefaults": { + "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-igwrsylmy3kwvcdx" + } + } + } }, { - "name": "busybox" + "title": "To update a cluster's Service Connect defaults.", + "documentation": "This example sets a default Service Connect namespace. ", + "input": { + "cluster": "ECS-project-update-cluster", + "serviceConnectDefaults": { + "namespace": "test" + } + }, + "output": { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster", + "clusterName": "ECS-project-update-cluster", + "status": "ACTIVE", + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "pendingTasksCount": 0, + "activeServicesCount": 0, + "statistics": [], + "tags": [], + "settings": [ + { + "name": "containerInsights", + "value": "enhanced" + } + ], + "capacityProviders": [ + "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" + ], + "defaultCapacityProviderStrategy": [ + { + "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", + "weight": 1, + "base": 0 + } + ], + "attachments": [ + { + "id": "069d002b-7634-42e4-b1d4-544f4c8f6380", + "type": "as_policy", + "status": "CREATED", + "details": [ + { + "name": "capacityProviderName", + "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" + }, + { + "name": "scalingPolicyName", + "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93" + } + ] + }, + { + "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a", + "type": "managed_draining", + "status": "CREATED", + "details": [ + { + "name": "capacityProviderName", + "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" + }, + { + "name": "autoScalingLifecycleHookName", + "value": "ecs-managed-draining-termination-hook" + } + ] + }, + { + "id": "45d0b36f-8cff-46b6-9380-1288744802ab", + "type": "sc", + "status": "DELETED", + "details": [] + }, + { + "id": "3e6890c3-609c-4832-91de-d6ca891b3ef1", + "type": "sc", + "status": "ATTACHED", + "details": [] + }, + { + "id": "961b8ec1-c2f1-4070-8495-e669b7668e90", + "type": "sc", + "status": "DELETED", + "details": [] + } + ], + "attachmentsStatus": "UPDATE_COMPLETE", + "serviceConnectDefaults": { + "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-dtjmxqpfi46ht7dr" + } + } + } + } + ] + } + }, + "com.amazonaws.ecs#UpdateClusterRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the cluster to modify the settings for.
", + "smithy.api#required": {} + } + }, + "settings": { + "target": "com.amazonaws.ecs#ClusterSettings", + "traits": { + "smithy.api#documentation": "The cluster settings for your cluster.
" } - ] }, - "startedAt": 1.476822833998e9, - "startedBy": "ecs-svc/9223370560032507596", - "stoppedReason": "testing stop task.", - "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/1dc5c17a-422b-4dc4-b493-371970c6c4d6", - "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-dynamic-ports:1", - "version": 0 - } + "configuration": { + "target": "com.amazonaws.ecs#ClusterConfiguration", + "traits": { + "smithy.api#documentation": "The execute command configuration for the cluster.
" + } + }, + "serviceConnectDefaults": { + "target": "com.amazonaws.ecs#ClusterServiceConnectDefaultsRequest", + "traits": { + "smithy.api#documentation": "Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} } - } - ] - } - }, - "com.amazonaws.ecs#StopTaskRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" - } - }, - "task": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The task ID of the task to stop.
", - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "An optional message specified when a task is stopped. For example, if you're using a\n\t\t\tcustom scheduler, you can use this parameter to specify the reason for stopping the task\n\t\t\there, and the message appears in subsequent DescribeTasks>\n\t\t\tAPI operations on this task.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#StopTaskResponse": { - "type": "structure", - "members": { - "task": { - "target": "com.amazonaws.ecs#Task", - "traits": { - "smithy.api#documentation": "The task that was stopped.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#String": { - "type": "string" - }, - "com.amazonaws.ecs#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#String" - } - }, - "com.amazonaws.ecs#StringMap": { - "type": "map", - "key": { - "target": "com.amazonaws.ecs#String" - }, - "value": { - "target": "com.amazonaws.ecs#String" - } - }, - "com.amazonaws.ecs#SubmitAttachmentStateChanges": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#SubmitAttachmentStateChangesRequest" - }, - "output": { - "target": "com.amazonaws.ecs#SubmitAttachmentStateChangesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to acknowledge that an attachment changed states.
" - } - }, - "com.amazonaws.ecs#SubmitAttachmentStateChangesRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container instance the\n\t\t\tattachment belongs to.
" - } - }, - "attachments": { - "target": "com.amazonaws.ecs#AttachmentStateChanges", - "traits": { - "smithy.api#documentation": "Any attachments associated with the state change request.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#SubmitAttachmentStateChangesResponse": { - "type": "structure", - "members": { - "acknowledgment": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Acknowledgement of the state change.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#SubmitContainerStateChange": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#SubmitContainerStateChangeRequest" - }, - "output": { - "target": "com.amazonaws.ecs#SubmitContainerStateChangeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to acknowledge that a container changed states.
" - } - }, - "com.amazonaws.ecs#SubmitContainerStateChangeRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container.
" - } - }, - "task": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
" - } - }, - "containerName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the container.
" - } - }, - "runtimeId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID of the Docker container.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the state change request.
" - } - }, - "exitCode": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The exit code that's returned for the state change request.
" - } - }, - "reason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The reason for the state change request.
" - } - }, - "networkBindings": { - "target": "com.amazonaws.ecs#NetworkBindings", - "traits": { - "smithy.api#documentation": "The network bindings of the container.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#SubmitContainerStateChangeResponse": { - "type": "structure", - "members": { - "acknowledgment": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Acknowledgement of the state change.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#SubmitTaskStateChange": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#SubmitTaskStateChangeRequest" - }, - "output": { - "target": "com.amazonaws.ecs#SubmitTaskStateChangeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to acknowledge that a task changed states.
" - } - }, - "com.amazonaws.ecs#SubmitTaskStateChangeRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
" - } - }, - "task": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The task ID or full ARN of the task in the state change request.
" - } - }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the state change request.
" - } - }, - "reason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The reason for the state change request.
" - } - }, - "containers": { - "target": "com.amazonaws.ecs#ContainerStateChanges", - "traits": { - "smithy.api#documentation": "Any containers that's associated with the state change request.
" - } - }, - "attachments": { - "target": "com.amazonaws.ecs#AttachmentStateChanges", - "traits": { - "smithy.api#documentation": "Any attachments associated with the state change request.
" - } - }, - "managedAgents": { - "target": "com.amazonaws.ecs#ManagedAgentStateChanges", - "traits": { - "smithy.api#documentation": "The details for the managed agent that's associated with the task.
" - } - }, - "pullStartedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the container image pull started.
" - } - }, - "pullStoppedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the container image pull completed.
" - } - }, - "executionStoppedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task execution stopped.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#SubmitTaskStateChangeResponse": { - "type": "structure", - "members": { - "acknowledgment": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Acknowledgement of the state change.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#SystemControl": { - "type": "structure", - "members": { - "namespace": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The namespaced kernel parameter to set a value for.
The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\"\n\t\t\t\t| \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" |\n\t\t\t\t\"kernel.shm_rmid_forced\", and Sysctls that start with\n\t\t\t\t\"fs.mqueue.*\"\n
Valid network namespace values: Sysctls that start with\n\t\t\t\t\"net.*\"\n
All of these values are supported by Fargate.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the docker container create command and the\n\t\t\t\t--sysctl option to docker run. For example, you can configure\n\t\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.
We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\tawsvpc or host network mode. Doing this has the following\n\t\t\tdisadvantages:
For tasks that use the awsvpc network mode including Fargate,\n\t\t\t\t\tif you set systemControls for any container, it applies to all\n\t\t\t\t\tcontainers in the task. If you set different systemControls for\n\t\t\t\t\tmultiple containers in a single task, the container that's started last\n\t\t\t\t\tdetermines which systemControls take effect.
For tasks that use the host network mode, the network namespace\n\t\t\t\t\t\tsystemControls aren't supported.
If you're setting an IPC resource namespace to use for the containers in the task, the\n\t\t\tfollowing conditions apply to your system controls. For more information, see IPC mode.
\nFor tasks that use the host IPC mode, IPC namespace\n\t\t\t\t\t\tsystemControls aren't supported.
For tasks that use the task IPC mode, IPC namespace\n\t\t\t\t\t\tsystemControls values apply to all containers within a\n\t\t\t\t\ttask.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
One part of a key-value pair that make up a tag. A key is a general label\n\t\t\tthat acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as\n\t\t\ta descriptor within a tag category (key).
The metadata that you apply to a resource to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define them.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn. If existing tags on a resource aren't specified in the\n\t\t\trequest parameters, they aren't changed. When a resource is deleted, the tags that are\n\t\t\tassociated with that resource are deleted as well.
Details about the cluster.
" + } } - ] }, - "output": {} - } - ] - } - }, - "com.amazonaws.ecs#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are\n\t\t\tAmazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The tags to add to the resource. A tag is an array of key-value pairs.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:
\nIncorrect IAM permissions
\nThe SSM agent is not installed or is not running
\nThere is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for\n\t\t\t\t\tSystems Manager Session Manager
\nFor information about how to troubleshoot the issues, see Troubleshooting issues with ECS\n\t\t\t\tExec in the Amazon Elastic Container Service Developer Guide.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#TargetNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified target wasn't found. You can view your available container instances\n\t\t\twith ListContainerInstances. Amazon ECS container instances are cluster-specific and\n\t\t\tRegion-specific.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#TargetType": { - "type": "enum", - "members": { - "CONTAINER_INSTANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "container-instance" - } - } - } - }, - "com.amazonaws.ecs#Task": { - "type": "structure", - "members": { - "attachments": { - "target": "com.amazonaws.ecs#Attachments", - "traits": { - "smithy.api#documentation": "The Elastic Network Adapter that's associated with the task if the task uses the\n\t\t\t\tawsvpc network mode.
The attributes of the task
" - } - }, - "availabilityZone": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Availability Zone for the task.
" - } - }, - "capacityProviderName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The capacity provider that's associated with the task.
" - } - }, - "clusterArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the cluster that hosts the task.
" - } - }, - "connectivity": { - "target": "com.amazonaws.ecs#Connectivity", - "traits": { - "smithy.api#documentation": "The connectivity status of a task.
" - } - }, - "connectivityAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task last went into CONNECTED\n\t\t\tstatus.
The ARN of the container instances that host the task.
" - } - }, - "containers": { - "target": "com.amazonaws.ecs#Containers", - "traits": { - "smithy.api#documentation": "The containers that's associated with the task.
" - } - }, - "cpu": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units (for example, 1024). It can also be\n\t\t\texpressed as a string using vCPUs (for example, 1 vCPU or 1\n\t\t\t\tvcpu). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.
If you use the EC2 launch type, this field is optional. Supported values\n\t\t\tare between 128 CPU units (0.125 vCPUs) and 10240\n\t\t\tCPU units (10 vCPUs).
If you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. These values determine the range of supported values for\n\t\t\tthe memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The Unix timestamp for the time when the task was created. More specifically, it's for\n\t\t\tthe time when the task entered the PENDING state.
The desired status of the task. For more information, see Task\n\t\t\tLifecycle.
" - } - }, - "enableExecuteCommand": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether execute command functionality is turned on for this task. If\n\t\t\t\ttrue, execute command functionality is turned on all the containers in\n\t\t\tthe task.
The Unix timestamp for the time when the task execution stopped.
" - } - }, - "group": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the task group that's associated with the task.
" - } - }, - "healthStatus": { - "target": "com.amazonaws.ecs#HealthStatus", - "traits": { - "smithy.api#documentation": "The health status for the task. It's determined by the health of the essential\n\t\t\tcontainers in the task. If all essential containers in the task are reporting as\n\t\t\t\tHEALTHY, the task status also reports as HEALTHY. If any\n\t\t\tessential containers in the task are reporting as UNHEALTHY or\n\t\t\t\tUNKNOWN, the task status also reports as UNHEALTHY or\n\t\t\t\tUNKNOWN.
The Amazon ECS container agent doesn't monitor or report on Docker health checks that\n\t\t\t\tare embedded in a container image and not specified in the container definition. For\n\t\t\t\texample, this includes those specified in a parent image or from the image's\n\t\t\t\tDockerfile. Health check parameters that are specified in a container definition\n\t\t\t\toverride any Docker health checks that are found in the container image.
\nThe Elastic Inference accelerator that's associated with the task.
" - } - }, - "lastStatus": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The last known status for the task. For more information, see Task\n\t\t\t\tLifecycle.
" - } - }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", - "traits": { - "smithy.api#documentation": "The infrastructure where your task runs on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "memory": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The amount of memory (in MiB) that the task uses as expressed in a task definition. It\n\t\t\tcan be expressed as an integer using MiB (for example, 1024). If it's\n\t\t\texpressed as a string using GB (for example, 1GB or 1 GB),\n\t\t\tit's converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
If you use the EC2 launch type, this field is optional.
\nIf you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. The value that you choose determines the range of supported\n\t\t\tvalues for the cpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
One or more container overrides.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The platform version where your task runs on. A platform version is only specified for\n\t\t\ttasks that use the Fargate launch type. If you didn't specify one, the\n\t\t\t\tLATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks are running on. A platform family is specified\n\t\t\tonly for tasks that use the Fargate launch type.
\n All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX.).
The Unix timestamp for the time when the container image pull began.
" - } - }, - "pullStoppedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the container image pull completed.
" - } - }, - "startedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task started. More specifically, it's for the\n\t\t\ttime when the task transitioned from the PENDING state to the\n\t\t\t\tRUNNING state.
The tag specified when a task is started. If an Amazon ECS service started the task, the\n\t\t\t\tstartedBy parameter contains the deployment ID of that service.
The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.
For more information about stop code, see Stopped tasks\n\t\t\t\terror codes in the Amazon ECS Developer Guide.
" - } - }, - "stoppedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task was stopped. More specifically, it's for\n\t\t\tthe time when the task transitioned from the RUNNING state to the\n\t\t\t\tSTOPPED state.
The reason that the task was stopped.
" - } - }, - "stoppingAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task stops. More specifically, it's for the\n\t\t\ttime when the task transitions from the RUNNING state to\n\t\t\t\tSTOPPING.
The metadata that you apply to the task to help you categorize and organize the task.\n\t\t\tEach tag consists of a key and an optional value. You define both the key and\n\t\t\tvalue.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The Amazon Resource Name (ARN) of the task.
" - } - }, - "taskDefinitionArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ARN of the task definition that creates the task.
" - } - }, - "version": { - "target": "com.amazonaws.ecs#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The version counter for the task. Every time a task experiences a change that starts a\n\t\t\tCloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state\n\t\t\twith CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n\t\t\tactions with the version reported in CloudWatch Events for the task (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.
The ephemeral storage settings for the task.
" - } - }, - "fargateEphemeralStorage": { - "target": "com.amazonaws.ecs#TaskEphemeralStorage", - "traits": { - "smithy.api#documentation": "The Fargate ephemeral storage settings for the task.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details on a task in a cluster.
" - } - }, - "com.amazonaws.ecs#TaskDefinition": { - "type": "structure", - "members": { - "taskDefinitionArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the task definition.
" - } - }, - "containerDefinitions": { - "target": "com.amazonaws.ecs#ContainerDefinitions", - "traits": { - "smithy.api#documentation": "A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task. For more information about container definition parameters and\n\t\t\tdefaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "family": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of a family that this task definition is registered to. Up to 255 characters\n\t\t\tare allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and\n\t\t\tunderscores (_) are allowed.
\nA family groups multiple versions of a task definition. Amazon ECS gives the first task\n\t\t\tdefinition that you registered to a family a revision number of 1. Amazon ECS gives\n\t\t\tsequential revision numbers to each task definition that you add.
" - } - }, - "taskRoleArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the\n\t\t\ttask permission to call Amazon Web Services APIs on your behalf. For informationabout the required\n\t\t\tIAM roles for Amazon ECS, see IAM\n\t\t\t\troles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "networkMode": { - "target": "com.amazonaws.ecs#NetworkMode", - "traits": { - "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
The revision of the task in a particular family. The revision is a version number of a\n\t\t\ttask definition in a family. When you register a task definition for the first time, the\n\t\t\trevision is 1. Each time that you register a new revision of a task\n\t\t\tdefinition in the same family, the revision value always increases by one. This is even\n\t\t\tif you deregistered previous revisions in this family.
The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
\nThe host and sourcePath parameters aren't supported for\n\t\t\t\ttasks run on Fargate.
The status of the task definition.
" - } - }, - "requiresAttributes": { - "target": "com.amazonaws.ecs#RequiresAttributes", - "traits": { - "smithy.api#documentation": "The container instance attributes required by your task. When an Amazon EC2 instance is\n\t\t\tregistered to your cluster, the Amazon ECS container agent assigns some standard attributes\n\t\t\tto the instance. You can apply custom attributes. These are specified as key-value pairs\n\t\t\tusing the Amazon ECS console or the PutAttributes\n\t\t\tAPI. These attributes are used when determining task placement for tasks hosted on Amazon EC2\n\t\t\tinstances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
\nThis parameter isn't supported for tasks run on Fargate.
\nAn array of placement constraint objects to use for tasks.
\nThis parameter isn't supported for tasks run on Fargate.
\nAmazon ECS validates the task definition parameters with those supported by the launch\n\t\t\ttype. For more information, see Amazon ECS launch types\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" - } - }, - "runtimePlatform": { - "target": "com.amazonaws.ecs#RuntimePlatform", - "traits": { - "smithy.api#documentation": "The operating system that your task definitions are running on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
\nWhen you specify a task in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.
The task launch types the task definition was validated against. The valid values are\n\t\t\t\tEC2, FARGATE, and EXTERNAL. For more\n\t\t\tinformation, see Amazon ECS launch types\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The number of cpu units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the memory parameter.
If you use the EC2 launch type, this field is optional. Supported values\n\t\t\tare between 128 CPU units (0.125 vCPUs) and 10240\n\t\t\tCPU units (10 vCPUs).
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The amount (in MiB) of memory used by the task.
\nIf your tasks runs on Amazon EC2 instances, you must specify either a task-level memory\n\t\t\tvalue or a container-level memory value. This field is optional and any value can be\n\t\t\tused. If a task-level memory value is specified, the container-level memory value is\n\t\t\toptional. For more information regarding container-level memory and memory reservation,\n\t\t\tsee ContainerDefinition.
\nIf your tasks runs on Fargate, this field is required. You must use one of the\n\t\t\tfollowing values. The value you choose determines your range of valid values for the\n\t\t\t\tcpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The Elastic Inference accelerator that's associated with the task.
" - } - }, - "pidMode": { - "target": "com.amazonaws.ecs#PidMode", - "traits": { - "smithy.api#documentation": "The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe configuration details for the App Mesh proxy.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tand at least version 1.26.0-1 of the ecs-init package to use a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS optimized AMI\n\t\t\tversion 20190301 or later, they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The Unix timestamp for the time when the task definition was registered.
" - } - }, - "deregisteredAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task definition was deregistered.
" - } - }, - "registeredBy": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The principal that registered the task definition.
" - } - }, - "ephemeralStorage": { - "target": "com.amazonaws.ecs#EphemeralStorage", - "traits": { - "smithy.api#documentation": "The ephemeral storage settings to use for tasks run with the task definition.
" - } - }, - "enableFaultInjection": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Enables fault injection and allows for fault injection requests to be accepted from the task's containers. \n\t\t\tThe default value is false.
The details of a task definition which describes the container and volume definitions\n\t\t\tof an Amazon Elastic Container Service task. You can specify which Docker images to use, the required\n\t\t\tresources, and other configurations related to launching the task definition through an\n\t\t\tAmazon ECS service or task.
" - } - }, - "com.amazonaws.ecs#TaskDefinitionFamilyStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - } - } - }, - "com.amazonaws.ecs#TaskDefinitionField": { - "type": "enum", - "members": { - "TAGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TAGS" - } - } - } - }, - "com.amazonaws.ecs#TaskDefinitionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#TaskDefinitionField" - } - }, - "com.amazonaws.ecs#TaskDefinitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#TaskDefinition" - } - }, - "com.amazonaws.ecs#TaskDefinitionPlacementConstraint": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraintType", - "traits": { - "smithy.api#documentation": "The type of constraint. The MemberOf constraint restricts selection to be\n\t\t\tfrom a group of valid candidates.
A cluster query language expression to apply to the constraint. For more information,\n\t\t\tsee Cluster query language in the Amazon Elastic Container Service Developer Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The constraint on task placement in the task definition. For more information, see\n\t\t\t\tTask placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\nTask placement constraints aren't supported for tasks run on Fargate.
\nThe total amount, in GiB, of the ephemeral storage to set for the task. The minimum\n\t\t\tsupported value is 20 GiB and the maximum supported value is\u2028\n\t\t\t\t200 GiB.
Specify an Key Management Service key ID to encrypt the ephemeral storage for the\n\t\t\ttask.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The amount of ephemeral storage to allocate for the task.
" - } - }, - "com.amazonaws.ecs#TaskField": { - "type": "enum", - "members": { - "TAGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TAGS" - } - } - } - }, - "com.amazonaws.ecs#TaskFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#TaskField" - } - }, - "com.amazonaws.ecs#TaskFilesystemType": { - "type": "enum", - "members": { - "EXT3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ext3" - } - }, - "EXT4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ext4" - } - }, - "XFS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "xfs" - } - }, - "NTFS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ntfs" - } - } - } - }, - "com.amazonaws.ecs#TaskManagedEBSVolumeConfiguration": { - "type": "structure", - "members": { - "encrypted": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Indicates whether the volume should be encrypted. If no value is specified, encryption\n\t\t\tis turned on by default. This parameter maps 1:1 with the Encrypted\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When\n\t\t\tencryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key\n\t\t\tfor Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe volume type. This parameter maps 1:1 with the VolumeType parameter of\n\t\t\tthe CreateVolume API in the Amazon EC2 API Reference. For more\n\t\t\tinformation, see Amazon EBS volume types in\n\t\t\tthe Amazon EC2 User Guide.
The following are the supported volume types.
\nGeneral Purpose SSD: gp2|gp3\n
Provisioned IOPS SSD: io1|io2\n
Throughput Optimized HDD: st1\n
Cold HDD: sc1\n
Magnetic: standard\n
The magnetic volume type is not supported on Fargate.
\nThe size of the volume in GiB. You must specify either a volume size or a snapshot ID.\n\t\t\tIf you specify a snapshot ID, the snapshot size is used for the volume size by default.\n\t\t\tYou can optionally specify a volume size greater than or equal to the snapshot size.\n\t\t\tThis parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot\n\t\t\tID or a volume size. This parameter maps 1:1 with the SnapshotId parameter\n\t\t\tof the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3,\n\t\t\tio1, and io2 volumes, this represents the number of IOPS that\n\t\t\tare provisioned for the volume. For gp2 volumes, this represents the\n\t\t\tbaseline performance of the volume and the rate at which the volume accumulates I/O\n\t\t\tcredits for bursting.
The following are the supported values for each volume type.
\n\n gp3: 3,000 - 16,000 IOPS
\n io1: 100 - 64,000 IOPS
\n io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The\n\t\t\tdefault for gp3 volumes is 3,000 IOPS. This parameter is not\n\t\t\tsupported for st1, sc1, or standard volume\n\t\t\ttypes.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.\n\t\t\tThis parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This\n\t\t\tparameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS\n\t\t\tinfrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend\n\t\t\tusing the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM\n\t\t\tpolicy with this role. For more information, see Amazon ECS\n\t\t\t\tinfrastructure IAM role in the Amazon ECS Developer\n\t\t\tGuide.
The termination policy for the volume when the task exits. This provides a way to\n\t\t\tcontrol whether Amazon ECS terminates the Amazon EBS volume when the task stops.
" - } - }, - "filesystemType": { - "target": "com.amazonaws.ecs#TaskFilesystemType", - "traits": { - "smithy.api#documentation": "The Linux filesystem type for the volume. For volumes created from a snapshot, you\n\t\t\tmust specify the same filesystem type that the volume was using when the snapshot was\n\t\t\tcreated. If there is a filesystem type mismatch, the task will fail to start.
\nThe available filesystem types are\u2028 ext3, ext4, and\n\t\t\t\txfs. If no value is specified, the xfs filesystem type is\n\t\t\tused by default.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask.
" - } - }, - "com.amazonaws.ecs#TaskManagedEBSVolumeTerminationPolicy": { - "type": "structure", - "members": { - "deleteOnTermination": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Indicates whether the volume should be deleted on when the task stops. If a value of\n\t\t\t\ttrue is specified, \u2028Amazon ECS deletes the Amazon EBS volume on your behalf when\n\t\t\tthe task goes into the STOPPED state. If no value is specified, the\n\t\t\t\u2028default value is true is used. When set to false, Amazon ECS\n\t\t\tleaves the volume in your \u2028account.
The termination policy for the Amazon EBS volume when the task exits. For more information,\n\t\t\tsee Amazon ECS volume termination policy.
" - } - }, - "com.amazonaws.ecs#TaskOverride": { - "type": "structure", - "members": { - "containerOverrides": { - "target": "com.amazonaws.ecs#ContainerOverrides", - "traits": { - "smithy.api#documentation": "One or more container overrides that are sent to a task.
" - } - }, - "cpu": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The CPU override for the task.
" - } - }, - "inferenceAcceleratorOverrides": { - "target": "com.amazonaws.ecs#InferenceAcceleratorOverrides", - "traits": { - "smithy.api#documentation": "The Elastic Inference accelerator override for the task.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role override for the task. For more information,\n\t\t\tsee Amazon ECS task\n\t\t\t\texecution IAM role in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "memory": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The memory override for the task.
" - } - }, - "taskRoleArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in\n\t\t\tthis task are granted the permissions that are specified in this role. For more\n\t\t\tinformation, see IAM Role for Tasks\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" - } - }, - "ephemeralStorage": { - "target": "com.amazonaws.ecs#EphemeralStorage", - "traits": { - "smithy.api#documentation": "The ephemeral storage setting override for the task.
\nThis parameter is only supported for tasks hosted on Fargate that\n\t\t\t\tuse the following platform versions:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The overrides that are associated with a task.
" - } - }, - "com.amazonaws.ecs#TaskSet": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The ID of the task set.
" - } - }, - "taskSetArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task set.
" - } - }, - "serviceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service the task set exists in.
" - } - }, - "clusterArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists\n\t\t\tin.
" - } - }, - "startedBy": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The tag specified when a task set is started. If an CodeDeploy deployment created the task\n\t\t\tset, the startedBy parameter is CODE_DEPLOY. If an external\n\t\t\tdeployment created the task set, the startedBy field isn't used.
The external ID associated with the task set.
\nIf an CodeDeploy deployment created a task set, the externalId parameter\n\t\t\tcontains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the externalId parameter contains the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
The status of the task set. The following describes each state.
\nThe task set is serving production traffic.
\nThe task set isn't serving production traffic.
\nThe tasks in the task set are being stopped, and their corresponding\n\t\t\t\t\t\ttargets are being deregistered from their target group.
\nThe task definition that the task set is using.
" - } - }, - "computedDesiredCount": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The computed desired count for the task set. This is calculated by multiplying the\n\t\t\tservice's desiredCount by the task set's scale percentage. The\n\t\t\tresult is always rounded up. For example, if the computed desired count is 1.2, it\n\t\t\trounds up to 2 tasks.
The number of tasks in the task set that are in the PENDING status during\n\t\t\ta deployment. A task in the PENDING state is preparing to enter the\n\t\t\t\tRUNNING state. A task set enters the PENDING status when\n\t\t\tit launches for the first time or when it's restarted after being in the\n\t\t\t\tSTOPPED state.
The number of tasks in the task set that are in the RUNNING status during\n\t\t\ta deployment. A task in the RUNNING state is running and ready for\n\t\t\tuse.
The Unix timestamp for the time when the task set was created.
" - } - }, - "updatedAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task set was last updated.
" - } - }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", - "traits": { - "smithy.api#documentation": "The launch type the tasks in the task set are using. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", - "traits": { - "smithy.api#documentation": "The capacity provider strategy that are associated with the task set.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Fargate platform version where the tasks in the task set are running. A platform\n\t\t\tversion is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "platformFamily": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The operating system that your tasks in the set are running on. A platform family is\n\t\t\tspecified only for tasks that use the Fargate launch type.
\nAll tasks in the set must have the same value.
" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "The network configuration for the task set.
" - } - }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", - "traits": { - "smithy.api#documentation": "Details on a load balancer that are used with a task set.
" - } - }, - "serviceRegistries": { - "target": "com.amazonaws.ecs#ServiceRegistries", - "traits": { - "smithy.api#documentation": "The details for the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
" - } - }, - "scale": { - "target": "com.amazonaws.ecs#Scale", - "traits": { - "smithy.api#documentation": "A floating-point percentage of your desired number of tasks to place and keep running\n\t\t\tin the task set.
" - } - }, - "stabilityStatus": { - "target": "com.amazonaws.ecs#StabilityStatus", - "traits": { - "smithy.api#documentation": "The stability status. This indicates whether the task set has reached a steady state.\n\t\t\tIf the following conditions are met, the task set are in\n\t\t\tSTEADY_STATE:
The task runningCount is equal to the\n\t\t\t\t\t\tcomputedDesiredCount.
The pendingCount is 0.
There are no tasks that are running on container instances in the\n\t\t\t\t\t\tDRAINING status.
All tasks are reporting a healthy status from the load balancers, service\n\t\t\t\t\tdiscovery, and container health checks.
\nIf any of those conditions aren't met, the stability status returns\n\t\t\t\tSTABILIZING.
The Unix timestamp for the time when the task set stability status was\n\t\t\tretrieved.
" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The Fargate ephemeral storage settings for the task set.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and\n\t\t\tRegion.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#TaskSets": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#TaskSet" - } - }, - "com.amazonaws.ecs#TaskStopCode": { - "type": "enum", - "members": { - "TASK_FAILED_TO_START": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TaskFailedToStart" - } - }, - "ESSENTIAL_CONTAINER_EXITED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EssentialContainerExited" - } - }, - "USER_INITIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UserInitiated" - } - }, - "SERVICE_SCHEDULER_INITIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ServiceSchedulerInitiated" - } - }, - "SPOT_INTERRUPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SpotInterruption" - } - }, - "TERMINATION_NOTICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TerminationNotice" - } - } - } - }, - "com.amazonaws.ecs#TaskVolumeConfiguration": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#ECSVolumeName", - "traits": { - "smithy.api#documentation": "The name of the volume. This value must match the volume name from the\n\t\t\t\tVolume object in the task definition.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are\n\t\t\tcreated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration settings for the task volume that was configuredAtLaunch\n\t\t\tthat weren't set during RegisterTaskDef.
The amount of time in seconds a connection will stay active while idle. A value of\n\t\t\t\t0 can be set to disable idleTimeout.
The idleTimeout default for\n\t\t\t\tHTTP/HTTP2/GRPC is 5 minutes.
The idleTimeout default for TCP is 1 hour.
The amount of time waiting for the upstream to respond with a complete response per\n\t\t\trequest. A value of 0 can be set to disable perRequestTimeout.\n\t\t\t\tperRequestTimeout can only be set if Service Connect\n\t\t\t\tappProtocol isn't TCP. Only idleTimeout is\n\t\t\tallowed for TCP\n appProtocol.
An object that represents the timeout configurations for Service Connect.
\nIf idleTimeout is set to a time that is less than\n\t\t\t\t\tperRequestTimeout, the connection will close when the\n\t\t\t\t\tidleTimeout is reached and not the\n\t\t\t\tperRequestTimeout.
The absolute file path where the tmpfs volume is to be mounted.
", - "smithy.api#required": {} - } - }, - "size": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum size (in MiB) of the tmpfs volume.
", - "smithy.api#required": {} - } - }, - "mountOptions": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The list of tmpfs volume mount options.
\nValid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n\t\t\t\t\"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n\t\t\t\t\"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n\t\t\t\t\"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n\t\t\t\t\"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n\t\t\t\t| \"nr_inodes\" | \"nr_blocks\" | \"mpol\"\n
The container path, mount options, and size of the tmpfs mount.
" - } - }, - "com.amazonaws.ecs#TmpfsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Tmpfs" - } - }, - "com.amazonaws.ecs#TransportProtocol": { - "type": "enum", - "members": { - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tcp" - } - }, - "UDP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "udp" - } - } - } - }, - "com.amazonaws.ecs#Ulimit": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#UlimitName", - "traits": { - "smithy.api#documentation": "The type of the ulimit.
The soft limit for the ulimit type. The value can be specified in bytes,\n\t\t\tseconds, or as a count, depending on the type of the\n\t\t\tulimit.
The hard limit for the ulimit type. The value can be specified in bytes,\n\t\t\tseconds, or as a count, depending on the type of the\n\t\t\tulimit.
The ulimit settings to pass to the container.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 65535 and the default hard limit\n\t\t\t\t\t\t\tis 65535.
You can specify the ulimit settings for a container in a task\n\t\t\tdefinition.
Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified task isn't supported in this Region.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.ecs#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.ecs#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes specified tags from a resource.
", - "smithy.api#examples": [ - { - "title": "To untag a cluster.", - "documentation": "This example deletes the 'team' tag from the 'dev' cluster.", + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#UpdateClusterSettings": { + "type": "operation", "input": { - "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev", - "tagKeys": ["team"] + "target": "com.amazonaws.ecs#UpdateClusterSettingsRequest" + }, + "output": { + "target": "com.amazonaws.ecs#UpdateClusterSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the settings to use for a cluster.
", + "smithy.api#examples": [ + { + "title": "To update a cluster's settings", + "documentation": "This example enables CloudWatch Container Insights for the default cluster.", + "input": { + "cluster": "default", + "settings": [ + { + "name": "containerInsights", + "value": "enabled" + } + ] + }, + "output": { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "clusterName": "default", + "status": "ACTIVE", + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "pendingTasksCount": 0, + "activeServicesCount": 0, + "statistics": [], + "tags": [], + "settings": [ + { + "name": "containerInsights", + "value": "enabled" + } + ] + } + } + } + ] + } + }, + "com.amazonaws.ecs#UpdateClusterSettingsRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the cluster to modify the settings for.
", + "smithy.api#required": {} + } + }, + "settings": { + "target": "com.amazonaws.ecs#ClusterSettings", + "traits": { + "smithy.api#documentation": "The setting to use by default for a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or PutAccountSettingDefault.
Currently, if you delete an existing cluster that does not have Container Insights\n\t\t\t\tturned on, and then create a new cluster with the same name with Container Insights\n\t\t\t\ttuned on, Container Insights will not actually be turned on. If you want to preserve\n\t\t\t\tthe same name for your existing cluster and turn on Container Insights, you must\n\t\t\t\twait 7 days before you can re-create it.
\nThe Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources\n\t\t\tare Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.ecs#TagKeys", - "traits": { - "smithy.api#documentation": "The keys of the tags to be removed.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#UpdateCapacityProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#UpdateCapacityProviderRequest" - }, - "output": { - "target": "com.amazonaws.ecs#UpdateCapacityProviderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies the parameters for a capacity provider.
", - "smithy.api#examples": [ - { - "title": "To update a capacity provider's parameters", - "documentation": "This example updates the targetCapacity and instanceWarmupPeriod parameters for the capacity provider MyCapacityProvider to 90 and 150 respectively.", - "input": { - "name": "MyCapacityProvider", - "autoScalingGroupProvider": { - "managedScaling": { - "status": "ENABLED", - "targetCapacity": 90, - "instanceWarmupPeriod": 150 + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#UpdateClusterSettingsResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#Cluster", + "traits": { + "smithy.api#documentation": "Details about the cluster
" + } } - } }, - "output": { - "capacityProvider": { - "capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider", - "name": "MyCapacityProvider", - "status": "ACTIVE", - "autoScalingGroupProvider": { - "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG", - "managedScaling": { - "status": "ENABLED", - "targetCapacity": 90, - "minimumScalingStepSize": 1, - "maximumScalingStepSize": 10000, - "instanceWarmupPeriod": 150 - }, - "managedTerminationProtection": "ENABLED" - }, - "updateStatus": "UPDATE_COMPLETE", - "tags": [] - } - } - } - ] - } - }, - "com.amazonaws.ecs#UpdateCapacityProviderRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the capacity provider to update.
", - "smithy.api#required": {} - } - }, - "autoScalingGroupProvider": { - "target": "com.amazonaws.ecs#AutoScalingGroupProviderUpdate", - "traits": { - "smithy.api#documentation": "An object that represent the parameters to update for the Auto Scaling group capacity\n\t\t\tprovider.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#UpdateCapacityProviderResponse": { - "type": "structure", - "members": { - "capacityProvider": { - "target": "com.amazonaws.ecs#CapacityProvider", - "traits": { - "smithy.api#documentation": "Details about the capacity provider.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#UpdateCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#UpdateClusterRequest" - }, - "output": { - "target": "com.amazonaws.ecs#UpdateClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#NamespaceNotFoundException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the cluster.
", - "smithy.api#examples": [ - { - "title": "To update a cluster's observability settings.", - "documentation": "This example turns on enhanced containerInsights in an existing cluster. ", + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#UpdateContainerAgent": { + "type": "operation", "input": { - "cluster": "ECS-project-update-cluster", - "settings": [ + "target": "com.amazonaws.ecs#UpdateContainerAgentRequest" + }, + "output": { + "target": "com.amazonaws.ecs#UpdateContainerAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#MissingVersionException" + }, + { + "target": "com.amazonaws.ecs#NoUpdateAvailableException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, { - "name": "containerInsights", - "value": "enhanced" + "target": "com.amazonaws.ecs#UpdateInProgressException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the Amazon ECS container agent on a specified container instance. Updating the\n\t\t\tAmazon ECS container agent doesn't interrupt running tasks or services on the container\n\t\t\tinstance. The process for updating the agent differs depending on whether your container\n\t\t\tinstance was launched with the Amazon ECS-optimized AMI or another operating system.
\nThe UpdateContainerAgent API isn't supported for container instances\n\t\t\t\tusing the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,\n\t\t\t\tyou can update the ecs-init package. This updates the agent. For more\n\t\t\t\tinformation, see Updating the\n\t\t\t\t\tAmazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
Agent updates with the UpdateContainerAgent API operation do not\n\t\t\t\tapply to Windows container instances. We recommend that you launch new container\n\t\t\t\tinstances to update the agent version in your Windows clusters.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon\n\t\t\tLinux AMI with the ecs-init service installed and running. For help\n\t\t\tupdating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is\n\t\t\trunning on. If you do not specify a cluster, the default cluster is assumed.
" + } + }, + "containerInstance": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The container instance ID or full ARN entries for the container instance where you\n\t\t\twould like to update the Amazon ECS container agent.
", + "smithy.api#required": {} + } } - ] }, - "output": { - "cluster": { - "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster", - "clusterName": "ECS-project-update-cluster", - "status": "ACTIVE", - "registeredContainerInstancesCount": 0, - "runningTasksCount": 0, - "pendingTasksCount": 0, - "activeServicesCount": 0, - "statistics": [], - "tags": [], - "settings": [ - { - "name": "containerInsights", - "value": "enhanced" - } - ], - "capacityProviders": [ - "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" - ], - "defaultCapacityProviderStrategy": [ - { - "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", - "weight": 1, - "base": 0 - } - ], - "attachments": [ - { - "id": "069d002b-7634-42e4-b1d4-544f4c8f6380", - "type": "as_policy", - "status": "CREATED", - "details": [ - { - "name": "capacityProviderName", - "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" - }, - { - "name": "scalingPolicyName", - "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93" - } - ] - }, - { - "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a", - "type": "managed_draining", - "status": "CREATED", - "details": [ - { - "name": "capacityProviderName", - "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" - }, - { - "name": "autoScalingLifecycleHookName", - "value": "ecs-managed-draining-termination-hook" - } - ] - }, - { - "id": "45d0b36f-8cff-46b6-9380-1288744802ab", - "type": "sc", - "status": "ATTACHED", - "details": [] - } - ], - "attachmentsStatus": "UPDATE_COMPLETE", - "serviceConnectDefaults": { - "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-igwrsylmy3kwvcdx" + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#UpdateContainerAgentResponse": { + "type": "structure", + "members": { + "containerInstance": { + "target": "com.amazonaws.ecs#ContainerInstance", + "traits": { + "smithy.api#documentation": "The container instance that the container agent was updated for.
" + } } - } + }, + "traits": { + "smithy.api#output": {} } - }, - { - "title": "To update a cluster's Service Connect defaults.", - "documentation": "This example sets a default Service Connect namespace. ", + }, + "com.amazonaws.ecs#UpdateContainerInstancesState": { + "type": "operation", "input": { - "cluster": "ECS-project-update-cluster", - "serviceConnectDefaults": { - "namespace": "test" - } + "target": "com.amazonaws.ecs#UpdateContainerInstancesStateRequest" }, "output": { - "cluster": { - "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster", - "clusterName": "ECS-project-update-cluster", - "status": "ACTIVE", - "registeredContainerInstancesCount": 0, - "runningTasksCount": 0, - "pendingTasksCount": 0, - "activeServicesCount": 0, - "statistics": [], - "tags": [], - "settings": [ - { - "name": "containerInsights", - "value": "enhanced" - } - ], - "capacityProviders": [ - "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" - ], - "defaultCapacityProviderStrategy": [ - { - "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", - "weight": 1, - "base": 0 - } - ], - "attachments": [ - { - "id": "069d002b-7634-42e4-b1d4-544f4c8f6380", - "type": "as_policy", - "status": "CREATED", - "details": [ - { - "name": "capacityProviderName", - "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" - }, - { - "name": "scalingPolicyName", - "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93" - } - ] - }, - { - "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a", - "type": "managed_draining", - "status": "CREATED", - "details": [ - { - "name": "capacityProviderName", - "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" - }, - { - "name": "autoScalingLifecycleHookName", - "value": "ecs-managed-draining-termination-hook" - } - ] - }, - { - "id": "45d0b36f-8cff-46b6-9380-1288744802ab", - "type": "sc", - "status": "DELETED", - "details": [] - }, - { - "id": "3e6890c3-609c-4832-91de-d6ca891b3ef1", - "type": "sc", - "status": "ATTACHED", - "details": [] - }, - { - "id": "961b8ec1-c2f1-4070-8495-e669b7668e90", - "type": "sc", - "status": "DELETED", - "details": [] - } - ], - "attachmentsStatus": "UPDATE_COMPLETE", - "serviceConnectDefaults": { - "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-dtjmxqpfi46ht7dr" + "target": "com.amazonaws.ecs#UpdateContainerInstancesStateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" } - } + ], + "traits": { + "smithy.api#documentation": "Modifies the status of an Amazon ECS container instance.
\nOnce a container instance has reached an ACTIVE state, you can change the\n\t\t\tstatus of a container instance to DRAINING to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.
A container instance can't be changed to DRAINING until it has\n\t\t\t\treached an ACTIVE status. If the instance is in any other status, an\n\t\t\t\terror will be received.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING\n\t\t\tstate are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent and maximumPercent. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during task replacement. For example,\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. If the\n\t\t\t\t\tminimum is 100%, the service scheduler can't remove existing tasks until the\n\t\t\t\t\treplacement tasks are considered healthy. Tasks for services that do not use a\n\t\t\t\t\tload balancer are considered healthy if they're in the RUNNING\n\t\t\t\t\tstate. Tasks for services that use a load balancer are considered healthy if\n\t\t\t\t\tthey're in the RUNNING state and are reported as healthy by the\n\t\t\t\t\tload balancer.
The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during task replacement. You can use this to define the\n\t\t\t\t\treplacement batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four tasks to be\n\t\t\t\t\tdrained, provided that the cluster resources required to do this are available.\n\t\t\t\t\tIf the maximum is 100%, then replacement tasks can't start until the draining\n\t\t\t\t\ttasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service\n\t\t\taren't affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING\n\t\t\ttasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.
The name of the cluster to modify the settings for.
", - "smithy.api#required": {} - } - }, - "settings": { - "target": "com.amazonaws.ecs#ClusterSettings", - "traits": { - "smithy.api#documentation": "The cluster settings for your cluster.
" - } - }, - "configuration": { - "target": "com.amazonaws.ecs#ClusterConfiguration", - "traits": { - "smithy.api#documentation": "The execute command configuration for the cluster.
" - } - }, - "serviceConnectDefaults": { - "target": "com.amazonaws.ecs#ClusterServiceConnectDefaultsRequest", - "traits": { - "smithy.api#documentation": "Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#UpdateClusterResponse": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#Cluster", - "traits": { - "smithy.api#documentation": "Details about the cluster.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#UpdateClusterSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#UpdateClusterSettingsRequest" - }, - "output": { - "target": "com.amazonaws.ecs#UpdateClusterSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies the settings to use for a cluster.
", - "smithy.api#examples": [ - { - "title": "To update a cluster's settings", - "documentation": "This example enables CloudWatch Container Insights for the default cluster.", - "input": { - "cluster": "default", - "settings": [ - { - "name": "containerInsights", - "value": "enabled" + }, + "com.amazonaws.ecs#UpdateContainerInstancesStateRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tupdate. If you do not specify a cluster, the default cluster is assumed.
" + } + }, + "containerInstances": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "A list of up to 10 container instance IDs or full ARN entries.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.ecs#ContainerInstanceStatus", + "traits": { + "smithy.api#documentation": "The container instance state to update the container instance with. The only valid\n\t\t\tvalues for this action are ACTIVE and DRAINING. A container\n\t\t\tinstance can only be updated to DRAINING status once it has reached an\n\t\t\t\tACTIVE state. If a container instance is in REGISTERING,\n\t\t\t\tDEREGISTERING, or REGISTRATION_FAILED state you can\n\t\t\tdescribe the container instance but can't update the container instance state.
The list of container instances.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#UpdateInProgressException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Message that describes the cause of the exception.
" + } } - ] + }, + "traits": { + "smithy.api#documentation": "There's already a current Amazon ECS container agent update in progress on the container\n\t\t\tinstance that's specified. If the container agent becomes disconnected while it's in a\n\t\t\ttransitional stage, such as PENDING or STAGING, the update\n\t\t\tprocess can get stuck in that state. However, when the agent reconnects, it resumes\n\t\t\twhere it stopped previously.
Modifies the parameters of a service.
\nOn March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nFor services using the rolling update (ECS) you can update the desired\n\t\t\tcount, deployment configuration, network configuration, load balancers, service\n\t\t\tregistries, enable ECS managed tags option, propagate tags option, task placement\n\t\t\tconstraints and strategies, and task definition. When you update any of these\n\t\t\tparameters, Amazon ECS starts new tasks with the new configuration.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or\n\t\t\trunning a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update\n\t\t\tyour volume configurations and trigger a new deployment.\n\t\t\t\tvolumeConfigurations is only supported for REPLICA service and not\n\t\t\tDAEMON service. If you leave volumeConfigurations\n null, it doesn't trigger a new deployment. For more infomation on volumes,\n\t\t\tsee Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, health check grace period, task\n\t\t\tplacement constraints and strategies, enable ECS managed tags option, and propagate tags\n\t\t\tcan be updated using this API. If the network configuration, platform version, task\n\t\t\tdefinition, or load balancer need to be updated, create a new CodeDeploy deployment. For more\n\t\t\tinformation, see CreateDeployment in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, health check grace period, enable ECS\n\t\t\tmanaged tags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.
\nYou can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or\n\t\t\trunning a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
\nIf you have updated the container image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.
\nIf your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.
You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that don't use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they're in the RUNNING state and are reported\n\t\t\t\t\tas healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment. You can use it to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).
When UpdateService\n\t\t\tstops a task during a deployment, the equivalent of docker stop is issued\n\t\t\tto the containers running in the task. This results in a SIGTERM and a\n\t\t\t30-second timeout. After this, SIGKILL is sent and the containers are\n\t\t\tforcibly stopped. If the container handles the SIGTERM gracefully and exits\n\t\t\twithin 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.
\nDetermine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition. For example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes.
\nBy default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner even though you can choose a different\n\t\t\t\t\tplacement strategy.
\nSort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.
\nPlace the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.
\nWhen the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:
\nSort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.
\nStop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.
\nYou must have a service-linked role when you update any of the following service\n\t\t\t\tproperties:
\n\n loadBalancers,
\n serviceRegistries\n
For more information about the role see the CreateService request\n\t\t\t\tparameter \n role\n .
The name of the cluster to modify the settings for.
", - "smithy.api#required": {} - } - }, - "settings": { - "target": "com.amazonaws.ecs#ClusterSettings", - "traits": { - "smithy.api#documentation": "The setting to use by default for a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or PutAccountSettingDefault.
Currently, if you delete an existing cluster that does not have Container Insights\n\t\t\t\tturned on, and then create a new cluster with the same name with Container Insights\n\t\t\t\ttuned on, Container Insights will not actually be turned on. If you want to preserve\n\t\t\t\tthe same name for your existing cluster and turn on Container Insights, you must\n\t\t\t\twait 7 days before you can re-create it.
\nDetails about the cluster
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#UpdateContainerAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#UpdateContainerAgentRequest" - }, - "output": { - "target": "com.amazonaws.ecs#UpdateContainerAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#MissingVersionException" - }, - { - "target": "com.amazonaws.ecs#NoUpdateAvailableException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#UpdateInProgressException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the Amazon ECS container agent on a specified container instance. Updating the\n\t\t\tAmazon ECS container agent doesn't interrupt running tasks or services on the container\n\t\t\tinstance. The process for updating the agent differs depending on whether your container\n\t\t\tinstance was launched with the Amazon ECS-optimized AMI or another operating system.
\nThe UpdateContainerAgent API isn't supported for container instances\n\t\t\t\tusing the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,\n\t\t\t\tyou can update the ecs-init package. This updates the agent. For more\n\t\t\t\tinformation, see Updating the\n\t\t\t\t\tAmazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
Agent updates with the UpdateContainerAgent API operation do not\n\t\t\t\tapply to Windows container instances. We recommend that you launch new container\n\t\t\t\tinstances to update the agent version in your Windows clusters.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon\n\t\t\tLinux AMI with the ecs-init service installed and running. For help\n\t\t\tupdating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
Modifies which task set in a service is the primary task set. Any parameters that are\n\t\t\tupdated on the primary task set in a service will transition to the service. This is\n\t\t\tused when a service uses the EXTERNAL deployment controller type. For more\n\t\t\tinformation, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is\n\t\t\trunning on. If you do not specify a cluster, the default cluster is assumed.
" - } - }, - "containerInstance": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The container instance ID or full ARN entries for the container instance where you\n\t\t\twould like to update the Amazon ECS container agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#UpdateContainerAgentResponse": { - "type": "structure", - "members": { - "containerInstance": { - "target": "com.amazonaws.ecs#ContainerInstance", - "traits": { - "smithy.api#documentation": "The container instance that the container agent was updated for.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#UpdateContainerInstancesState": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#UpdateContainerInstancesStateRequest" - }, - "output": { - "target": "com.amazonaws.ecs#UpdateContainerInstancesStateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies the status of an Amazon ECS container instance.
\nOnce a container instance has reached an ACTIVE state, you can change the\n\t\t\tstatus of a container instance to DRAINING to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.
A container instance can't be changed to DRAINING until it has\n\t\t\t\treached an ACTIVE status. If the instance is in any other status, an\n\t\t\t\terror will be received.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING\n\t\t\tstate are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent and maximumPercent. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during task replacement. For example,\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. If the\n\t\t\t\t\tminimum is 100%, the service scheduler can't remove existing tasks until the\n\t\t\t\t\treplacement tasks are considered healthy. Tasks for services that do not use a\n\t\t\t\t\tload balancer are considered healthy if they're in the RUNNING\n\t\t\t\t\tstate. Tasks for services that use a load balancer are considered healthy if\n\t\t\t\t\tthey're in the RUNNING state and are reported as healthy by the\n\t\t\t\t\tload balancer.
The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during task replacement. You can use this to define the\n\t\t\t\t\treplacement batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four tasks to be\n\t\t\t\t\tdrained, provided that the cluster resources required to do this are available.\n\t\t\t\t\tIf the maximum is 100%, then replacement tasks can't start until the draining\n\t\t\t\t\ttasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service\n\t\t\taren't affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING\n\t\t\ttasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in.
", + "smithy.api#required": {} + } + }, + "service": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
", + "smithy.api#required": {} + } + }, + "primaryTaskSet": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the\n\t\t\tdeployment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#UpdateServicePrimaryTaskSetResponse": { + "type": "structure", + "members": { + "taskSet": { + "target": "com.amazonaws.ecs#TaskSet", + "traits": { + "smithy.api#documentation": "The details about the task set.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#UpdateServiceRequest": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + } + }, + "service": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the service to update.
", + "smithy.api#required": {} + } + }, + "desiredCount": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The number of instantiations of the task to place and keep running in your\n\t\t\tservice.
" + } + }, + "taskDefinition": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision is\n\t\t\tnot specified, the latest ACTIVE revision is used. If you modify the task\n\t\t\tdefinition with UpdateService, Amazon ECS spawns a task with the new version of\n\t\t\tthe task definition and then stops an old task after the new version is running.
The capacity provider strategy to update the service to use.
\nif the service uses the default capacity provider strategy for the cluster, the\n\t\t\tservice can be updated to use one or more capacity providers as opposed to the default\n\t\t\tcapacity provider strategy. However, when a service is using a capacity provider\n\t\t\tstrategy that's not the default capacity provider strategy, the service can't be updated\n\t\t\tto use the cluster's default capacity provider strategy.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity provider\n\t\t\twith a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateClusterCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProvidersAPI operation is used to update the list of\n\t\t\tavailable capacity providers for a cluster after the cluster is created.
\n " + } + }, + "deploymentConfiguration": { + "target": "com.amazonaws.ecs#DeploymentConfiguration", + "traits": { + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" + } + }, + "availabilityZoneRebalancing": { + "target": "com.amazonaws.ecs#AvailabilityZoneRebalancing", + "traits": { + "smithy.api#documentation": "Indicates whether to use Availability Zone rebalancing for the service.
\nFor more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "An object representing the network configuration for the service.
" + } + }, + "placementConstraints": { + "target": "com.amazonaws.ecs#PlacementConstraints", + "traits": { + "smithy.api#documentation": "An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.
\nYou can specify a maximum of 10 constraints for each task. This limit includes\n\t\t\tconstraints in the task definition and those specified at runtime.
" + } + }, + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", + "traits": { + "smithy.api#documentation": "The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.
\nYou can specify a maximum of five strategy rules for each service.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If a platform version\n\t\t\tis not specified, the LATEST platform version is used. For more\n\t\t\tinformation, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
Determines whether to force a new deployment of the service. By default, deployments\n\t\t\taren't forced. You can use this option to start a new deployment with no service\n\t\t\tdefinition changes. For example, you can update a service's tasks to use a newer Docker\n\t\t\timage with the same image/tag combination (my_image:latest) or to roll\n\t\t\tFargate tasks onto a newer platform version.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't\n\t\t\tspecify a health check grace period value, the default value of 0 is used.\n\t\t\tIf you don't use any of the health checks, then\n\t\t\t\thealthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can\n\t\t\tspecify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.
" + } + }, + "enableExecuteCommand": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "If true, this enables execute command functionality on all task\n\t\t\tcontainers.
If you do not want to override the value that was set when the service was created,\n\t\t\tyou can set this to null when performing this action.
Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
\nOnly tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.
A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.
\nWhen you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks\n\t\t\twith the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks\n\t\t\tare running.
\nFor services that use rolling updates, you can add, update, or remove Elastic Load Balancing target\n\t\t\tgroups. You can update from a single target group to multiple target groups and from\n\t\t\tmultiple target groups to a single target group.
\nFor services that use blue/green deployments, you can update Elastic Load Balancing target groups by\n\t\t\tusing \n CreateDeployment\n through CodeDeploy. Note that multiple target groups\n\t\t\tare not supported for blue/green deployments. For more information see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
For services that use the external deployment controller, you can add, update, or\n\t\t\tremove load balancers by using CreateTaskSet.\n\t\t\tNote that multiple target groups are not supported for external deployments. For more\n\t\t\tinformation see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
\nYou can remove existing loadBalancers by passing an empty list.
Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.
\nOnly tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.
The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts new\n\t\t\ttasks with the updated service registries configuration, and then stops the old tasks\n\t\t\twhen the new tasks are running.
\nYou can remove existing serviceRegistries by passing an empty\n\t\t\tlist.
The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "volumeConfigurations": { + "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", + "traits": { + "smithy.api#documentation": "The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume\n\t\t\tmust match the name from the task definition. If set to null, no new\n\t\t\tdeployment is triggered. Otherwise, if this configuration differs from the existing one,\n\t\t\tit triggers a new deployment.
An object representing the VPC Lattice configuration for the service being\n\t\t\tupdated.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#UpdateServiceResponse": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.ecs#Service", + "traits": { + "smithy.api#documentation": "The full description of your service following the update call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#UpdateTaskProtection": { + "type": "operation", "input": { - "cluster": "default", - "containerInstances": ["1c3be8ed-df30-47b4-8f1e-6e68ebd01f34"], - "status": "DRAINING" + "target": "com.amazonaws.ecs#UpdateTaskProtectionRequest" }, "output": { - "containerInstances": [ + "target": "com.amazonaws.ecs#UpdateTaskProtectionResponse" + }, + "errors": [ { - "agentConnected": true, - "attributes": [ - { - "name": "ecs.availability-zone", - "value": "us-west-2b" - }, - { - "name": "com.amazonaws.ecs.capability.logging-driver.syslog" - }, - { - "name": "ecs.instance-type", - "value": "c4.xlarge" - }, - { - "name": "ecs.ami-id", - "value": "ami-a2ca61c2" - }, - { - "name": "com.amazonaws.ecs.capability.task-iam-role-network-host" - }, - { - "name": "com.amazonaws.ecs.capability.logging-driver.awslogs" - }, - { - "name": "com.amazonaws.ecs.capability.logging-driver.json-file" - }, - { - "name": "com.amazonaws.ecs.capability.docker-remote-api.1.17" - }, - { - "name": "com.amazonaws.ecs.capability.privileged-container" - }, - { - "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18" - }, - { - "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19" - }, - { - "name": "com.amazonaws.ecs.capability.ecr-auth" - }, - { - "name": "ecs.os-type", - "value": "linux" - }, - { - "name": "com.amazonaws.ecs.capability.docker-remote-api.1.20" - }, - { - "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21" - }, + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\texpiresInMinutes property. The expiresInMinutes property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .
\nThis operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an TASK_NOT_VALID\n\t\t\t\tfailure. For more information, see API failure\n\t\t\t\t\treasons.
If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.
\nThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tupdate. If you do not specify a cluster, the default cluster is assumed.
" - } - }, - "containerInstances": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "A list of up to 10 container instance IDs or full ARN entries.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.ecs#ContainerInstanceStatus", - "traits": { - "smithy.api#documentation": "The container instance state to update the container instance with. The only valid\n\t\t\tvalues for this action are ACTIVE and DRAINING. A container\n\t\t\tinstance can only be updated to DRAINING status once it has reached an\n\t\t\t\tACTIVE state. If a container instance is in REGISTERING,\n\t\t\t\tDEREGISTERING, or REGISTRATION_FAILED state you can\n\t\t\tdescribe the container instance but can't update the container instance state.
The list of container instances.
" - } - }, - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#UpdateInProgressException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "Message that describes the cause of the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "There's already a current Amazon ECS container agent update in progress on the container\n\t\t\tinstance that's specified. If the container agent becomes disconnected while it's in a\n\t\t\ttransitional stage, such as PENDING or STAGING, the update\n\t\t\tprocess can get stuck in that state. However, when the agent reconnects, it resumes\n\t\t\twhere it stopped previously.
Modifies the parameters of a service.
\nOn March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nFor services using the rolling update (ECS) you can update the desired\n\t\t\tcount, deployment configuration, network configuration, load balancers, service\n\t\t\tregistries, enable ECS managed tags option, propagate tags option, task placement\n\t\t\tconstraints and strategies, and task definition. When you update any of these\n\t\t\tparameters, Amazon ECS starts new tasks with the new configuration.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or\n\t\t\trunning a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update\n\t\t\tyour volume configurations and trigger a new deployment.\n\t\t\t\tvolumeConfigurations is only supported for REPLICA service and not\n\t\t\tDAEMON service. If you leave volumeConfigurations\n null, it doesn't trigger a new deployment. For more infomation on volumes,\n\t\t\tsee Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, health check grace period, task\n\t\t\tplacement constraints and strategies, enable ECS managed tags option, and propagate tags\n\t\t\tcan be updated using this API. If the network configuration, platform version, task\n\t\t\tdefinition, or load balancer need to be updated, create a new CodeDeploy deployment. For more\n\t\t\tinformation, see CreateDeployment in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, health check grace period, enable ECS\n\t\t\tmanaged tags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.
\nYou can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or\n\t\t\trunning a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
\nIf you have updated the container image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.
\nIf your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.
You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that don't use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they're in the RUNNING state and are reported\n\t\t\t\t\tas healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment. You can use it to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).
When UpdateService\n\t\t\tstops a task during a deployment, the equivalent of docker stop is issued\n\t\t\tto the containers running in the task. This results in a SIGTERM and a\n\t\t\t30-second timeout. After this, SIGKILL is sent and the containers are\n\t\t\tforcibly stopped. If the container handles the SIGTERM gracefully and exits\n\t\t\twithin 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.
\nDetermine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition. For example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes.
\nBy default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner even though you can choose a different\n\t\t\t\t\tplacement strategy.
\nSort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.
\nPlace the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.
\nWhen the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:
\nSort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.
\nStop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.
\nYou must have a service-linked role when you update any of the following service\n\t\t\t\tproperties:
\n\n loadBalancers,
\n serviceRegistries\n
For more information about the role see the CreateService request\n\t\t\t\tparameter \n role\n .
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", + "smithy.api#required": {} + } + }, + "tasks": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "A list of up to 10 task IDs or full ARN entries.
", + "smithy.api#required": {} + } + }, + "protectionEnabled": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specify true to mark a task for protection and false to\n\t\t\tunset protection, making it eligible for termination.
If you set protectionEnabled to true, you can specify the\n\t\t\tduration for task protection in minutes. You can specify a value from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in\n\t\t\tevents from Service Auto Scaling or deployments. After this time period lapses,\n\t\t\t\tprotectionEnabled will be reset to false.
If you don’t specify the time, then the task is automatically protected for 120\n\t\t\tminutes (2 hours).
" + } + } }, - "output": {} - } - ] - } - }, - "com.amazonaws.ecs#UpdateServicePrimaryTaskSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#UpdateServicePrimaryTaskSetRequest" - }, - "output": { - "target": "com.amazonaws.ecs#UpdateServicePrimaryTaskSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#ServiceNotActiveException" - }, - { - "target": "com.amazonaws.ecs#ServiceNotFoundException" - }, - { - "target": "com.amazonaws.ecs#TaskSetNotFoundException" + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies which task set in a service is the primary task set. Any parameters that are\n\t\t\tupdated on the primary task set in a service will transition to the service. This is\n\t\t\tused when a service uses the EXTERNAL deployment controller type. For more\n\t\t\tinformation, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is turned on for a task, the value is true. Otherwise,\n\t\t\t\t\tit is false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in.
", - "smithy.api#required": {} - } - }, - "service": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
", - "smithy.api#required": {} - } - }, - "primaryTaskSet": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the\n\t\t\tdeployment.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#UpdateServicePrimaryTaskSetResponse": { - "type": "structure", - "members": { - "taskSet": { - "target": "com.amazonaws.ecs#TaskSet", - "traits": { - "smithy.api#documentation": "The details about the task set.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#UpdateServiceRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" - } - }, - "service": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the service to update.
", - "smithy.api#required": {} - } - }, - "desiredCount": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The number of instantiations of the task to place and keep running in your\n\t\t\tservice.
" - } - }, - "taskDefinition": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision is\n\t\t\tnot specified, the latest ACTIVE revision is used. If you modify the task\n\t\t\tdefinition with UpdateService, Amazon ECS spawns a task with the new version of\n\t\t\tthe task definition and then stops an old task after the new version is running.
The capacity provider strategy to update the service to use.
\nif the service uses the default capacity provider strategy for the cluster, the\n\t\t\tservice can be updated to use one or more capacity providers as opposed to the default\n\t\t\tcapacity provider strategy. However, when a service is using a capacity provider\n\t\t\tstrategy that's not the default capacity provider strategy, the service can't be updated\n\t\t\tto use the cluster's default capacity provider strategy.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity provider\n\t\t\twith a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateClusterCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProvidersAPI operation is used to update the list of\n\t\t\tavailable capacity providers for a cluster after the cluster is created.
\n " - } - }, - "deploymentConfiguration": { - "target": "com.amazonaws.ecs#DeploymentConfiguration", - "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" - } - }, - "availabilityZoneRebalancing": { - "target": "com.amazonaws.ecs#AvailabilityZoneRebalancing", - "traits": { - "smithy.api#documentation": "Indicates whether to use Availability Zone rebalancing for the service.
\nFor more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "An object representing the network configuration for the service.
" - } - }, - "placementConstraints": { - "target": "com.amazonaws.ecs#PlacementConstraints", - "traits": { - "smithy.api#documentation": "An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.
\nYou can specify a maximum of 10 constraints for each task. This limit includes\n\t\t\tconstraints in the task definition and those specified at runtime.
" - } - }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", - "traits": { - "smithy.api#documentation": "The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.
\nYou can specify a maximum of five strategy rules for each service.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If a platform version\n\t\t\tis not specified, the LATEST platform version is used. For more\n\t\t\tinformation, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
Determines whether to force a new deployment of the service. By default, deployments\n\t\t\taren't forced. You can use this option to start a new deployment with no service\n\t\t\tdefinition changes. For example, you can update a service's tasks to use a newer Docker\n\t\t\timage with the same image/tag combination (my_image:latest) or to roll\n\t\t\tFargate tasks onto a newer platform version.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't\n\t\t\tspecify a health check grace period value, the default value of 0 is used.\n\t\t\tIf you don't use any of the health checks, then\n\t\t\t\thealthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can\n\t\t\tspecify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.
" - } - }, - "enableExecuteCommand": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "If true, this enables execute command functionality on all task\n\t\t\tcontainers.
If you do not want to override the value that was set when the service was created,\n\t\t\tyou can set this to null when performing this action.
Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
\nOnly tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.
A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.
\nWhen you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks\n\t\t\twith the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks\n\t\t\tare running.
\nFor services that use rolling updates, you can add, update, or remove Elastic Load Balancing target\n\t\t\tgroups. You can update from a single target group to multiple target groups and from\n\t\t\tmultiple target groups to a single target group.
\nFor services that use blue/green deployments, you can update Elastic Load Balancing target groups by\n\t\t\tusing \n CreateDeployment\n through CodeDeploy. Note that multiple target groups\n\t\t\tare not supported for blue/green deployments. For more information see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
For services that use the external deployment controller, you can add, update, or\n\t\t\tremove load balancers by using CreateTaskSet.\n\t\t\tNote that multiple target groups are not supported for external deployments. For more\n\t\t\tinformation see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
\nYou can remove existing loadBalancers by passing an empty list.
Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.
\nOnly tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.
The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts new\n\t\t\ttasks with the updated service registries configuration, and then stops the old tasks\n\t\t\twhen the new tasks are running.
\nYou can remove existing serviceRegistries by passing an empty\n\t\t\tlist.
The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "volumeConfigurations": { - "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", - "traits": { - "smithy.api#documentation": "The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume\n\t\t\tmust match the name from the task definition. If set to null, no new\n\t\t\tdeployment is triggered. Otherwise, if this configuration differs from the existing one,\n\t\t\tit triggers a new deployment.
An object representing the VPC Lattice configuration for the service being\n\t\t\tupdated.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#UpdateServiceResponse": { - "type": "structure", - "members": { - "service": { - "target": "com.amazonaws.ecs#Service", - "traits": { - "smithy.api#documentation": "The full description of your service following the update call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#UpdateTaskProtection": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#UpdateTaskProtectionRequest" - }, - "output": { - "target": "com.amazonaws.ecs#UpdateTaskProtectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" - }, - { - "target": "com.amazonaws.ecs#ClientException" - }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" - }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" - }, - { - "target": "com.amazonaws.ecs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ecs#ServerException" - }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\texpiresInMinutes property. The expiresInMinutes property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .
\nThis operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an TASK_NOT_VALID\n\t\t\t\tfailure. For more information, see API failure\n\t\t\t\t\treasons.
If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.
\nAny failures associated with the call.
" + } } - ], - "failures": [] + }, + "traits": { + "smithy.api#output": {} } - }, - { - "title": "To set task scale-in protection for a task for 60 minutes", - "documentation": "This example enables scale-in protection for a task for 60 minutes.", + }, + "com.amazonaws.ecs#UpdateTaskSet": { + "type": "operation", "input": { - "cluster": "test-task-protection", - "tasks": ["b8b1cf532d0e46ba8d44a40d1de16772"], - "protectionEnabled": true, - "expiresInMinutes": 60 + "target": "com.amazonaws.ecs#UpdateTaskSetRequest" }, "output": { - "protectedTasks": [ + "target": "com.amazonaws.ecs#UpdateTaskSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, { - "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772", - "protectionEnabled": true, - "expirationDate": "2022-11-02T06:56:32.553Z" + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#ServiceNotActiveException" + }, + { + "target": "com.amazonaws.ecs#ServiceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#TaskSetNotFoundException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" } - ], - "failures": [] + ], + "traits": { + "smithy.api#documentation": "Modifies a task set. This is used when a service uses the EXTERNAL\n\t\t\tdeployment controller type. For more information, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset is found in.
", + "smithy.api#required": {} + } + }, + "service": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.
", + "smithy.api#required": {} + } + }, + "taskSet": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the task set to update.
", + "smithy.api#required": {} + } + }, + "scale": { + "target": "com.amazonaws.ecs#Scale", + "traits": { + "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
", + "smithy.api#required": {} + } } - ], - "failures": [] + }, + "traits": { + "smithy.api#input": {} } - } - ] - } - }, - "com.amazonaws.ecs#UpdateTaskProtectionRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", - "smithy.api#required": {} - } - }, - "tasks": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "A list of up to 10 task IDs or full ARN entries.
", - "smithy.api#required": {} - } - }, - "protectionEnabled": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Specify true to mark a task for protection and false to\n\t\t\tunset protection, making it eligible for termination.
If you set protectionEnabled to true, you can specify the\n\t\t\tduration for task protection in minutes. You can specify a value from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in\n\t\t\tevents from Service Auto Scaling or deployments. After this time period lapses,\n\t\t\t\tprotectionEnabled will be reset to false.
If you don’t specify the time, then the task is automatically protected for 120\n\t\t\tminutes (2 hours).
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#UpdateTaskProtectionResponse": { - "type": "structure", - "members": { - "protectedTasks": { - "target": "com.amazonaws.ecs#ProtectedTasks", - "traits": { - "smithy.api#documentation": "A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is turned on for a task, the value is true. Otherwise,\n\t\t\t\t\tit is false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
Any failures associated with the call.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#UpdateTaskSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ecs#UpdateTaskSetRequest" - }, - "output": { - "target": "com.amazonaws.ecs#UpdateTaskSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ecs#AccessDeniedException" }, - { - "target": "com.amazonaws.ecs#ClientException" + "com.amazonaws.ecs#UpdateTaskSetResponse": { + "type": "structure", + "members": { + "taskSet": { + "target": "com.amazonaws.ecs#TaskSet", + "traits": { + "smithy.api#documentation": "Details about the task set.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ecs#ClusterNotFoundException" + "com.amazonaws.ecs#VersionConsistency": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } }, - { - "target": "com.amazonaws.ecs#InvalidParameterException" + "com.amazonaws.ecs#VersionInfo": { + "type": "structure", + "members": { + "agentVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The version number of the Amazon ECS container agent.
" + } + }, + "agentHash": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent\n\t\t\t GitHub repository.
" + } + }, + "dockerVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Docker version that's running on the container instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Docker and Amazon ECS container agent version information about a container\n\t\t\tinstance.
" + } }, - { - "target": "com.amazonaws.ecs#ServerException" + "com.amazonaws.ecs#Volume": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
\nWhen using a volume configured at launch, the name is required and must\n\t\t\talso be specified as the volume name in the ServiceVolumeConfiguration or\n\t\t\t\tTaskVolumeConfiguration parameter when creating your service or\n\t\t\tstandalone task.
For all other types of volumes, this name is referenced in the\n\t\t\t\tsourceVolume parameter of the mountPoints object in the\n\t\t\tcontainer definition.
When a volume is using the efsVolumeConfiguration, the name is\n\t\t\trequired.
This parameter is specified when you use bind mount host volumes. The contents of the\n\t\t\t\thost parameter determine whether your bind mount host volume persists\n\t\t\ton the host container instance and where it's stored. If the host parameter\n\t\t\tis empty, then the Docker daemon assigns a host path for your data volume. However, the\n\t\t\tdata isn't guaranteed to persist after the containers that are associated with it stop\n\t\t\trunning.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives. For example, you can mount\n\t\t\t\tC:\\my\\path:C:\\my\\path and D:\\:D:\\, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.
This parameter is specified when you use Docker volumes.
\nWindows containers only support the use of the local driver. To use bind\n\t\t\tmounts, specify the host parameter instead.
Docker volumes aren't supported by tasks run on Fargate.
\nThis parameter is specified when you use an Amazon Elastic File System file system for task\n\t\t\tstorage.
" + } + }, + "fsxWindowsFileServerVolumeConfiguration": { + "target": "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration", + "traits": { + "smithy.api#documentation": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
" + } + }, + "configuredAtLaunch": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether the volume should be configured at launch time. This is used to\n\t\t\tcreate Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each\n\t\t\ttask definition revision may only have one volume configured at launch in the volume\n\t\t\tconfiguration.
\nTo configure a volume at launch time, use this task definition revision and specify a\n\t\t\t\tvolumeConfigurations object when calling the\n\t\t\tCreateService, UpdateService, RunTask or\n\t\t\t\tStartTask APIs.
The data volume configuration for tasks launched using this task definition.\n\t\t\tSpecifying a volume configuration in a task definition is optional. The volume\n\t\t\tconfiguration may contain multiple volumes but only one volume configured at launch is\n\t\t\tsupported. Each volume defined in the volume configuration may only specify a\n\t\t\t\tname and one of either configuredAtLaunch,\n\t\t\t\tdockerVolumeConfiguration, efsVolumeConfiguration,\n\t\t\t\tfsxWindowsFileServerVolumeConfiguration, or host. If an\n\t\t\tempty volume configuration is specified, by default Amazon ECS uses a host volume. For more\n\t\t\tinformation, see Using data volumes in\n\t\t\t\ttasks.
The name of another container within the same task definition to mount volumes\n\t\t\tfrom.
" + } + }, + "readOnly": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "If this value is true, the container has read-only access to the volume.\n\t\t\tIf this value is false, then the container can write to the volume. The\n\t\t\tdefault value is false.
Details on a data volume from another container in the same task definition.
" + } }, - { - "target": "com.amazonaws.ecs#ServiceNotFoundException" + "com.amazonaws.ecs#VolumeFromList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#VolumeFrom" + } }, - { - "target": "com.amazonaws.ecs#TaskSetNotFoundException" + "com.amazonaws.ecs#VolumeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Volume" + } }, - { - "target": "com.amazonaws.ecs#UnsupportedFeatureException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies a task set. This is used when a service uses the EXTERNAL\n\t\t\tdeployment controller type. For more information, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The ARN of the IAM role to associate with this VPC Lattice configuration. This is the\n\t\t\tAmazon ECS\u2028 infrastructure IAM role that is used to manage your VPC Lattice\n\t\t\tinfrastructure.
", + "smithy.api#required": {} + } }, - "stabilityStatus": "STABILIZING", - "stabilityStatusAt": 1.557129279914e9 - } + "targetGroupArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice\n\t\t\tconfiguration that the Amazon ECS tasks will be registered to.
", + "smithy.api#required": {} + } + }, + "portName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the port mapping to register in the VPC Lattice target group. This is the name\n\t\t\tof the portMapping you defined in your task definition.
The VPC Lattice configuration for your service that holds the information for the target\n\t\t\tgroup(s) Amazon ECS tasks will be registered to.
" + } + }, + "com.amazonaws.ecs#VpcLatticeConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#VpcLatticeConfiguration" } - } - ] - } - }, - "com.amazonaws.ecs#UpdateTaskSetRequest": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset is found in.
", - "smithy.api#required": {} - } - }, - "service": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.
", - "smithy.api#required": {} - } - }, - "taskSet": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the task set to update.
", - "smithy.api#required": {} - } - }, - "scale": { - "target": "com.amazonaws.ecs#Scale", - "traits": { - "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ecs#UpdateTaskSetResponse": { - "type": "structure", - "members": { - "taskSet": { - "target": "com.amazonaws.ecs#TaskSet", - "traits": { - "smithy.api#documentation": "Details about the task set.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ecs#VersionConsistency": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - } - } - }, - "com.amazonaws.ecs#VersionInfo": { - "type": "structure", - "members": { - "agentVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The version number of the Amazon ECS container agent.
" - } - }, - "agentHash": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent\n\t\t\t GitHub repository.
" - } - }, - "dockerVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Docker version that's running on the container instance.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Docker and Amazon ECS container agent version information about a container\n\t\t\tinstance.
" - } - }, - "com.amazonaws.ecs#Volume": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
\nWhen using a volume configured at launch, the name is required and must\n\t\t\talso be specified as the volume name in the ServiceVolumeConfiguration or\n\t\t\t\tTaskVolumeConfiguration parameter when creating your service or\n\t\t\tstandalone task.
For all other types of volumes, this name is referenced in the\n\t\t\t\tsourceVolume parameter of the mountPoints object in the\n\t\t\tcontainer definition.
When a volume is using the efsVolumeConfiguration, the name is\n\t\t\trequired.
This parameter is specified when you use bind mount host volumes. The contents of the\n\t\t\t\thost parameter determine whether your bind mount host volume persists\n\t\t\ton the host container instance and where it's stored. If the host parameter\n\t\t\tis empty, then the Docker daemon assigns a host path for your data volume. However, the\n\t\t\tdata isn't guaranteed to persist after the containers that are associated with it stop\n\t\t\trunning.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives. For example, you can mount\n\t\t\t\tC:\\my\\path:C:\\my\\path and D:\\:D:\\, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.
This parameter is specified when you use Docker volumes.
\nWindows containers only support the use of the local driver. To use bind\n\t\t\tmounts, specify the host parameter instead.
Docker volumes aren't supported by tasks run on Fargate.
\nThis parameter is specified when you use an Amazon Elastic File System file system for task\n\t\t\tstorage.
" - } - }, - "fsxWindowsFileServerVolumeConfiguration": { - "target": "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration", - "traits": { - "smithy.api#documentation": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
" - } - }, - "configuredAtLaunch": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Indicates whether the volume should be configured at launch time. This is used to\n\t\t\tcreate Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each\n\t\t\ttask definition revision may only have one volume configured at launch in the volume\n\t\t\tconfiguration.
\nTo configure a volume at launch time, use this task definition revision and specify a\n\t\t\t\tvolumeConfigurations object when calling the\n\t\t\tCreateService, UpdateService, RunTask or\n\t\t\t\tStartTask APIs.
The data volume configuration for tasks launched using this task definition.\n\t\t\tSpecifying a volume configuration in a task definition is optional. The volume\n\t\t\tconfiguration may contain multiple volumes but only one volume configured at launch is\n\t\t\tsupported. Each volume defined in the volume configuration may only specify a\n\t\t\t\tname and one of either configuredAtLaunch,\n\t\t\t\tdockerVolumeConfiguration, efsVolumeConfiguration,\n\t\t\t\tfsxWindowsFileServerVolumeConfiguration, or host. If an\n\t\t\tempty volume configuration is specified, by default Amazon ECS uses a host volume. For more\n\t\t\tinformation, see Using data volumes in\n\t\t\t\ttasks.
The name of another container within the same task definition to mount volumes\n\t\t\tfrom.
" - } - }, - "readOnly": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "If this value is true, the container has read-only access to the volume.\n\t\t\tIf this value is false, then the container can write to the volume. The\n\t\t\tdefault value is false.
Details on a data volume from another container in the same task definition.
" - } - }, - "com.amazonaws.ecs#VolumeFromList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#VolumeFrom" - } - }, - "com.amazonaws.ecs#VolumeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Volume" - } - }, - "com.amazonaws.ecs#VpcLatticeConfiguration": { - "type": "structure", - "members": { - "roleArn": { - "target": "com.amazonaws.ecs#IAMRoleArn", - "traits": { - "smithy.api#documentation": "The ARN of the IAM role to associate with this VPC Lattice configuration. This is the\n\t\t\tAmazon ECS\u2028 infrastructure IAM role that is used to manage your VPC Lattice\n\t\t\tinfrastructure.
", - "smithy.api#required": {} - } - }, - "targetGroupArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice\n\t\t\tconfiguration that the Amazon ECS tasks will be registered to.
", - "smithy.api#required": {} - } - }, - "portName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The name of the port mapping to register in the VPC Lattice target group. This is the name\n\t\t\tof the portMapping you defined in your task definition.
The VPC Lattice configuration for your service that holds the information for the target\n\t\t\tgroup(s) Amazon ECS tasks will be registered to.
" - } - }, - "com.amazonaws.ecs#VpcLatticeConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#VpcLatticeConfiguration" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 520baa083cd4..fffed8fa9b48 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -1,76010 +1,76030 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.sagemaker#Accept": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#AcceptEula": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#AccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^\\d+$" - } - }, - "com.amazonaws.sagemaker#ActionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/" - } - }, - "com.amazonaws.sagemaker#ActionSource": { - "type": "structure", - "members": { - "SourceUri": { - "target": "com.amazonaws.sagemaker#SourceUri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The URI of the source.
", - "smithy.api#required": {} - } - }, - "SourceType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The type of the source.
" - } - }, - "SourceId": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The ID of the source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure describing the source of an action.
" - } - }, - "com.amazonaws.sagemaker#ActionStatus": { - "type": "enum", - "members": { - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unknown" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#ActionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ActionSummary" - } - }, - "com.amazonaws.sagemaker#ActionSummary": { - "type": "structure", - "members": { - "ActionArn": { - "target": "com.amazonaws.sagemaker#ActionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" - } - }, - "ActionName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the action.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ActionSource", - "traits": { - "smithy.api#documentation": "The source of the action.
" - } - }, - "ActionType": { - "target": "com.amazonaws.sagemaker#String64", - "traits": { - "smithy.api#documentation": "The type of the action.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#ActionStatus", - "traits": { - "smithy.api#documentation": "The status of the action.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the action was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the action was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Lists the properties of an action. An action represents an action\n or activity. Some examples are a workflow step and a model deployment. Generally, an\n action involves at least one input artifact or output artifact.
" - } - }, - "com.amazonaws.sagemaker#ActivationState": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - } - } - }, - "com.amazonaws.sagemaker#AddAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#AddAssociationRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#AddAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Creates an association between the source and the destination. A\n source can be associated with multiple destinations, and a destination can be associated\n with multiple sources. An association is a lineage tracking entity. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" - } - }, - "com.amazonaws.sagemaker#AddAssociationRequest": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the source.
", - "smithy.api#required": {} - } - }, - "DestinationArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
", - "smithy.api#required": {} - } - }, - "AssociationType": { - "target": "com.amazonaws.sagemaker#AssociationEdgeType", - "traits": { - "smithy.api#documentation": "The type of association. The following are suggested uses for each type. Amazon SageMaker\n places no restrictions on their use.
\nContributedTo - The source contributed to the destination or had a part in\n enabling the destination. For example, the training data contributed to the training\n job.
\nAssociatedWith - The source is connected to the destination. For example, an\n approval workflow is associated with a model deployment.
\nDerivedFrom - The destination is a modification of the source. For example, a digest\n output of a channel input for a processing job is derived from the original inputs.
\nProduced - The source generated the destination. For example, a training job\n produced a model artifact.
\nThe ARN of the source.
" - } - }, - "DestinationArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#AddTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#AddTagsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#AddTagsOutput" - }, - "traits": { - "smithy.api#documentation": "Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.
\nEach tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.
\nTags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n
Tags that you add to a SageMaker Domain or User Profile by calling this API are\n also added to any Apps that the Domain or User Profile launches after you call this\n API, but not to Apps that the Domain or User Profile launched before you called this\n API. To make sure that the tags associated with a Domain or User Profile are also\n added to all Apps that the Domain or User Profile launches, add the tags when you\n first create the Domain or User Profile by specifying them in the Tags\n parameter of CreateDomain\n or CreateUserProfile.
The Amazon Resource Name (ARN) of the resource that you want to tag.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#AddTagsOutput": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags associated with the SageMaker resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.sagemaker#AdditionalInferenceSpecificationDefinition": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique name to identify the additional inference specification. The name must \n be unique within the list of your additional inference specifications for a \n particular model package.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A description of the additional Inference specification
" - } - }, - "Containers": { - "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon ECR registry path of the Docker image that contains the inference code.
", - "smithy.api#required": {} - } - }, - "SupportedTransformInstanceTypes": { - "target": "com.amazonaws.sagemaker#TransformInstanceTypes", - "traits": { - "smithy.api#documentation": "A list of the instance types on which a transformation job can be run \n or on which an endpoint can be deployed.
" - } - }, - "SupportedRealtimeInferenceInstanceTypes": { - "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", - "traits": { - "smithy.api#documentation": "A list of the instance types that are used to generate inferences in real-time.
" - } - }, - "SupportedContentTypes": { - "target": "com.amazonaws.sagemaker#ContentTypes", - "traits": { - "smithy.api#documentation": "The supported MIME types for the input data.
" - } - }, - "SupportedResponseMIMETypes": { - "target": "com.amazonaws.sagemaker#ResponseMIMETypes", - "traits": { - "smithy.api#documentation": "The supported MIME types for the output data.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure of additional Inference Specification. Additional Inference Specification \n specifies details about inference jobs that can be run with models based on\n this model package
" - } - }, - "com.amazonaws.sagemaker#AdditionalInferenceSpecifications": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecificationDefinition" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 15 - } - } - }, - "com.amazonaws.sagemaker#AdditionalModelChannelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$" - } - }, - "com.amazonaws.sagemaker#AdditionalModelDataSource": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.sagemaker#AdditionalModelChannelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A custom name for this AdditionalModelDataSource object.
Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.
The data type of the additional data source that you specify for use in inference or\n training.
", - "smithy.api#required": {} - } - }, - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The uniform resource identifier (URI) used to identify an additional data source used\n in inference or training.
", - "smithy.api#required": {} - } - }, - "CompressionType": { - "target": "com.amazonaws.sagemaker#CompressionType", - "traits": { - "smithy.api#documentation": "The type of compression used for an additional data source used in inference or\n training. Specify None if your additional data source is not\n compressed.
The ETag associated with S3 URI.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A data source used for training or inference that is in addition to the input dataset\n or model data.
" - } - }, - "com.amazonaws.sagemaker#AdditionalS3DataSourceDataType": { - "type": "enum", - "members": { - "S3OBJECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3Object" - } - }, - "S3PREFIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3Prefix" - } - } - } - }, - "com.amazonaws.sagemaker#AgentVersion": { - "type": "structure", - "members": { - "Version": { - "target": "com.amazonaws.sagemaker#EdgeVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Version of the agent.
", - "smithy.api#required": {} - } - }, - "AgentCount": { - "target": "com.amazonaws.sagemaker#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of Edge Manager agents.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Edge Manager agent version.
" - } - }, - "com.amazonaws.sagemaker#AgentVersions": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AgentVersion" - } - }, - "com.amazonaws.sagemaker#AggregationTransformationValue": { - "type": "enum", - "members": { - "Sum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sum" - } - }, - "Avg": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "avg" - } - }, - "First": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "first" - } - }, - "Min": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "min" - } - }, - "Max": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "max" - } - } - } - }, - "com.amazonaws.sagemaker#AggregationTransformations": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#TransformationAttributeName" - }, - "value": { - "target": "com.amazonaws.sagemaker#AggregationTransformationValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#Alarm": { - "type": "structure", - "members": { - "AlarmName": { - "target": "com.amazonaws.sagemaker#AlarmName", - "traits": { - "smithy.api#documentation": "The name of a CloudWatch alarm in your account.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
" - } - }, - "com.amazonaws.sagemaker#AlarmList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Alarm" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#AlarmName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^(?!\\s*$).+$" - } - }, - "com.amazonaws.sagemaker#AlgorithmArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}$" - } - }, - "com.amazonaws.sagemaker#AlgorithmImage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#AlgorithmSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#AlgorithmSpecification": { - "type": "structure", - "members": { - "TrainingImage": { - "target": "com.amazonaws.sagemaker#AlgorithmImage", - "traits": { - "smithy.api#documentation": "The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry\n Paths and Example Code in the Amazon SageMaker developer guide.\n SageMaker supports both registry/repository[:tag] and\n registry/repository[@digest] image path formats. For more information\n about using your custom training container, see Using Your Own Algorithms with\n Amazon SageMaker.
You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.
For more information, see the note in the AlgorithmName parameter\n description.
The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services\n Marketplace.
\nYou must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.
Note that the AlgorithmName parameter is mutually exclusive with the\n TrainingImage parameter. If you specify a value for the\n AlgorithmName parameter, you can't specify a value for\n TrainingImage, and vice versa.
If you specify values for both parameters, the training job might break; if you\n don't specify any value for both parameters, the training job might raise a\n null error.
A list of metric definition objects. Each object specifies the metric name and regular\n expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.
" - } - }, - "EnableSageMakerMetricsTimeSeries": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:
You use one of the SageMaker built-in algorithms
\nYou use one of the following Prebuilt SageMaker Docker Images:
\nTensorflow (version >= 1.15)
\nMXNet (version >= 1.6)
\nPyTorch (version >= 1.3)
\nYou specify at least one MetricDefinition\n
\nThe entrypoint script\n for a Docker container used to run a training job. This script takes\n precedence over the default train processing instructions. See How Amazon SageMaker\n Runs Your Training Image for more information.
" - } - }, - "ContainerArguments": { - "target": "com.amazonaws.sagemaker#TrainingContainerArguments", - "traits": { - "smithy.api#documentation": "The arguments for a container used to run a training job. See How Amazon SageMaker\n Runs Your Training Image for additional information.
" - } - }, - "TrainingImageConfig": { - "target": "com.amazonaws.sagemaker#TrainingImageConfig", - "traits": { - "smithy.api#documentation": "The configuration to use an image from a private Docker registry for a training\n job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the training algorithm to use in a CreateTrainingJob request.
\nSageMaker uses its own SageMaker account credentials to pull and access built-in algorithms\n so built-in algorithms are universally accessible across all Amazon Web Services accounts. As a\n result, built-in algorithms have standard, unrestricted access. You cannot restrict\n built-in algorithms using IAM roles. Use custom algorithms if you require specific\n access controls.
\nFor more information about algorithms provided by SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.
" - } - }, - "com.amazonaws.sagemaker#AlgorithmStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.sagemaker#AlgorithmStatusDetails": { - "type": "structure", - "members": { - "ValidationStatuses": { - "target": "com.amazonaws.sagemaker#AlgorithmStatusItemList", - "traits": { - "smithy.api#documentation": "The status of algorithm validation.
" - } - }, - "ImageScanStatuses": { - "target": "com.amazonaws.sagemaker#AlgorithmStatusItemList", - "traits": { - "smithy.api#documentation": "The status of the scan of the algorithm's Docker image container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the validation and image scan statuses of the algorithm.
" - } - }, - "com.amazonaws.sagemaker#AlgorithmStatusItem": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the algorithm for which the overall status is being reported.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#DetailedAlgorithmStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "if the overall status is Failed, the reason for the failure.
Represents the overall status of an algorithm.
" - } - }, - "com.amazonaws.sagemaker#AlgorithmStatusItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AlgorithmStatusItem" - } - }, - "com.amazonaws.sagemaker#AlgorithmSummary": { - "type": "structure", - "members": { - "AlgorithmName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the algorithm that is described by the summary.
", - "smithy.api#required": {} - } - }, - "AlgorithmArn": { - "target": "com.amazonaws.sagemaker#AlgorithmArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the algorithm.
", - "smithy.api#required": {} - } - }, - "AlgorithmDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A brief description of the algorithm.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the algorithm was created.
", - "smithy.api#required": {} - } - }, - "AlgorithmStatus": { - "target": "com.amazonaws.sagemaker#AlgorithmStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The overall status of the algorithm.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Provides summary information about an algorithm.
" - } - }, - "com.amazonaws.sagemaker#AlgorithmSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AlgorithmSummary" - } - }, - "com.amazonaws.sagemaker#AlgorithmValidationProfile": { - "type": "structure", - "members": { - "ProfileName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the profile for the algorithm. The name must have 1 to 63 characters.\n Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", - "smithy.api#required": {} - } - }, - "TrainingJobDefinition": { - "target": "com.amazonaws.sagemaker#TrainingJobDefinition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The TrainingJobDefinition object that describes the training job that\n SageMaker runs to validate your algorithm.
The TransformJobDefinition object that describes the transform job that\n SageMaker runs to validate your algorithm.
Defines a training job and a batch transform job that SageMaker runs to validate your\n algorithm.
\nThe data provided in the validation profile is made available to your buyers on\n Amazon Web Services Marketplace.
" - } - }, - "com.amazonaws.sagemaker#AlgorithmValidationProfiles": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AlgorithmValidationProfile" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#AlgorithmValidationSpecification": { - "type": "structure", - "members": { - "ValidationRole": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IAM roles that SageMaker uses to run the training jobs.
", - "smithy.api#required": {} - } - }, - "ValidationProfiles": { - "target": "com.amazonaws.sagemaker#AlgorithmValidationProfiles", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of AlgorithmValidationProfile objects, each of which specifies a\n training job and batch transform job that SageMaker runs to validate your algorithm.
Specifies configurations for one or more training jobs that SageMaker runs to test the\n algorithm.
" - } - }, - "com.amazonaws.sagemaker#AmazonQSettings": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#FeatureStatus", - "traits": { - "smithy.api#documentation": "Whether Amazon Q has been enabled within the domain.
" - } - }, - "QProfileArn": { - "target": "com.amazonaws.sagemaker#QProfileArn", - "traits": { - "smithy.api#documentation": "The ARN of the Amazon Q profile used within the domain.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain.
" - } - }, - "com.amazonaws.sagemaker#AnnotationConsolidationConfig": { - "type": "structure", - "members": { - "AnnotationConsolidationLambdaArn": { - "target": "com.amazonaws.sagemaker#LambdaFunctionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.
\nFor built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.
\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox\n
\n Image classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass\n
\n Multi-label image classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel\n
\n Semantic segmentation - Treats each pixel in an image\n as a multi-class classification and treats pixel annotations from workers as \"votes\" for\n the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation\n
\n Text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of text based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass\n
\n Multi-label text classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel\n
\n Named entity recognition - Groups similar selections\n and calculates aggregate boundaries, resolving to most-assigned label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition\n
\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass\n
\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection\n
\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking\n
\n 3D Point Cloud Object Detection - Use this task type\n when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids\n around objects. For example, you can use this task type to ask workers to identify\n different types of objects in a point cloud, such as cars, bikes, and\n pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection\n
\n 3D Point Cloud Object Tracking - Use this task type\n when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D\n point cloud frames. For example, you can use this task type to ask workers to track the\n movement of vehicles across multiple point cloud frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking\n
\n 3D Point Cloud Semantic Segmentation - Use this task\n type when you want workers to create a point-level semantic segmentation masks by\n painting objects in a 3D point cloud using different colors where each color is assigned\n to one of the classes you specify.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation\n
\n Use the following ARNs for Label Verification and Adjustment Jobs\n
\nUse label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .
\n\n Semantic Segmentation Adjustment - Treats each pixel\n in an image as a multi-class classification and treats pixel adjusted annotations from\n workers as \"votes\" for the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation\n
\n Semantic Segmentation Verification - Uses a variant\n of the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation\n
\n Bounding Box Adjustment - Finds the most similar\n boxes from different workers based on the Jaccard index of the adjusted\n annotations.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox\n
\n Bounding Box Verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification judgement\n for bounding box labels based on annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox\n
\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection\n
\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking\n
\n 3D Point Cloud Object Detection Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n 3D Point Cloud Object Tracking Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects that appear in a\n sequence of 3D point cloud frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n 3D Point Cloud Semantic Segmentation Adjustment - Use this task\n type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
Configures how labels are consolidated across human workers and processes output data.
" - } - }, - "com.amazonaws.sagemaker#AppArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/" - } - }, - "com.amazonaws.sagemaker#AppDetails": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "The domain ID.
" - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "The user profile name.
" - } - }, - "SpaceName": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#documentation": "The name of the space.
" - } - }, - "AppType": { - "target": "com.amazonaws.sagemaker#AppType", - "traits": { - "smithy.api#documentation": "The type of app.
" - } - }, - "AppName": { - "target": "com.amazonaws.sagemaker#AppName", - "traits": { - "smithy.api#documentation": "The name of the app.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#AppStatus", - "traits": { - "smithy.api#documentation": "The status.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "The creation time.
" - } - }, - "ResourceSpec": { - "target": "com.amazonaws.sagemaker#ResourceSpec" - } - }, - "traits": { - "smithy.api#documentation": "Details about an Amazon SageMaker AI app.
" - } - }, - "com.amazonaws.sagemaker#AppImageConfigArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/" - } - }, - "com.amazonaws.sagemaker#AppImageConfigDetails": { - "type": "structure", - "members": { - "AppImageConfigArn": { - "target": "com.amazonaws.sagemaker#AppImageConfigArn", - "traits": { - "smithy.api#documentation": "The ARN of the AppImageConfig.
" - } - }, - "AppImageConfigName": { - "target": "com.amazonaws.sagemaker#AppImageConfigName", - "traits": { - "smithy.api#documentation": "The name of the AppImageConfig. Must be unique to your account.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the AppImageConfig was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the AppImageConfig was last modified.
" - } - }, - "KernelGatewayImageConfig": { - "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", - "traits": { - "smithy.api#documentation": "The configuration for the file system and kernels in the SageMaker AI image.
" - } - }, - "JupyterLabAppImageConfig": { - "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", - "traits": { - "smithy.api#documentation": "The configuration for the file system and the runtime, such as the environment variables and entry point.
" - } - }, - "CodeEditorAppImageConfig": { - "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", - "traits": { - "smithy.api#documentation": "The configuration for the file system and the runtime, \n such as the environment variables and entry point.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for running a SageMaker AI image as a KernelGateway app.
" - } - }, - "com.amazonaws.sagemaker#AppImageConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AppImageConfigDetails" - } - }, - "com.amazonaws.sagemaker#AppImageConfigName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#AppImageConfigSortKey": { - "type": "enum", - "members": { - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "LastModifiedTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastModifiedTime" - } - }, - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.sagemaker#AppInstanceType": { - "type": "enum", - "members": { - "SYSTEM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "system" - } - }, - "ML_T3_MICRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.micro" - } - }, - "ML_T3_SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.small" - } - }, - "ML_T3_MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.medium" - } - }, - "ML_T3_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.large" - } - }, - "ML_T3_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.xlarge" - } - }, - "ML_T3_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.2xlarge" - } - }, - "ML_M5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.large" - } - }, - "ML_M5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.xlarge" - } - }, - "ML_M5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.2xlarge" - } - }, - "ML_M5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.4xlarge" - } - }, - "ML_M5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.8xlarge" - } - }, - "ML_M5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.12xlarge" - } - }, - "ML_M5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.16xlarge" - } - }, - "ML_M5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.24xlarge" - } - }, - "ML_M5D_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.large" - } - }, - "ML_M5D_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.xlarge" - } - }, - "ML_M5D_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.2xlarge" - } - }, - "ML_M5D_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.4xlarge" - } - }, - "ML_M5D_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.8xlarge" - } - }, - "ML_M5D_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.12xlarge" - } - }, - "ML_M5D_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.16xlarge" - } - }, - "ML_M5D_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.24xlarge" - } - }, - "ML_C5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.large" - } - }, - "ML_C5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.xlarge" - } - }, - "ML_C5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.2xlarge" - } - }, - "ML_C5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.4xlarge" - } - }, - "ML_C5_9XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.9xlarge" - } - }, - "ML_C5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.12xlarge" - } - }, - "ML_C5_18XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.18xlarge" - } - }, - "ML_C5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.24xlarge" - } - }, - "ML_P3_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.2xlarge" - } - }, - "ML_P3_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.8xlarge" - } - }, - "ML_P3_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.16xlarge" - } - }, - "ML_P3DN_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3dn.24xlarge" - } - }, - "ML_G4DN_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.xlarge" - } - }, - "ML_G4DN_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.2xlarge" - } - }, - "ML_G4DN_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.4xlarge" - } - }, - "ML_G4DN_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.8xlarge" - } - }, - "ML_G4DN_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.12xlarge" - } - }, - "ML_G4DN_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.16xlarge" - } - }, - "ML_R5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.large" - } - }, - "ML_R5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.xlarge" - } - }, - "ML_R5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.2xlarge" - } - }, - "ML_R5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.4xlarge" - } - }, - "ML_R5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.8xlarge" - } - }, - "ML_R5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.12xlarge" - } - }, - "ML_R5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.16xlarge" - } - }, - "ML_R5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.24xlarge" - } - }, - "ML_G5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.xlarge" - } - }, - "ML_G5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.2xlarge" - } - }, - "ML_G5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.4xlarge" - } - }, - "ML_G5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.8xlarge" - } - }, - "ML_G5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.16xlarge" - } - }, - "ML_G5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.12xlarge" - } - }, - "ML_G5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.24xlarge" - } - }, - "ML_G5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.48xlarge" - } - }, - "ML_G6_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.xlarge" - } - }, - "ML_G6_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.2xlarge" - } - }, - "ML_G6_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.4xlarge" - } - }, - "ML_G6_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.8xlarge" - } - }, - "ML_G6_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.12xlarge" - } - }, - "ML_G6_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.16xlarge" - } - }, - "ML_G6_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.24xlarge" - } - }, - "ML_G6_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.48xlarge" - } - }, - "ML_G6E_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.xlarge" - } - }, - "ML_G6E_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.2xlarge" - } - }, - "ML_G6E_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.4xlarge" - } - }, - "ML_G6E_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.8xlarge" - } - }, - "ML_G6E_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.12xlarge" - } - }, - "ML_G6E_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.16xlarge" - } - }, - "ML_G6E_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.24xlarge" - } - }, - "ML_G6E_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.48xlarge" - } - }, - "ML_GEOSPATIAL_INTERACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.geospatial.interactive" - } - }, - "ML_P4D_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4d.24xlarge" - } - }, - "ML_P4DE_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4de.24xlarge" - } - }, - "ML_TRN1_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.2xlarge" - } - }, - "ML_TRN1_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.32xlarge" - } - }, - "ML_TRN1N_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1n.32xlarge" - } - }, - "ML_P5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p5.48xlarge" - } - }, - "ML_M6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.large" - } - }, - "ML_M6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.xlarge" - } - }, - "ML_M6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.2xlarge" - } - }, - "ML_M6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.4xlarge" - } - }, - "ML_M6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.8xlarge" - } - }, - "ML_M6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.12xlarge" - } - }, - "ML_M6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.16xlarge" - } - }, - "ML_M6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.24xlarge" - } - }, - "ML_M6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.32xlarge" - } - }, - "ML_M7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.large" - } - }, - "ML_M7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.xlarge" - } - }, - "ML_M7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.2xlarge" - } - }, - "ML_M7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.4xlarge" - } - }, - "ML_M7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.8xlarge" - } - }, - "ML_M7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.12xlarge" - } - }, - "ML_M7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.16xlarge" - } - }, - "ML_M7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.24xlarge" - } - }, - "ML_M7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.48xlarge" - } - }, - "ML_C6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.large" - } - }, - "ML_C6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.xlarge" - } - }, - "ML_C6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.2xlarge" - } - }, - "ML_C6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.4xlarge" - } - }, - "ML_C6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.8xlarge" - } - }, - "ML_C6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.12xlarge" - } - }, - "ML_C6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.16xlarge" - } - }, - "ML_C6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.24xlarge" - } - }, - "ML_C6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.32xlarge" - } - }, - "ML_C7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.large" - } - }, - "ML_C7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.xlarge" - } - }, - "ML_C7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.2xlarge" - } - }, - "ML_C7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.4xlarge" - } - }, - "ML_C7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.8xlarge" - } - }, - "ML_C7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.12xlarge" - } - }, - "ML_C7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.16xlarge" - } - }, - "ML_C7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.24xlarge" - } - }, - "ML_C7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.48xlarge" - } - }, - "ML_R6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.large" - } - }, - "ML_R6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.xlarge" - } - }, - "ML_R6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.2xlarge" - } - }, - "ML_R6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.4xlarge" - } - }, - "ML_R6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.8xlarge" - } - }, - "ML_R6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.12xlarge" - } - }, - "ML_R6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.16xlarge" - } - }, - "ML_R6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.24xlarge" - } - }, - "ML_R6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.32xlarge" - } - }, - "ML_R7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.large" - } - }, - "ML_R7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.xlarge" - } - }, - "ML_R7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.2xlarge" - } - }, - "ML_R7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.4xlarge" - } - }, - "ML_R7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.8xlarge" - } - }, - "ML_R7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.12xlarge" - } - }, - "ML_R7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.16xlarge" - } - }, - "ML_R7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.24xlarge" - } - }, - "ML_R7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.48xlarge" - } - }, - "ML_M6ID_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.large" - } - }, - "ML_M6ID_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.xlarge" - } - }, - "ML_M6ID_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.2xlarge" - } - }, - "ML_M6ID_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.4xlarge" - } - }, - "ML_M6ID_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.8xlarge" - } - }, - "ML_M6ID_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.12xlarge" - } - }, - "ML_M6ID_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.16xlarge" - } - }, - "ML_M6ID_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.24xlarge" - } - }, - "ML_M6ID_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.32xlarge" - } - }, - "ML_C6ID_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.large" - } - }, - "ML_C6ID_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.xlarge" - } - }, - "ML_C6ID_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.2xlarge" - } - }, - "ML_C6ID_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.4xlarge" - } - }, - "ML_C6ID_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.8xlarge" - } - }, - "ML_C6ID_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.12xlarge" - } - }, - "ML_C6ID_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.16xlarge" - } - }, - "ML_C6ID_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.24xlarge" - } - }, - "ML_C6ID_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.32xlarge" - } - }, - "ML_R6ID_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.large" - } - }, - "ML_R6ID_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.xlarge" - } - }, - "ML_R6ID_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.2xlarge" - } - }, - "ML_R6ID_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.4xlarge" - } - }, - "ML_R6ID_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.8xlarge" - } - }, - "ML_R6ID_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.12xlarge" - } - }, - "ML_R6ID_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.16xlarge" - } - }, - "ML_R6ID_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.24xlarge" - } - }, - "ML_R6ID_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.32xlarge" - } - } - } - }, - "com.amazonaws.sagemaker#AppLifecycleManagement": { - "type": "structure", - "members": { - "IdleSettings": { - "target": "com.amazonaws.sagemaker#IdleSettings", - "traits": { - "smithy.api#documentation": "Settings related to idle shutdown of Studio applications.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications.
" - } - }, - "com.amazonaws.sagemaker#AppList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AppDetails" - } - }, - "com.amazonaws.sagemaker#AppManaged": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#AppName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#AppNetworkAccessType": { - "type": "enum", - "members": { - "PublicInternetOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PublicInternetOnly" - } - }, - "VpcOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VpcOnly" - } - } - } - }, - "com.amazonaws.sagemaker#AppSecurityGroupManagement": { - "type": "enum", - "members": { - "Service": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Service" - } - }, - "Customer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Customer" - } - } - } - }, - "com.amazonaws.sagemaker#AppSortKey": { - "type": "enum", - "members": { - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#AppSpecification": { - "type": "structure", - "members": { - "ImageUri": { - "target": "com.amazonaws.sagemaker#ImageUri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The container image to be run by the processing job.
", - "smithy.api#required": {} - } - }, - "ContainerEntrypoint": { - "target": "com.amazonaws.sagemaker#ContainerEntrypoint", - "traits": { - "smithy.api#documentation": "The entrypoint for a container used to run a processing job.
" - } - }, - "ContainerArguments": { - "target": "com.amazonaws.sagemaker#ContainerArguments", - "traits": { - "smithy.api#documentation": "The arguments for a container used to run a processing job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration to run a processing job in a specified container image.
" - } - }, - "com.amazonaws.sagemaker#AppStatus": { - "type": "enum", - "members": { - "Deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleted" - } - }, - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "InService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - } - } - }, - "com.amazonaws.sagemaker#AppType": { - "type": "enum", - "members": { - "JupyterServer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JupyterServer" - } - }, - "KernelGateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KernelGateway" - } - }, - "DetailedProfiler": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DetailedProfiler" - } - }, - "TensorBoard": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TensorBoard" - } - }, - "CodeEditor": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CodeEditor" - } - }, - "JupyterLab": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JupyterLab" - } - }, - "RStudioServerPro": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RStudioServerPro" - } - }, - "RSessionGateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RSessionGateway" - } - }, - "Canvas": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Canvas" - } - } - } - }, - "com.amazonaws.sagemaker#ApprovalDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ArnOrName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 170 - }, - "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The URI of the source.", - "smithy.api#required": {} - } - }, - "SourceTypes": { - "target": "com.amazonaws.sagemaker#ArtifactSourceTypes", - "traits": { - "smithy.api#documentation": "A list of source types.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure describing the source of an artifact.
" - } - }, - "com.amazonaws.sagemaker#ArtifactSourceIdType": { - "type": "enum", - "members": { - "MD5_HASH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MD5Hash" - } - }, - "S3_ETAG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3ETag" - } - }, - "S3_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3Version" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Custom" - } - } - } - }, - "com.amazonaws.sagemaker#ArtifactSourceType": { - "type": "structure", - "members": { - "SourceIdType": { - "target": "com.amazonaws.sagemaker#ArtifactSourceIdType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of ID.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The ID and ID type of an artifact source.
" - } - }, - "com.amazonaws.sagemaker#ArtifactSourceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ArtifactSourceType" - } - }, - "com.amazonaws.sagemaker#ArtifactSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ArtifactSummary" - } - }, - "com.amazonaws.sagemaker#ArtifactSummary": { - "type": "structure", - "members": { - "ArtifactArn": { - "target": "com.amazonaws.sagemaker#ArtifactArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" - } - }, - "ArtifactName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the artifact.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ArtifactSource", - "traits": { - "smithy.api#documentation": "The source of the artifact.
" - } - }, - "ArtifactType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The type of the artifact.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the artifact was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the artifact was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Lists a summary of the properties of an artifact. An artifact represents a URI\n addressable object or data. Some examples are a dataset and a model.
" - } - }, - "com.amazonaws.sagemaker#AssemblyType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - }, - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Line" - } - } - } - }, - "com.amazonaws.sagemaker#AssociateTrialComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#AssociateTrialComponentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#AssociateTrialComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Associates a trial component with a trial. A trial component can be associated with\n multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
" - } - }, - "com.amazonaws.sagemaker#AssociateTrialComponentRequest": { - "type": "structure", - "members": { - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the component to associated with the trial.
", - "smithy.api#required": {} - } - }, - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the trial to associate with.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#AssociateTrialComponentResponse": { - "type": "structure", - "members": { - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" - } - }, - "TrialArn": { - "target": "com.amazonaws.sagemaker#TrialArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#AssociationEdgeType": { - "type": "enum", - "members": { - "CONTRIBUTED_TO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ContributedTo" - } - }, - "ASSOCIATED_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AssociatedWith" - } - }, - "DERIVED_FROM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DerivedFrom" - } - }, - "PRODUCED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Produced" - } - }, - "SAME_AS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SameAs" - } - } - } - }, - "com.amazonaws.sagemaker#AssociationEntityArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/" - } - }, - "com.amazonaws.sagemaker#AssociationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AssociationSummary" - } - }, - "com.amazonaws.sagemaker#AssociationSummary": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#documentation": "The ARN of the source.
" - } - }, - "DestinationArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
" - } - }, - "SourceType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The source type.
" - } - }, - "DestinationType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The destination type.
" - } - }, - "AssociationType": { - "target": "com.amazonaws.sagemaker#AssociationEdgeType", - "traits": { - "smithy.api#documentation": "The type of the association.
" - } - }, - "SourceName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the source.
" - } - }, - "DestinationName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the destination.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the association was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - } - }, - "traits": { - "smithy.api#documentation": "Lists a summary of the properties of an association. An association is an entity that\n links other lineage or experiment entities. An example would be an association between a\n training job and a model.
" - } - }, - "com.amazonaws.sagemaker#AssumableRoleArns": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#RoleArn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#AsyncInferenceClientConfig": { - "type": "structure", - "members": { - "MaxConcurrentInvocationsPerInstance": { - "target": "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance", - "traits": { - "smithy.api#documentation": "The maximum number of concurrent requests sent by the SageMaker client to the model\n container. If no value is provided, SageMaker chooses an optimal value.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.
" - } - }, - "com.amazonaws.sagemaker#AsyncInferenceConfig": { - "type": "structure", - "members": { - "ClientConfig": { - "target": "com.amazonaws.sagemaker#AsyncInferenceClientConfig", - "traits": { - "smithy.api#documentation": "Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.
" - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#AsyncInferenceOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the configuration for asynchronous inference invocation outputs.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies configuration for how an endpoint performs asynchronous inference.
" - } - }, - "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig": { - "type": "structure", - "members": { - "SuccessTopic": { - "target": "com.amazonaws.sagemaker#SnsTopicArn", - "traits": { - "smithy.api#documentation": "Amazon SNS topic to post a notification to when inference completes successfully. If no\n topic is provided, no notification is sent on success.
" - } - }, - "ErrorTopic": { - "target": "com.amazonaws.sagemaker#SnsTopicArn", - "traits": { - "smithy.api#documentation": "Amazon SNS topic to post a notification to when inference fails. If no topic is provided,\n no notification is sent on failure.
" - } - }, - "IncludeInferenceResponseIn": { - "target": "com.amazonaws.sagemaker#AsyncNotificationTopicTypeList", - "traits": { - "smithy.api#documentation": "The Amazon SNS topics where you want the inference response to be included.
\nThe inference response is included only if the response size is less than or equal\n to 128 KB.
\nSpecifies the configuration for notifications of inference results for asynchronous\n inference.
" - } - }, - "com.amazonaws.sagemaker#AsyncInferenceOutputConfig": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the asynchronous inference output in Amazon S3.
\n " - } - }, - "S3OutputPath": { - "target": "com.amazonaws.sagemaker#DestinationS3Uri", - "traits": { - "smithy.api#documentation": "The Amazon S3 location to upload inference responses to.
" - } - }, - "NotificationConfig": { - "target": "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig", - "traits": { - "smithy.api#documentation": "Specifies the configuration for notifications of inference results for asynchronous\n inference.
" - } - }, - "S3FailurePath": { - "target": "com.amazonaws.sagemaker#DestinationS3Uri", - "traits": { - "smithy.api#documentation": "The Amazon S3 location to upload failure inference responses to.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the configuration for asynchronous inference invocation outputs.
" - } - }, - "com.amazonaws.sagemaker#AsyncNotificationTopicTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AsyncNotificationTopicTypes" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.sagemaker#AsyncNotificationTopicTypes": { - "type": "enum", - "members": { - "SUCCESS_NOTIFICATION_TOPIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS_NOTIFICATION_TOPIC" - } - }, - "ERROR_NOTIFICATION_TOPIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR_NOTIFICATION_TOPIC" - } - } - } - }, - "com.amazonaws.sagemaker#AthenaCatalog": { - "type": "string", - "traits": { - "smithy.api#documentation": "The name of the data catalog used in Athena query execution.
", - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" - } - }, - "com.amazonaws.sagemaker#AthenaDatabase": { - "type": "string", - "traits": { - "smithy.api#documentation": "The name of the database used in the Athena query execution.
", - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#AthenaDatasetDefinition": { - "type": "structure", - "members": { - "Catalog": { - "target": "com.amazonaws.sagemaker#AthenaCatalog", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.sagemaker#AthenaDatabase", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "QueryString": { - "target": "com.amazonaws.sagemaker#AthenaQueryString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "WorkGroup": { - "target": "com.amazonaws.sagemaker#AthenaWorkGroup" - }, - "OutputS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location in Amazon S3 where Athena query results are stored.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from\n an Athena query execution.
" - } - }, - "OutputFormat": { - "target": "com.amazonaws.sagemaker#AthenaResultFormat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "OutputCompression": { - "target": "com.amazonaws.sagemaker#AthenaResultCompressionType" - } - }, - "traits": { - "smithy.api#documentation": "Configuration for Athena Dataset Definition input.
" - } - }, - "com.amazonaws.sagemaker#AthenaQueryString": { - "type": "string", - "traits": { - "smithy.api#documentation": "The SQL query statements, to be executed.
", - "smithy.api#length": { - "min": 1, - "max": 4096 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.sagemaker#AthenaResultCompressionType": { - "type": "enum", - "members": { - "GZIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GZIP" - } - }, - "SNAPPY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNAPPY" - } - }, - "ZLIB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ZLIB" - } - } - }, - "traits": { - "smithy.api#documentation": "The compression used for Athena query results.
" - } - }, - "com.amazonaws.sagemaker#AthenaResultFormat": { - "type": "enum", - "members": { - "PARQUET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARQUET" - } - }, - "ORC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ORC" - } - }, - "AVRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVRO" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - }, - "TEXTFILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXTFILE" - } - } - }, - "traits": { - "smithy.api#documentation": "The data storage format for Athena query results.
" - } - }, - "com.amazonaws.sagemaker#AthenaWorkGroup": { - "type": "string", - "traits": { - "smithy.api#documentation": "The name of the workgroup in which the Athena query is being started.
", - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" - } - }, - "com.amazonaws.sagemaker#AttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.sagemaker#AttributeNames": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AttributeName" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 16 - } - } - }, - "com.amazonaws.sagemaker#AuthMode": { - "type": "enum", - "members": { - "SSO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSO" - } - }, - "IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM" - } - } - } - }, - "com.amazonaws.sagemaker#AuthenticationRequestExtraParams": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#AutoGenerateEndpointName": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#AutoMLAlgorithm": { - "type": "enum", - "members": { - "XGBOOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "xgboost" - } - }, - "LINEAR_LEARNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "linear-learner" - } - }, - "MLP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mlp" - } - }, - "LIGHTGBM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lightgbm" - } - }, - "CATBOOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "catboost" - } - }, - "RANDOMFOREST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "randomforest" - } - }, - "EXTRA_TREES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "extra-trees" - } - }, - "NN_TORCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nn-torch" - } - }, - "FASTAI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fastai" - } - }, - "CNN_QR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cnn-qr" - } - }, - "DEEPAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deepar" - } - }, - "PROPHET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "prophet" - } - }, - "NPTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "npts" - } - }, - "ARIMA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "arima" - } - }, - "ETS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ets" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLAlgorithmConfig": { - "type": "structure", - "members": { - "AutoMLAlgorithms": { - "target": "com.amazonaws.sagemaker#AutoMLAlgorithms", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.
\n\n For the tabular problem type\n TabularJobConfig:\n
Selected algorithms must belong to the list corresponding to the training mode\n set in AutoMLJobConfig.Mode (ENSEMBLING or\n HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.
In ENSEMBLING mode:
\"catboost\"
\n\"extra-trees\"
\n\"fastai\"
\n\"lightgbm\"
\n\"linear-learner\"
\n\"nn-torch\"
\n\"randomforest\"
\n\"xgboost\"
\nIn HYPERPARAMETER_TUNING mode:
\"linear-learner\"
\n\"mlp\"
\n\"xgboost\"
\n\n For the time-series forecasting problem type\n TimeSeriesForecastingJobConfig:\n
Choose your algorithms from this list.
\n\"cnn-qr\"
\n\"deepar\"
\n\"prophet\"
\n\"arima\"
\n\"npts\"
\n\"ets\"
\nThe selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.
" - } - }, - "com.amazonaws.sagemaker#AutoMLAlgorithms": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AutoMLAlgorithm" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 11 - } - } - }, - "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AutoMLAlgorithmConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#AutoMLCandidate": { - "type": "structure", - "members": { - "CandidateName": { - "target": "com.amazonaws.sagemaker#CandidateName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the candidate.
", - "smithy.api#required": {} - } - }, - "FinalAutoMLJobObjectiveMetric": { - "target": "com.amazonaws.sagemaker#FinalAutoMLJobObjectiveMetric" - }, - "ObjectiveStatus": { - "target": "com.amazonaws.sagemaker#ObjectiveStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The objective's status.
", - "smithy.api#required": {} - } - }, - "CandidateSteps": { - "target": "com.amazonaws.sagemaker#CandidateSteps", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the candidate's steps.
", - "smithy.api#required": {} - } - }, - "CandidateStatus": { - "target": "com.amazonaws.sagemaker#CandidateStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The candidate's status.
", - "smithy.api#required": {} - } - }, - "InferenceContainers": { - "target": "com.amazonaws.sagemaker#AutoMLContainerDefinitions", - "traits": { - "smithy.api#documentation": "Information about the recommended inference container definitions.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The creation time.
", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The end time.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The last modified time.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#AutoMLFailureReason", - "traits": { - "smithy.api#documentation": "The failure reason.
" - } - }, - "CandidateProperties": { - "target": "com.amazonaws.sagemaker#CandidateProperties", - "traits": { - "smithy.api#documentation": "The properties of an AutoML candidate job.
" - } - }, - "InferenceContainerDefinitions": { - "target": "com.amazonaws.sagemaker#AutoMLInferenceContainerDefinitions", - "traits": { - "smithy.api#documentation": "The mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the AutoML jobs V2 (for example,\n for jobs created by calling CreateAutoMLJobV2) related to image or text\n classification problem types only.
Information about a candidate produced by an AutoML training job, including its status,\n steps, and other properties.
" - } - }, - "com.amazonaws.sagemaker#AutoMLCandidateGenerationConfig": { - "type": "structure", - "members": { - "FeatureSpecificationS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
These column keys may not include the target column.
\nIn ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.
If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
Stores the configuration information for the selection of algorithms trained on tabular\n data.
\nThe list of available algorithms to choose from depends on the training mode set in\n \n TabularJobConfig.Mode\n .
\n AlgorithmsConfig should not be set if the training mode is set on\n AUTO.
When AlgorithmsConfig is provided, one AutoMLAlgorithms\n attribute must be set and one only.
If the list of algorithms provided as values for AutoMLAlgorithms is\n empty, CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.
For the list of all algorithms per problem type and training mode, see \n AutoMLAlgorithmConfig.
\nFor more information on each algorithm, see the Algorithm support section in Autopilot developer guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Stores the configuration information for how a candidate is generated (optional).
" - } - }, - "com.amazonaws.sagemaker#AutoMLCandidateStep": { - "type": "structure", - "members": { - "CandidateStepType": { - "target": "com.amazonaws.sagemaker#CandidateStepType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Whether the candidate is at the transform, training, or processing step.
", - "smithy.api#required": {} - } - }, - "CandidateStepArn": { - "target": "com.amazonaws.sagemaker#CandidateStepArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN for the candidate's step.
", - "smithy.api#required": {} - } - }, - "CandidateStepName": { - "target": "com.amazonaws.sagemaker#CandidateStepName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name for the candidate's step.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the steps for a candidate and what step it is working on.
" - } - }, - "com.amazonaws.sagemaker#AutoMLCandidates": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AutoMLCandidate" - } - }, - "com.amazonaws.sagemaker#AutoMLChannel": { - "type": "structure", - "members": { - "DataSource": { - "target": "com.amazonaws.sagemaker#AutoMLDataSource", - "traits": { - "smithy.api#documentation": "The data source for an AutoML channel.
" - } - }, - "CompressionType": { - "target": "com.amazonaws.sagemaker#CompressionType", - "traits": { - "smithy.api#documentation": "You can use Gzip or None. The default value is\n None.
The name of the target variable in supervised learning, usually represented by\n 'y'.
", - "smithy.api#required": {} - } - }, - "ContentType": { - "target": "com.amazonaws.sagemaker#ContentType", - "traits": { - "smithy.api#documentation": "The content type of the data from the input source. You can use\n text/csv;header=present or x-application/vnd.amazon+parquet.\n The default value is text/csv;header=present.
The channel type (optional) is an enum string. The default value is\n training. Channels for training and validation must share the same\n ContentType and TargetAttributeName. For information on\n specifying training and validation channel types, see How to specify training and validation datasets.
If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.
\nSample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.
\nSupport for sample weights is available in Ensembling\n mode only.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A channel is a named input source that training algorithms can consume. The validation\n dataset size is limited to less than 2 GB. The training dataset size must be less than 100\n GB. For more information, see Channel.
\nA validation dataset must contain the same headers as the training dataset.
\nThe configuration for using EMR Serverless\n to run the AutoML job V2.
\nTo allow your AutoML job V2 to automatically initiate a remote job on EMR Serverless\n when additional compute resources are needed to process large datasets, you need to provide\n an EmrServerlessComputeConfig object, which includes an\n ExecutionRoleARN attribute, to the AutoMLComputeConfig of the\n AutoML job V2 input request.
By seamlessly transitioning to EMR Serverless when required, the AutoML job can handle\n datasets that would otherwise exceed the initially provisioned resources, without any\n manual intervention from you.
\nEMR Serverless is available for the tabular and time series problem types. We\n recommend setting up this option for tabular datasets larger than 5 GB and time series\n datasets larger than 30 GB.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in\n other contexts at the moment.
\nSpecifies the compute configuration for an AutoML job V2.
" - } - }, - "com.amazonaws.sagemaker#AutoMLContainerDefinition": { - "type": "structure", - "members": { - "Image": { - "target": "com.amazonaws.sagemaker#ContainerImage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more\n information, see \n ContainerDefinition.
", - "smithy.api#required": {} - } - }, - "ModelDataUrl": { - "target": "com.amazonaws.sagemaker#Url", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location of the model artifacts. For more information, see \n ContainerDefinition.
", - "smithy.api#required": {} - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#EnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables to set in the container. For more information, see \n ContainerDefinition.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A list of container definitions that describe the different containers that make up an\n AutoML candidate. For more information, see \n ContainerDefinition.
" - } - }, - "com.amazonaws.sagemaker#AutoMLContainerDefinitions": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AutoMLContainerDefinition" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#AutoMLDataSource": { - "type": "structure", - "members": { - "S3DataSource": { - "target": "com.amazonaws.sagemaker#AutoMLS3DataSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 location of the input data.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The data source for the Autopilot job.
" - } - }, - "com.amazonaws.sagemaker#AutoMLDataSplitConfig": { - "type": "structure", - "members": { - "ValidationFraction": { - "target": "com.amazonaws.sagemaker#ValidationFraction", - "traits": { - "smithy.api#documentation": "The validation fraction (optional) is a float that specifies the portion of the training\n dataset to be used for validation. The default value is 0.2, and values must be greater\n than 0 and less than 1. We recommend setting this value to be less than 0.5.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This structure specifies how to split the data into train and validation\n datasets.
\nThe validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.
Processing unit for an inference container. Currently Autopilot only supports\n CPU or GPU.
Information about the recommended inference container definitions.
" - } - }, - "traits": { - "smithy.api#documentation": "The mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the V2 API only (for example,\n for jobs created by calling CreateAutoMLJobV2).
The URL of the notebook location.
" - } - }, - "DataExplorationNotebookLocation": { - "target": "com.amazonaws.sagemaker#DataExplorationNotebookLocation", - "traits": { - "smithy.api#documentation": "The URL of the notebook location.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The artifacts that are generated during an AutoML job.
" - } - }, - "com.amazonaws.sagemaker#AutoMLJobChannel": { - "type": "structure", - "members": { - "ChannelType": { - "target": "com.amazonaws.sagemaker#AutoMLChannelType", - "traits": { - "smithy.api#documentation": "The type of channel. Defines whether the data are used for training or validation. The\n default value is training. Channels for training and\n validation must share the same ContentType\n
The type of channel defaults to training for the time-series forecasting\n problem type.
The content type of the data from the input source. The following are the allowed\n content types for different problems:
\nFor tabular problem types: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For image classification: image/png, image/jpeg, or\n image/*. The default value is image/*.
For text classification: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For time-series forecasting: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For text generation (LLMs fine-tuning): text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
The allowed compression types depend on the input format and problem type. We allow the\n compression type Gzip for S3Prefix inputs on tabular data only.\n For all other inputs, the compression type should be None. If no compression\n type is provided, we default to None.
The data source for an AutoML channel (Required).
" - } - } - }, - "traits": { - "smithy.api#documentation": "A channel is a named input source that training algorithms can consume. This channel is\n used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).
" - } - }, - "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria": { - "type": "structure", - "members": { - "MaxCandidates": { - "target": "com.amazonaws.sagemaker#MaxCandidates", - "traits": { - "smithy.api#documentation": "The maximum number of times a training job is allowed to run.
\nFor text and image classification, time-series forecasting, as well as text generation\n (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the\n maximum value is 750.
" - } - }, - "MaxRuntimePerTrainingJobInSeconds": { - "target": "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds", - "traits": { - "smithy.api#documentation": "The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.
\nFor job V2s (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.
For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours\n (259200 seconds).
" - } - }, - "MaxAutoMLJobRuntimeInSeconds": { - "target": "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds", - "traits": { - "smithy.api#documentation": "The maximum runtime, in seconds, an AutoML job has to complete.
\nIf an AutoML job exceeds the maximum runtime, the job is stopped automatically and its\n processing is ended gracefully. The AutoML job identifies the best model whose training was\n completed and marks it as the best-performing model. Any unfinished steps of the job, such\n as automatic one-click Autopilot model deployment, are not completed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "How long a job is allowed to run, or how many candidates a job is allowed to\n generate.
" - } - }, - "com.amazonaws.sagemaker#AutoMLJobConfig": { - "type": "structure", - "members": { - "CompletionCriteria": { - "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", - "traits": { - "smithy.api#documentation": "How long an AutoML job is allowed to run, or how many candidates a job is allowed to\n generate.
" - } - }, - "SecurityConfig": { - "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", - "traits": { - "smithy.api#documentation": "The security configuration for traffic encryption or Amazon VPC settings.
" - } - }, - "CandidateGenerationConfig": { - "target": "com.amazonaws.sagemaker#AutoMLCandidateGenerationConfig", - "traits": { - "smithy.api#documentation": "The configuration for generating a candidate for an AutoML job (optional).
" - } - }, - "DataSplitConfig": { - "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", - "traits": { - "smithy.api#documentation": "The configuration for splitting the input training dataset.
\nType: AutoMLDataSplitConfig
" - } - }, - "Mode": { - "target": "com.amazonaws.sagemaker#AutoMLMode", - "traits": { - "smithy.api#documentation": "The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.
A collection of settings used for an AutoML job.
" - } - }, - "com.amazonaws.sagemaker#AutoMLJobInputDataConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AutoMLJobChannel" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.sagemaker#AutoMLJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$" - } - }, - "com.amazonaws.sagemaker#AutoMLJobObjective": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.
\nThe list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.
\nFor tabular problem types:
\nList of available metrics:
\n Regression: MAE, MSE, R2,\n RMSE\n
Binary classification: Accuracy, AUC,\n BalancedAccuracy, F1,\n Precision, Recall\n
Multiclass classification: Accuracy,\n BalancedAccuracy, F1macro,\n PrecisionMacro, RecallMacro\n
For a description of each metric, see Autopilot metrics for classification and regression.
\nDefault objective metrics:
\nRegression: MSE.
Binary classification: F1.
Multiclass classification: Accuracy.
For image or text classification problem types:
\nList of available metrics: Accuracy\n
For a description of each metric, see Autopilot metrics for text and image classification.
\nDefault objective metrics: Accuracy\n
For time-series forecasting problem types:
\nList of available metrics: RMSE, wQL,\n Average wQL, MASE, MAPE,\n WAPE\n
For a description of each metric, see Autopilot metrics for\n time-series forecasting.
\nDefault objective metrics: AverageWeightedQuantileLoss\n
For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.
Specifies a metric to minimize or maximize as the objective of an AutoML job.
" - } - }, - "com.amazonaws.sagemaker#AutoMLJobObjectiveType": { - "type": "enum", - "members": { - "MAXIMIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximize" - } - }, - "MINIMIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimize" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus": { - "type": "enum", - "members": { - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Starting" - } - }, - "MAX_CANDIDATES_REACHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MaxCandidatesReached" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - }, - "MAX_AUTO_ML_JOB_RUNTIME_REACHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MaxAutoMLJobRuntimeReached" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "CANDIDATE_DEFINITIONS_GENERATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CandidateDefinitionsGenerated" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "EXPLAINABILITY_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExplainabilityError" - } - }, - "DEPLOYING_MODEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeployingModel" - } - }, - "MODEL_DEPLOYMENT_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelDeploymentError" - } - }, - "GENERATING_MODEL_INSIGHTS_REPORT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GeneratingModelInsightsReport" - } - }, - "MODEL_INSIGHTS_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelInsightsError" - } - }, - "ANALYZING_DATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AnalyzingData" - } - }, - "FEATURE_ENGINEERING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FeatureEngineering" - } - }, - "MODEL_TUNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelTuning" - } - }, - "GENERATING_EXPLAINABILITY_REPORT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GeneratingExplainabilityReport" - } - }, - "TRAINING_MODELS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TrainingModels" - } - }, - "PRE_TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PreTraining" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLJobStatus": { - "type": "enum", - "members": { - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLJobStepMetadata": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for an AutoML job step.
" - } - }, - "com.amazonaws.sagemaker#AutoMLJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AutoMLJobSummary" - } - }, - "com.amazonaws.sagemaker#AutoMLJobSummary": { - "type": "structure", - "members": { - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the AutoML job you are requesting.
", - "smithy.api#required": {} - } - }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the AutoML job.
", - "smithy.api#required": {} - } - }, - "AutoMLJobStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the AutoML job.
", - "smithy.api#required": {} - } - }, - "AutoMLJobSecondaryStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The secondary status of the AutoML job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "When the AutoML job was created.
", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The end time of an AutoML job.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "When the AutoML job was last modified.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#AutoMLFailureReason", - "traits": { - "smithy.api#documentation": "The failure reason of an AutoML job.
" - } - }, - "PartialFailureReasons": { - "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", - "traits": { - "smithy.api#documentation": "The list of reasons for partial failures within an AutoML job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides a summary about an AutoML job.
" - } - }, - "com.amazonaws.sagemaker#AutoMLMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#AutoMLMaxResultsForTrials": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.sagemaker#AutoMLMetricEnum": { - "type": "enum", - "members": { - "ACCURACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accuracy" - } - }, - "MSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MSE" - } - }, - "F1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "F1" - } - }, - "F1_MACRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "F1macro" - } - }, - "AUC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUC" - } - }, - "RMSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RMSE" - } - }, - "BALANCED_ACCURACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BalancedAccuracy" - } - }, - "R2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "R2" - } - }, - "RECALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Recall" - } - }, - "RECALL_MACRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RecallMacro" - } - }, - "PRECISION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Precision" - } - }, - "PRECISION_MACRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PrecisionMacro" - } - }, - "MAE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAE" - } - }, - "MAPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAPE" - } - }, - "MASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MASE" - } - }, - "WAPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WAPE" - } - }, - "AVERAGE_WEIGHTED_QUANTILE_LOSS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AverageWeightedQuantileLoss" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLMetricExtendedEnum": { - "type": "enum", - "members": { - "ACCURACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accuracy" - } - }, - "MSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MSE" - } - }, - "F1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "F1" - } - }, - "F1_MACRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "F1macro" - } - }, - "AUC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUC" - } - }, - "RMSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RMSE" - } - }, - "MAE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAE" - } - }, - "R2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "R2" - } - }, - "BALANCED_ACCURACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BalancedAccuracy" - } - }, - "PRECISION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Precision" - } - }, - "PRECISION_MACRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PrecisionMacro" - } - }, - "RECALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Recall" - } - }, - "RECALL_MACRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RecallMacro" - } - }, - "LogLoss": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LogLoss" - } - }, - "INFERENCE_LATENCY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InferenceLatency" - } - }, - "MAPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAPE" - } - }, - "MASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MASE" - } - }, - "WAPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WAPE" - } - }, - "AVERAGE_WEIGHTED_QUANTILE_LOSS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AverageWeightedQuantileLoss" - } - }, - "ROUGE1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Rouge1" - } - }, - "ROUGE2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Rouge2" - } - }, - "ROUGEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RougeL" - } - }, - "ROUGEL_SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RougeLSum" - } - }, - "PERPLEXITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Perplexity" - } - }, - "VALIDATION_LOSS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ValidationLoss" - } - }, - "TRAINING_LOSS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TrainingLoss" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLMode": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "ENSEMBLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENSEMBLING" - } - }, - "HYPERPARAMETER_TUNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HYPERPARAMETER_TUNING" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" - } - }, - "com.amazonaws.sagemaker#AutoMLOutputDataConfig": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Key Management Service encryption key ID.
" - } - }, - "S3OutputPath": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 output path. Must be 512 characters or less.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The output data configuration.
" - } - }, - "com.amazonaws.sagemaker#AutoMLPartialFailureReason": { - "type": "structure", - "members": { - "PartialFailureMessage": { - "target": "com.amazonaws.sagemaker#AutoMLFailureReason", - "traits": { - "smithy.api#documentation": "The message containing the reason for a partial failure of an AutoML job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The reason for a partial failure of an AutoML job.
" - } - }, - "com.amazonaws.sagemaker#AutoMLPartialFailureReasons": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReason" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#AutoMLProblemTypeConfig": { - "type": "union", - "members": { - "ImageClassificationJobConfig": { - "target": "com.amazonaws.sagemaker#ImageClassificationJobConfig", - "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the image classification problem\n type.
" - } - }, - "TextClassificationJobConfig": { - "target": "com.amazonaws.sagemaker#TextClassificationJobConfig", - "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the text classification problem\n type.
" - } - }, - "TimeSeriesForecastingJobConfig": { - "target": "com.amazonaws.sagemaker#TimeSeriesForecastingJobConfig", - "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the time-series forecasting problem\n type.
" - } - }, - "TabularJobConfig": { - "target": "com.amazonaws.sagemaker#TabularJobConfig", - "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the tabular problem type (regression,\n classification).
" - } - }, - "TextGenerationJobConfig": { - "target": "com.amazonaws.sagemaker#TextGenerationJobConfig", - "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning)\n problem type.
\nThe text generation models that support fine-tuning in Autopilot are currently accessible\n exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported\n Regions.
\nA collection of settings specific to the problem type used to configure an AutoML job V2.\n There must be one and only one config of the following type.
" - } - }, - "com.amazonaws.sagemaker#AutoMLProblemTypeConfigName": { - "type": "enum", - "members": { - "IMAGE_CLASSIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ImageClassification" - } - }, - "TEXT_CLASSIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TextClassification" - } - }, - "TIMESERIES_FORECASTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TimeSeriesForecasting" - } - }, - "TABULAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Tabular" - } - }, - "TEXT_GENERATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TextGeneration" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLProblemTypeResolvedAttributes": { - "type": "union", - "members": { - "TabularResolvedAttributes": { - "target": "com.amazonaws.sagemaker#TabularResolvedAttributes", - "traits": { - "smithy.api#documentation": "The resolved attributes for the tabular problem type.
" - } - }, - "TextGenerationResolvedAttributes": { - "target": "com.amazonaws.sagemaker#TextGenerationResolvedAttributes", - "traits": { - "smithy.api#documentation": "The resolved attributes for the text generation problem type.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Stores resolved attributes specific to the problem type of an AutoML job V2.
" - } - }, - "com.amazonaws.sagemaker#AutoMLProcessingUnit": { - "type": "enum", - "members": { - "CPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPU" - } - }, - "GPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GPU" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLResolvedAttributes": { - "type": "structure", - "members": { - "AutoMLJobObjective": { - "target": "com.amazonaws.sagemaker#AutoMLJobObjective" - }, - "CompletionCriteria": { - "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" - }, - "AutoMLProblemTypeResolvedAttributes": { - "target": "com.amazonaws.sagemaker#AutoMLProblemTypeResolvedAttributes", - "traits": { - "smithy.api#documentation": "Defines the resolved attributes specific to a problem type.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The resolved attributes used to configure an AutoML job V2.
" - } - }, - "com.amazonaws.sagemaker#AutoMLS3DataSource": { - "type": "structure", - "members": { - "S3DataType": { - "target": "com.amazonaws.sagemaker#AutoMLS3DataType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The data type.
\nIf you choose S3Prefix, S3Uri identifies a key name\n prefix. SageMaker AI uses all objects that match the specified key name prefix\n for model training.
The S3Prefix should have the following format:
\n s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE\n
If you choose ManifestFile, S3Uri identifies an object\n that is a manifest file containing a list of object keys that you want SageMaker AI to use for model training.
A ManifestFile should have the format shown below:
\n [ {\"prefix\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/\"}, \n
\n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1\",\n
\n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2\",\n
\n ... \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N\" ]\n
If you choose AugmentedManifestFile, S3Uri identifies an\n object that is an augmented manifest file in JSON lines format. This file contains\n the data you want to use for model training. AugmentedManifestFile is\n available for V2 API jobs only (for example, for jobs created by calling\n CreateAutoMLJobV2).
Here is a minimal, single-record example of an\n AugmentedManifestFile:
\n {\"source-ref\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg\",\n
\n \"label-metadata\": {\"class-name\": \"cat\" }
For more information on AugmentedManifestFile, see Provide\n Dataset Metadata to Training Jobs with an Augmented Manifest File.
The URL to the Amazon S3 data source. The Uri refers to the Amazon S3\n prefix or ManifestFile depending on the data type.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the Amazon S3 data source.
" - } - }, - "com.amazonaws.sagemaker#AutoMLS3DataType": { - "type": "enum", - "members": { - "MANIFEST_FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManifestFile" - } - }, - "S3_PREFIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3Prefix" - } - }, - "AUGMENTED_MANIFEST_FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AugmentedManifestFile" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLSecurityConfig": { - "type": "structure", - "members": { - "VolumeKmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The key used to encrypt stored data.
" - } - }, - "EnableInterContainerTrafficEncryption": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Whether to use traffic encryption between the container layers.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", - "traits": { - "smithy.api#documentation": "The VPC configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Security options.
" - } - }, - "com.amazonaws.sagemaker#AutoMLSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMLSortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.sagemaker#AutoMountHomeEFS": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - }, - "DEFAULT_AS_DOMAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DefaultAsDomain" - } - } - } - }, - "com.amazonaws.sagemaker#AutoParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#ParameterKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hyperparameter to optimize using Autotune.
", - "smithy.api#required": {} - } - }, - "ValueHint": { - "target": "com.amazonaws.sagemaker#ParameterValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An example value of the hyperparameter to optimize using Autotune.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The name and an example value of the hyperparameter that you want to use in Autotune.\n If Automatic model tuning (AMT) determines that your hyperparameter is eligible for\n Autotune, an optimal hyperparameter range is selected for you.
" - } - }, - "com.amazonaws.sagemaker#AutoParameters": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AutoParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#AutoRollbackConfig": { - "type": "structure", - "members": { - "Alarms": { - "target": "com.amazonaws.sagemaker#AlarmList", - "traits": { - "smithy.api#documentation": "List of CloudWatch alarms in your account that are configured to monitor metrics on an\n endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the\n deployment.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Automatic rollback configuration for handling endpoint deployment failures and\n recovery.
" - } - }, - "com.amazonaws.sagemaker#Autotune": { - "type": "structure", - "members": { - "Mode": { - "target": "com.amazonaws.sagemaker#AutotuneMode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Set Mode to Enabled if you want to use Autotune.
A flag to indicate if you want to use Autotune to automatically find optimal values\n for the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.
\nThe Amazon S3 location being used to capture the data.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the batch transform job.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
Flag that indicates whether to append inference id to the output.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration to control how SageMaker captures inference data for batch transform jobs.
" - } - }, - "com.amazonaws.sagemaker#BatchDeleteClusterNodes": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes\n accepts a cluster name and a list of node IDs.
To safeguard your work, back up your data to Amazon S3 or an FSx for\n Lustre file system before invoking the API on a worker node group. This will help\n prevent any potential data loss from the instance root volume. For more\n information about backup, see Use the backup script provided by SageMaker HyperPod.
\nIf you want to invoke this API on an existing cluster, you'll first need to\n patch the cluster by running the UpdateClusterSoftware API. For more information about patching a\n cluster, see Update the SageMaker HyperPod platform software of a cluster.
\nThe error code associated with the error encountered when deleting a node.
\nThe code provides information about the specific issue encountered, such as the node not\n being found, the node's status being invalid for deletion, or the node ID being in use by\n another process.
", - "smithy.api#required": {} - } - }, - "Message": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A message describing the error encountered when deleting a node.
", - "smithy.api#required": {} - } - }, - "NodeId": { - "target": "com.amazonaws.sagemaker#ClusterNodeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the node that encountered an error during the deletion process.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Represents an error encountered when deleting a node from a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#BatchDeleteClusterNodesErrorCode": { - "type": "enum", - "members": { - "NODE_ID_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NodeIdNotFound" - } - }, - "INVALID_NODE_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidNodeStatus" - } - }, - "NODE_ID_IN_USE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NodeIdInUse" - } - } - } - }, - "com.amazonaws.sagemaker#BatchDeleteClusterNodesErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesError" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 99 - } - } - }, - "com.amazonaws.sagemaker#BatchDeleteClusterNodesRequest": { - "type": "structure", - "members": { - "ClusterName": { - "target": "com.amazonaws.sagemaker#ClusterNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the SageMaker HyperPod cluster from which to delete the specified nodes.
", - "smithy.api#required": {} - } - }, - "NodeIds": { - "target": "com.amazonaws.sagemaker#ClusterNodeIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of node IDs to be deleted from the specified cluster.
\nFor SageMaker HyperPod clusters using the Slurm workload manager, \n you cannot remove instances that are configured as Slurm controller nodes.
\nA list of errors encountered when deleting the specified nodes.
" - } - }, - "Successful": { - "target": "com.amazonaws.sagemaker#ClusterNodeIds", - "traits": { - "smithy.api#documentation": "A list of node IDs that were successfully deleted from the specified cluster.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#BatchDescribeModelPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageOutput" - }, - "traits": { - "smithy.api#documentation": "This action batch describes a list of versioned model packages
" - } - }, - "com.amazonaws.sagemaker#BatchDescribeModelPackageError": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "", - "smithy.api#required": {} - } - }, - "ErrorResponse": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The error code and error description associated with the resource.
" - } - }, - "com.amazonaws.sagemaker#BatchDescribeModelPackageErrorMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#ModelPackageArn" - }, - "value": { - "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageError" - } - }, - "com.amazonaws.sagemaker#BatchDescribeModelPackageInput": { - "type": "structure", - "members": { - "ModelPackageArnList": { - "target": "com.amazonaws.sagemaker#ModelPackageArnList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The list of Amazon Resource Name (ARN) of the model package groups.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#BatchDescribeModelPackageOutput": { - "type": "structure", - "members": { - "ModelPackageSummaries": { - "target": "com.amazonaws.sagemaker#ModelPackageSummaries", - "traits": { - "smithy.api#documentation": "The summaries for the model package versions
" - } - }, - "BatchDescribeModelPackageErrorMap": { - "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageErrorMap", - "traits": { - "smithy.api#documentation": "A map of the resource and BatchDescribeModelPackageError objects \n reporting the error associated with describing the model package.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#BatchDescribeModelPackageSummary": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The group name for the model package
", - "smithy.api#required": {} - } - }, - "ModelPackageVersion": { - "target": "com.amazonaws.sagemaker#ModelPackageVersion", - "traits": { - "smithy.api#documentation": "The version number of a versioned model.
" - } - }, - "ModelPackageArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
", - "smithy.api#required": {} - } - }, - "ModelPackageDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "The description of the model package.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The creation time of the mortgage package summary.
", - "smithy.api#required": {} - } - }, - "InferenceSpecification": { - "target": "com.amazonaws.sagemaker#InferenceSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "ModelPackageStatus": { - "target": "com.amazonaws.sagemaker#ModelPackageStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the mortgage package.
", - "smithy.api#required": {} - } - }, - "ModelApprovalStatus": { - "target": "com.amazonaws.sagemaker#ModelApprovalStatus", - "traits": { - "smithy.api#documentation": "The approval status of the model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides summary information about the model package.
" - } - }, - "com.amazonaws.sagemaker#BatchStrategy": { - "type": "enum", - "members": { - "MULTI_RECORD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MultiRecord" - } - }, - "SINGLE_RECORD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SingleRecord" - } - } - } - }, - "com.amazonaws.sagemaker#BatchTransformInput": { - "type": "structure", - "members": { - "DataCapturedDestinationS3Uri": { - "target": "com.amazonaws.sagemaker#DestinationS3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 location being used to capture the data.
", - "smithy.api#required": {} - } - }, - "DatasetFormat": { - "target": "com.amazonaws.sagemaker#MonitoringDatasetFormat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The dataset format for your batch transform job.
", - "smithy.api#required": {} - } - }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#ProcessingLocalPath", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Path to the filesystem where the batch transform data is available to the container.
", - "smithy.api#required": {} - } - }, - "S3InputMode": { - "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", - "traits": { - "smithy.api#documentation": "Whether the Pipe or File is used as the input mode for\n transferring data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.\n Defaults to FullyReplicated\n
The attributes of the input data that are the input features.
" - } - }, - "InferenceAttribute": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The attribute of the input data that represents the ground truth label.
" - } - }, - "ProbabilityAttribute": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "In a classification problem, the attribute that represents the class probability.
" - } - }, - "ProbabilityThresholdAttribute": { - "target": "com.amazonaws.sagemaker#ProbabilityThresholdAttribute", - "traits": { - "smithy.api#documentation": "The threshold for the class probability to be evaluated as a positive result.
" - } - }, - "StartTimeOffset": { - "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", - "traits": { - "smithy.api#documentation": "If specified, monitoring jobs substract this time from the start time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" - } - }, - "EndTimeOffset": { - "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", - "traits": { - "smithy.api#documentation": "If specified, monitoring jobs subtract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" - } - }, - "ExcludeFeaturesAttribute": { - "target": "com.amazonaws.sagemaker#ExcludeFeaturesAttribute", - "traits": { - "smithy.api#documentation": "The attributes of the input data to exclude from the analysis.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Input object for the batch transform job.
" - } - }, - "com.amazonaws.sagemaker#BestObjectiveNotImproving": { - "type": "structure", - "members": { - "MaxNumberOfTrainingJobsNotImproving": { - "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobsNotImproving", - "traits": { - "smithy.api#documentation": "The number of training jobs that have failed to improve model performance by 1% or\n greater over prior training jobs as evaluated against an objective function.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure that keeps track of which training jobs launched by your hyperparameter\n tuning job are not improving model performance as evaluated against an objective\n function.
" - } - }, - "com.amazonaws.sagemaker#Bias": { - "type": "structure", - "members": { - "Report": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The bias report for a model
" - } - }, - "PreTrainingReport": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The pre-training bias report for a model.
" - } - }, - "PostTrainingReport": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The post-training bias report for a model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains bias metrics for a model.
" - } - }, - "com.amazonaws.sagemaker#BillableTimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#BlockedReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.sagemaker#BlueGreenUpdatePolicy": { - "type": "structure", - "members": { - "TrafficRoutingConfiguration": { - "target": "com.amazonaws.sagemaker#TrafficRoutingConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Defines the traffic routing strategy to shift traffic from the old fleet to the new\n fleet during an endpoint deployment.
", - "smithy.api#required": {} - } - }, - "TerminationWaitInSeconds": { - "target": "com.amazonaws.sagemaker#TerminationWaitInSeconds", - "traits": { - "smithy.api#documentation": "Additional waiting time in seconds after the completion of an endpoint deployment\n before terminating the old endpoint fleet. Default is 0.
" - } - }, - "MaximumExecutionTimeoutInSeconds": { - "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "Maximum execution timeout for the deployment. Note that the timeout value should be\n larger than the total waiting time specified in TerminationWaitInSeconds\n and WaitIntervalInSeconds.
Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.
" - } - }, - "com.amazonaws.sagemaker#Boolean": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#BooleanOperator": { - "type": "enum", - "members": { - "AND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "And" - } - }, - "OR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Or" - } - } - } - }, - "com.amazonaws.sagemaker#BorrowLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.sagemaker#Branch": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[^ ~^:?*\\[]+$" - } - }, - "com.amazonaws.sagemaker#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" - } - }, - "com.amazonaws.sagemaker#CacheHitResult": { - "type": "structure", - "members": { - "SourcePipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details on the cache hit of a pipeline execution step.
" - } - }, - "com.amazonaws.sagemaker#CallbackStepMetadata": { - "type": "structure", - "members": { - "CallbackToken": { - "target": "com.amazonaws.sagemaker#CallbackToken", - "traits": { - "smithy.api#documentation": "The pipeline generated token from the Amazon SQS queue.
" - } - }, - "SqsQueueUrl": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.
" - } - }, - "OutputParameters": { - "target": "com.amazonaws.sagemaker#OutputParameterList", - "traits": { - "smithy.api#documentation": "A list of the output parameters of the callback step.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata about a callback step.
" - } - }, - "com.amazonaws.sagemaker#CallbackToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 10 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.sagemaker#CandidateArtifactLocations": { - "type": "structure", - "members": { - "Explainability": { - "target": "com.amazonaws.sagemaker#ExplainabilityLocation", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 prefix to the explainability artifacts generated for the AutoML\n candidate.
", - "smithy.api#required": {} - } - }, - "ModelInsights": { - "target": "com.amazonaws.sagemaker#ModelInsightsLocation", - "traits": { - "smithy.api#documentation": "The Amazon S3 prefix to the model insight artifacts generated for the AutoML\n candidate.
" - } - }, - "BacktestResults": { - "target": "com.amazonaws.sagemaker#BacktestResultsLocation", - "traits": { - "smithy.api#documentation": "The Amazon S3 prefix to the accuracy metrics and the inference results observed\n over the testing window. Available only for the time-series forecasting problem\n type.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The location of artifacts for an AutoML candidate job.
" - } - }, - "com.amazonaws.sagemaker#CandidateDefinitionNotebookLocation": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#CandidateGenerationConfig": { - "type": "structure", - "members": { - "AlgorithmsConfig": { - "target": "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig", - "traits": { - "smithy.api#documentation": "Your Autopilot job trains a default set of algorithms on your dataset. For tabular and\n time-series data, you can customize the algorithm list by selecting a subset of algorithms\n for your problem type.
\n\n AlgorithmsConfig stores the customized selection of algorithms to train on\n your data.
\n For the tabular problem type\n TabularJobConfig, the list of available algorithms to\n choose from depends on the training mode set in \n AutoMLJobConfig.Mode\n .
\n AlgorithmsConfig should not be set when the training mode\n AutoMLJobConfig.Mode is set to AUTO.
When AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.
If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.
For the list of all algorithms per training mode, see \n AlgorithmConfig.
\nFor more information on each algorithm, see the Algorithm support section in the Autopilot developer guide.
\n\n For the time-series forecasting problem type\n TimeSeriesForecastingJobConfig, choose your algorithms\n from the list provided in \n AlgorithmConfig.
For more information on each algorithm, see the Algorithms\n support for time-series forecasting section in the Autopilot developer\n guide.
\nWhen AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.
If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.
Stores the configuration information for how model candidates are generated using an\n AutoML job V2.
" - } - }, - "com.amazonaws.sagemaker#CandidateName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.sagemaker#CandidateProperties": { - "type": "structure", - "members": { - "CandidateArtifactLocations": { - "target": "com.amazonaws.sagemaker#CandidateArtifactLocations", - "traits": { - "smithy.api#documentation": "The Amazon S3 prefix to the artifacts generated for an AutoML candidate.
" - } - }, - "CandidateMetrics": { - "target": "com.amazonaws.sagemaker#MetricDataList", - "traits": { - "smithy.api#documentation": "Information about the candidate metrics for an AutoML job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The properties of an AutoML candidate job.
" - } - }, - "com.amazonaws.sagemaker#CandidateSortBy": { - "type": "enum", - "members": { - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "Status": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - }, - "FinalObjectiveMetricValue": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FinalObjectiveMetricValue" - } - } - } - }, - "com.amazonaws.sagemaker#CandidateStatus": { - "type": "enum", - "members": { - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - } - } - }, - "com.amazonaws.sagemaker#CandidateStepArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/" - } - }, - "com.amazonaws.sagemaker#CandidateStepName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.sagemaker#CandidateStepType": { - "type": "enum", - "members": { - "TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS::SageMaker::TrainingJob" - } - }, - "TRANSFORM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS::SageMaker::TransformJob" - } - }, - "PROCESSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS::SageMaker::ProcessingJob" - } - } - } - }, - "com.amazonaws.sagemaker#CandidateSteps": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AutoMLCandidateStep" - } - }, - "com.amazonaws.sagemaker#CanvasAppSettings": { - "type": "structure", - "members": { - "TimeSeriesForecastingSettings": { - "target": "com.amazonaws.sagemaker#TimeSeriesForecastingSettings", - "traits": { - "smithy.api#documentation": "Time series forecast settings for the SageMaker Canvas application.
" - } - }, - "ModelRegisterSettings": { - "target": "com.amazonaws.sagemaker#ModelRegisterSettings", - "traits": { - "smithy.api#documentation": "The model registry settings for the SageMaker Canvas application.
" - } - }, - "WorkspaceSettings": { - "target": "com.amazonaws.sagemaker#WorkspaceSettings", - "traits": { - "smithy.api#documentation": "The workspace settings for the SageMaker Canvas application.
" - } - }, - "IdentityProviderOAuthSettings": { - "target": "com.amazonaws.sagemaker#IdentityProviderOAuthSettings", - "traits": { - "smithy.api#documentation": "The settings for connecting to an external data source with OAuth.
" - } - }, - "DirectDeploySettings": { - "target": "com.amazonaws.sagemaker#DirectDeploySettings", - "traits": { - "smithy.api#documentation": "The model deployment settings for the SageMaker Canvas application.
" - } - }, - "KendraSettings": { - "target": "com.amazonaws.sagemaker#KendraSettings", - "traits": { - "smithy.api#documentation": "The settings for document querying.
" - } - }, - "GenerativeAiSettings": { - "target": "com.amazonaws.sagemaker#GenerativeAiSettings", - "traits": { - "smithy.api#documentation": "The generative AI settings for the SageMaker Canvas application.
" - } - }, - "EmrServerlessSettings": { - "target": "com.amazonaws.sagemaker#EmrServerlessSettings", - "traits": { - "smithy.api#documentation": "The settings for running Amazon EMR Serverless data processing jobs in SageMaker Canvas.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The SageMaker Canvas application settings.
" - } - }, - "com.amazonaws.sagemaker#CapacitySize": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.sagemaker#CapacitySizeType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the endpoint capacity type.
\n\n INSTANCE_COUNT: The endpoint activates based on the number of\n instances.
\n CAPACITY_PERCENT: The endpoint activates based on the specified\n percentage of capacity.
Defines the capacity size, either as a number of instances or a capacity\n percentage.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the type and size of the endpoint capacity to activate for a blue/green\n deployment, a rolling deployment, or a rollback strategy. You can specify your batches\n as either instance count or the overall percentage or your fleet.
\nFor a rollback strategy, if you don't specify the fields in this object, or if you set\n the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls\n all traffic back to the blue fleet.
The list of all content type headers that Amazon SageMaker AI will treat as CSV and\n capture accordingly.
" - } - }, - "JsonContentTypes": { - "target": "com.amazonaws.sagemaker#JsonContentTypes", - "traits": { - "smithy.api#documentation": "The list of all content type headers that SageMaker AI will treat as JSON and\n capture accordingly.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified\n Amazon SageMaker AI will by default base64 encode when capturing the data.
" - } - }, - "com.amazonaws.sagemaker#CaptureMode": { - "type": "enum", - "members": { - "INPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Input" - } - }, - "OUTPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Output" - } - }, - "INPUT_AND_OUTPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InputAndOutput" - } - } - } - }, - "com.amazonaws.sagemaker#CaptureOption": { - "type": "structure", - "members": { - "CaptureMode": { - "target": "com.amazonaws.sagemaker#CaptureMode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specify the boundary of data to capture.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies data Model Monitor will capture.
" - } - }, - "com.amazonaws.sagemaker#CaptureOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CaptureOption" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.sagemaker#CaptureStatus": { - "type": "enum", - "members": { - "STARTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Started" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#Catalog": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" - } - }, - "com.amazonaws.sagemaker#CategoricalParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#String64", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Name of the environment variable.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#CategoricalParameterRangeValues", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The list of values you can pass.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Environment parameters you want to benchmark your load test against.
" - } - }, - "com.amazonaws.sagemaker#CategoricalParameterRange": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#ParameterKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the categorical hyperparameter to tune.
", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.sagemaker#ParameterValues", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of the categories\n for\n the hyperparameter.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A list of categorical hyperparameters to tune.
" - } - }, - "com.amazonaws.sagemaker#CategoricalParameterRangeSpecification": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.sagemaker#ParameterValues", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The allowed categories for the hyperparameter.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the possible values for a categorical hyperparameter.
" - } - }, - "com.amazonaws.sagemaker#CategoricalParameterRangeValues": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#String128" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 3 - } - } - }, - "com.amazonaws.sagemaker#CategoricalParameterRanges": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CategoricalParameterRange" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.sagemaker#CategoricalParameters": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CategoricalParameter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#Cents": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 99 - } - } - }, - "com.amazonaws.sagemaker#CertifyForMarketplace": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#Channel": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.sagemaker#ChannelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#required": {} - } - }, - "DataSource": { - "target": "com.amazonaws.sagemaker#DataSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location of the channel data.
", - "smithy.api#required": {} - } - }, - "ContentType": { - "target": "com.amazonaws.sagemaker#ContentType", - "traits": { - "smithy.api#documentation": "The MIME type of the data.
" - } - }, - "CompressionType": { - "target": "com.amazonaws.sagemaker#CompressionType", - "traits": { - "smithy.api#documentation": "If training data is compressed, the compression type. The default value is\n None. CompressionType is used only in Pipe input mode. In\n File mode, leave this field unset or set it to None.
Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.
\nIn File mode, leave this field unset or set it to None.
" - } - }, - "InputMode": { - "target": "com.amazonaws.sagemaker#TrainingInputMode", - "traits": { - "smithy.api#documentation": "(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a\n different input mode from the training job's general setting. To download the data from\n Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a\n Docker volume, use File input mode. To stream data directly from Amazon S3 to\n the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, this shuffles the results of the\n S3 key prefix matches. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large\n datasets this ensures that the order of the training data is different for each epoch,\n it helps reduce bias and possible overfitting. In a multi-node training job when\n ShuffleConfig is combined with S3DataDistributionType of\n ShardedByS3Key, the data is shuffled across nodes so that the content\n sent to a particular node on the first epoch might be sent to a different node on the\n second epoch.
A channel is a named input source that training algorithms can consume.
" - } - }, - "com.amazonaws.sagemaker#ChannelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$" - } - }, - "com.amazonaws.sagemaker#ChannelSpecification": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#ChannelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A brief description of the channel.
" - } - }, - "IsRequired": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether the channel is required by the algorithm.
" - } - }, - "SupportedContentTypes": { - "target": "com.amazonaws.sagemaker#ContentTypes", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The supported MIME types for the data.
", - "smithy.api#required": {} - } - }, - "SupportedCompressionTypes": { - "target": "com.amazonaws.sagemaker#CompressionTypes", - "traits": { - "smithy.api#documentation": "The allowed compression types, if data compression is used.
" - } - }, - "SupportedInputModes": { - "target": "com.amazonaws.sagemaker#InputModes", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The allowed input mode, either FILE or PIPE.
\nIn FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon\n Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This\n is the most commonly used input mode.
\nIn PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm\n without using the EBS volume.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines a named input source, called a channel, to be used by an algorithm.
" - } - }, - "com.amazonaws.sagemaker#ChannelSpecifications": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ChannelSpecification" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 8 - } - } - }, - "com.amazonaws.sagemaker#CheckpointConfig": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the S3 path where you want SageMaker to store checkpoints. For example,\n s3://bucket-name/key-name-prefix.
(Optional) The local directory where checkpoints are written. The default directory is\n /opt/ml/checkpoints/.
Contains information about the output location for managed spot training checkpoint\n data.
" - } - }, - "com.amazonaws.sagemaker#Cidr": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 64 - }, - "smithy.api#pattern": "^(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)$" - } - }, - "com.amazonaws.sagemaker#Cidrs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Cidr" - } - }, - "com.amazonaws.sagemaker#ClarifyCheckStepMetadata": { - "type": "structure", - "members": { - "CheckType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The type of the Clarify Check step
" - } - }, - "BaselineUsedForDriftCheckConstraints": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI of baseline constraints file to be used for the drift check.
" - } - }, - "CalculatedBaselineConstraints": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI of the newly calculated baseline constraints file.
" - } - }, - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The model package group name.
" - } - }, - "ViolationReport": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI of the violation report if violations are detected.
" - } - }, - "CheckJobArn": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.
" - } - }, - "SkipCheck": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints property.
The container for the metadata for the ClarifyCheck step. For more information, \n see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.\n
" - } - }, - "com.amazonaws.sagemaker#ClarifyContentTemplate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ClarifyEnableExplanations": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ClarifyExplainerConfig": { - "type": "structure", - "members": { - "EnableExplanations": { - "target": "com.amazonaws.sagemaker#ClarifyEnableExplanations", - "traits": { - "smithy.api#documentation": "A JMESPath boolean expression used to filter which records to explain. Explanations\n are activated by default. See \n EnableExplanations\n for additional information.
The inference configuration parameter for the model container.
" - } - }, - "ShapConfig": { - "target": "com.amazonaws.sagemaker#ClarifyShapConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration for SHAP analysis.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration parameters for the SageMaker Clarify explainer.
" - } - }, - "com.amazonaws.sagemaker#ClarifyFeatureHeaders": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClarifyHeader" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#ClarifyFeatureType": { - "type": "enum", - "members": { - "NUMERICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "numerical" - } - }, - "CATEGORICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "categorical" - } - }, - "TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "text" - } - } - } - }, - "com.amazonaws.sagemaker#ClarifyFeatureTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClarifyFeatureType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#ClarifyFeaturesAttribute": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ClarifyHeader": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ClarifyInferenceConfig": { - "type": "structure", - "members": { - "FeaturesAttribute": { - "target": "com.amazonaws.sagemaker#ClarifyFeaturesAttribute", - "traits": { - "smithy.api#documentation": "Provides the JMESPath expression to extract the features from a model container input\n in JSON Lines format. For example, if FeaturesAttribute is the JMESPath\n expression 'myfeatures', it extracts a list of features\n [1,2,3] from request data '{\"myfeatures\":[1,2,3]}'.
A template string used to format a JSON record into an acceptable model container\n input. For example, a ContentTemplate string\n '{\"myfeatures\":$features}' will format a list of features\n [1,2,3] into the record string '{\"myfeatures\":[1,2,3]}'.\n Required only when the model container input is in JSON Lines format.
The maximum number of records in a request that the model container can process when\n querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be\n made on, for example, a single line in CSV data. If MaxRecordCount is\n 1, the model container expects one record per request. A value of 2 or\n greater means that the model expects batch requests, which can reduce overhead and speed\n up the inferencing process. If this parameter is not provided, the explainer will tune\n the record count per request according to the model container's capacity at\n runtime.
The maximum payload size (MB) allowed of a request from the explainer to the model\n container. Defaults to 6 MB.
A zero-based index used to extract a probability value (score) or list from model\n container output in CSV format. If this value is not provided, the entire model\n container output will be treated as a probability value (score) or list.
\n\n Example for a single class model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '1,0.6', set ProbabilityIndex to 1\n to select the probability value 0.6.
\n Example for a multiclass model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n ProbabilityIndex to 1 to select the probability values\n [0.1,0.6,0.3].
A zero-based index used to extract a label header or list of label headers from model\n container output in CSV format.
\n\n Example for a multiclass model: If the model\n container output consists of label headers followed by probabilities:\n '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n LabelIndex to 0 to select the label headers\n ['cat','dog','fish'].
A JMESPath expression used to extract the probability (or score) from the model\n container output if the model container is in JSON Lines format.
\n\n Example: If the model container output of a single\n request is '{\"predicted_label\":1,\"probability\":0.6}', then set\n ProbabilityAttribute to 'probability'.
A JMESPath expression used to locate the list of label headers in the model container\n output.
\n\n Example: If the model container output of a batch\n request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}',\n then set LabelAttribute to 'labels' to extract the list of\n label headers [\"cat\",\"dog\",\"fish\"]\n
For multiclass classification problems, the label headers are the names of the\n classes. Otherwise, the label header is the name of the predicted label. These are used\n to help readability for the output of the InvokeEndpoint API. See the\n response section under Invoke the endpoint\n in the Developer Guide for more information. If there are no label headers in the model\n container output, provide them manually using this parameter.
The names of the features. If provided, these are included in the endpoint response\n payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint\n in the Developer Guide for more information.
A list of data types of the features (optional). Applicable only to NLP\n explainability. If provided, FeatureTypes must have at least one\n 'text' string (for example, ['text']). If\n FeatureTypes is not provided, the explainer infers the feature types\n based on the baseline data. The feature types are included in the endpoint response\n payload. For additional information see the response section under Invoke the endpoint\n in the Developer Guide for more information.
The inference configuration parameter for the model container.
" - } - }, - "com.amazonaws.sagemaker#ClarifyLabelAttribute": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ClarifyLabelHeaders": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClarifyHeader" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.sagemaker#ClarifyLabelIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#ClarifyMaxPayloadInMB": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.sagemaker#ClarifyMaxRecordCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#ClarifyMimeType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*$" - } - }, - "com.amazonaws.sagemaker#ClarifyProbabilityAttribute": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ClarifyProbabilityIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#ClarifyShapBaseline": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.sagemaker#ClarifyShapBaselineConfig": { - "type": "structure", - "members": { - "MimeType": { - "target": "com.amazonaws.sagemaker#ClarifyMimeType", - "traits": { - "smithy.api#documentation": "The MIME type of the baseline data. Choose from 'text/csv' or\n 'application/jsonlines'. Defaults to 'text/csv'.
The inline SHAP baseline data in string format. ShapBaseline can have one\n or multiple records to be used as the baseline dataset. The format of the SHAP baseline\n file should be the same format as the training dataset. For example, if the training\n dataset is in CSV format and each record contains four features, and all features are\n numerical, then the format of the baseline data should also share these characteristics.\n For natural language processing (NLP) of text columns, the baseline value should be the\n value used to replace the unit of text specified by the Granularity of the\n TextConfig parameter. The size limit for ShapBasline is 4\n KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB\n of baseline data.
The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is\n stored. The format of the SHAP baseline file should be the same format as the format of\n the training dataset. For example, if the training dataset is in CSV format, and each\n record in the training dataset has four features, and all features are numerical, then\n the baseline file should also have this same format. Each record should contain only the\n features. If you are using a virtual private cloud (VPC), the\n ShapBaselineUri should be accessible to the VPC. For more information\n about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to\n Resources in your Amazon Virtual Private Cloud.
The configuration for the SHAP\n baseline (also called the background or reference dataset) of the Kernal\n SHAP algorithm.
\nThe number of records in the baseline data determines the size of the\n synthetic dataset, which has an impact on latency of explainability\n requests. For more information, see the Synthetic\n data of Configure and create an endpoint.
\n\n ShapBaseline and ShapBaselineUri are mutually\n exclusive parameters. One or the either is required to configure a SHAP\n baseline.
The configuration for the SHAP baseline of the Kernal SHAP algorithm.
", - "smithy.api#required": {} - } - }, - "NumberOfSamples": { - "target": "com.amazonaws.sagemaker#ClarifyShapNumberOfSamples", - "traits": { - "smithy.api#documentation": "The number of samples to be used for analysis by the Kernal SHAP algorithm.
\nThe number of samples determines the size of the synthetic dataset, which has an\n impact on latency of explainability requests. For more information, see the\n Synthetic data of Configure and create an endpoint.
\nA Boolean toggle to indicate if you want to use the logit function (true) or log-odds\n units (false) for model predictions. Defaults to false.
" - } - }, - "Seed": { - "target": "com.amazonaws.sagemaker#ClarifyShapSeed", - "traits": { - "smithy.api#documentation": "The starting value used to initialize the random number generator in the explainer.\n Provide a value for this parameter to obtain a deterministic SHAP result.
" - } - }, - "TextConfig": { - "target": "com.amazonaws.sagemaker#ClarifyTextConfig", - "traits": { - "smithy.api#documentation": "A parameter that indicates if text features are treated as text and explanations are\n provided for individual units of text. Required for natural language processing (NLP)\n explainability only.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for SHAP analysis using SageMaker Clarify Explainer.
" - } - }, - "com.amazonaws.sagemaker#ClarifyShapNumberOfSamples": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#ClarifyShapSeed": { - "type": "integer" - }, - "com.amazonaws.sagemaker#ClarifyShapUseLogit": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#ClarifyTextConfig": { - "type": "structure", - "members": { - "Language": { - "target": "com.amazonaws.sagemaker#ClarifyTextLanguage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the language of the text features in ISO 639-1 or\n ISO 639-3 code of a\n supported language.
\nFor a mix of multiple languages, use code 'xx'.
The unit of granularity for the analysis of text features. For example, if the unit is\n 'token', then each token (like a word in English) of the text is\n treated as a feature. SHAP values are computed for each unit/feature.
A parameter used to configure the SageMaker Clarify explainer to treat text features as text so\n that explanations are provided for individual units of text. Required only for natural\n language processing (NLP) explainability.
" - } - }, - "com.amazonaws.sagemaker#ClarifyTextGranularity": { - "type": "enum", - "members": { - "TOKEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "token" - } - }, - "SENTENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sentence" - } - }, - "PARAGRAPH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "paragraph" - } - } - } - }, - "com.amazonaws.sagemaker#ClarifyTextLanguage": { - "type": "enum", - "members": { - "AFRIKAANS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af" - } - }, - "ALBANIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sq" - } - }, - "ARABIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ar" - } - }, - "ARMENIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hy" - } - }, - "BASQUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu" - } - }, - "BENGALI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "bn" - } - }, - "BULGARIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "bg" - } - }, - "CATALAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca" - } - }, - "CHINESE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "zh" - } - }, - "CROATIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hr" - } - }, - "CZECH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cs" - } - }, - "DANISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "da" - } - }, - "DUTCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nl" - } - }, - "ENGLISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en" - } - }, - "ESTONIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "et" - } - }, - "FINNISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fi" - } - }, - "FRENCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fr" - } - }, - "GERMAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "de" - } - }, - "GREEK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "el" - } - }, - "GUJARATI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gu" - } - }, - "HEBREW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "he" - } - }, - "HINDI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hi" - } - }, - "HUNGARIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hu" - } - }, - "ICELANDIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "is" - } - }, - "INDONESIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "id" - } - }, - "IRISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ga" - } - }, - "ITALIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "it" - } - }, - "KANNADA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "kn" - } - }, - "KYRGYZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ky" - } - }, - "LATVIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lv" - } - }, - "LITHUANIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lt" - } - }, - "LUXEMBOURGISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lb" - } - }, - "MACEDONIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mk" - } - }, - "MALAYALAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml" - } - }, - "MARATHI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mr" - } - }, - "NEPALI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ne" - } - }, - "NORWEGIAN_BOKMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nb" - } - }, - "PERSIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fa" - } - }, - "POLISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pl" - } - }, - "PORTUGUESE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pt" - } - }, - "ROMANIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ro" - } - }, - "RUSSIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ru" - } - }, - "SANSKRIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa" - } - }, - "SERBIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sr" - } - }, - "SETSWANA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tn" - } - }, - "SINHALA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "si" - } - }, - "SLOVAK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sk" - } - }, - "SLOVENIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sl" - } - }, - "SPANISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "es" - } - }, - "SWEDISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sv" - } - }, - "TAGALOG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tl" - } - }, - "TAMIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ta" - } - }, - "TATAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tt" - } - }, - "TELUGU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "te" - } - }, - "TURKISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tr" - } - }, - "UKRAINIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "uk" - } - }, - "URDU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ur" - } - }, - "YORUBA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "yo" - } - }, - "LIGURIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lij" - } - }, - "MULTI_LANGUAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "xx" - } - } - } - }, - "com.amazonaws.sagemaker#ClientId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[ -~]+$" - } - }, - "com.amazonaws.sagemaker#ClientSecret": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[ -~]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.sagemaker#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.sagemaker#ClusterArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$" - } - }, - "com.amazonaws.sagemaker#ClusterAvailabilityZone": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-z]{2}-[a-z]+-\\d[a-z]$" - } - }, - "com.amazonaws.sagemaker#ClusterAvailabilityZoneId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-z]{3}\\d-az\\d$" - } - }, - "com.amazonaws.sagemaker#ClusterEbsVolumeConfig": { - "type": "structure", - "members": { - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size in gigabytes (GB) of the additional EBS volume to be attached to the instances\n in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each\n instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS)\n volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" - } - }, - "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 16384 - } - } - }, - "com.amazonaws.sagemaker#ClusterInstanceCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 6758 - } - } - }, - "com.amazonaws.sagemaker#ClusterInstanceGroupDetails": { - "type": "structure", - "members": { - "CurrentCount": { - "target": "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount", - "traits": { - "smithy.api#documentation": "The number of instances that are currently in the instance group of a SageMaker HyperPod\n cluster.
" - } - }, - "TargetCount": { - "target": "com.amazonaws.sagemaker#ClusterInstanceCount", - "traits": { - "smithy.api#documentation": "The number of instances you specified to add to the instance group of a SageMaker HyperPod\n cluster.
" - } - }, - "InstanceGroupName": { - "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", - "traits": { - "smithy.api#documentation": "The name of the instance group of a SageMaker HyperPod cluster.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ClusterInstanceType", - "traits": { - "smithy.api#documentation": "The instance type of the instance group of a SageMaker HyperPod cluster.
" - } - }, - "LifeCycleConfig": { - "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", - "traits": { - "smithy.api#documentation": "Details of LifeCycle configuration for the instance group.
" - } - }, - "ExecutionRole": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The execution role for the instance group to assume.
" - } - }, - "ThreadsPerCore": { - "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", - "traits": { - "smithy.api#documentation": "The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance\n group.
" - } - }, - "OnStartDeepHealthChecks": { - "target": "com.amazonaws.sagemaker#OnStartDeepHealthChecks", - "traits": { - "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#InstanceGroupStatus", - "traits": { - "smithy.api#documentation": "The current status of the cluster instance group.
\n\n InService: The instance group is active and healthy.
\n Creating: The instance group is being provisioned.
\n Updating: The instance group is being updated.
\n Failed: The instance group has failed to provision or is no longer\n healthy.
\n Degraded: The instance group is degraded, meaning that some instances\n have failed to provision or are no longer healthy.
\n Deleting: The instance group is being deleted.
The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The current status of the training plan associated with this cluster instance\n group.
" - } - }, - "OverrideVpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig" - } - }, - "traits": { - "smithy.api#documentation": "Details of an instance group in a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetails" - } - }, - "com.amazonaws.sagemaker#ClusterInstanceGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" - } - }, - "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.sagemaker#ClusterInstanceCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the number of instances to add to the instance group of a SageMaker HyperPod\n cluster.
", - "smithy.api#required": {} - } - }, - "InstanceGroupName": { - "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the name of the instance group.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ClusterInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the instance type of the instance group.
", - "smithy.api#required": {} - } - }, - "LifeCycleConfig": { - "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the LifeCycle configuration for the instance group.
", - "smithy.api#required": {} - } - }, - "ExecutionRole": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies an IAM execution role to be assumed by the instance group.
", - "smithy.api#required": {} - } - }, - "ThreadsPerCore": { - "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", - "traits": { - "smithy.api#documentation": "Specifies the value for Threads per core. For instance\n types that support multithreading, you can specify 1 for disabling\n multithreading and 2 for enabling multithreading. For instance types that\n doesn't support multithreading, specify 1. For more information, see the\n reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster\n instance group.
" - } - }, - "OnStartDeepHealthChecks": { - "target": "com.amazonaws.sagemaker#OnStartDeepHealthChecks", - "traits": { - "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.
" - } - }, - "TrainingPlanArn": { - "target": "com.amazonaws.sagemaker#TrainingPlanArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The specifications of an instance group that you need to define.
" - } - }, - "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#ClusterInstancePlacement": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.sagemaker#ClusterAvailabilityZone", - "traits": { - "smithy.api#documentation": "The Availability Zone where the node in the SageMaker HyperPod cluster is launched.
" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.sagemaker#ClusterAvailabilityZoneId", - "traits": { - "smithy.api#documentation": "The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster\n is launched.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the placement details for the node in the SageMaker HyperPod cluster, including the\n Availability Zone and the unique identifier (ID) of the Availability Zone.
" - } - }, - "com.amazonaws.sagemaker#ClusterInstanceStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failure" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "SHUTTING_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ShuttingDown" - } - }, - "SYSTEM_UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SystemUpdating" - } - }, - "DEEP_HEALTH_CHECK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeepHealthCheckInProgress" - } - } - } - }, - "com.amazonaws.sagemaker#ClusterInstanceStatusDetails": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#ClusterInstanceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of an instance in a SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "Message": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The message from an instance in a SageMaker HyperPod cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details of an instance in a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#ClusterInstanceStorageConfig": { - "type": "union", - "members": { - "EbsVolumeConfig": { - "target": "com.amazonaws.sagemaker#ClusterEbsVolumeConfig", - "traits": { - "smithy.api#documentation": "Defines the configuration for attaching additional Amazon Elastic Block Store (EBS)\n volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is\n attached to each instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
Defines the configuration for attaching additional storage to the instances in the\n SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" - } - }, - "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClusterInstanceStorageConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#ClusterInstanceType": { - "type": "enum", - "members": { - "ML_P4D_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4d.24xlarge" - } - }, - "ML_P4DE_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4de.24xlarge" - } - }, - "ML_P5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p5.48xlarge" - } - }, - "ML_TRN1_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.32xlarge" - } - }, - "ML_TRN1N_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1n.32xlarge" - } - }, - "ML_G5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.xlarge" - } - }, - "ML_G5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.2xlarge" - } - }, - "ML_G5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.4xlarge" - } - }, - "ML_G5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.8xlarge" - } - }, - "ML_G5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.12xlarge" - } - }, - "ML_G5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.16xlarge" - } - }, - "ML_G5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.24xlarge" - } - }, - "ML_G5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.48xlarge" - } - }, - "ML_C5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.large" - } - }, - "ML_C5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.xlarge" - } - }, - "ML_C5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.2xlarge" - } - }, - "ML_C5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.4xlarge" - } - }, - "ML_C5_9XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.9xlarge" - } - }, - "ML_C5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.12xlarge" - } - }, - "ML_C5_18XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.18xlarge" - } - }, - "ML_C5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.24xlarge" - } - }, - "ML_C5N_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5n.large" - } - }, - "ML_C5N_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5n.2xlarge" - } - }, - "ML_C5N_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5n.4xlarge" - } - }, - "ML_C5N_9XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5n.9xlarge" - } - }, - "ML_C5N_18XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5n.18xlarge" - } - }, - "ML_M5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.large" - } - }, - "ML_M5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.xlarge" - } - }, - "ML_M5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.2xlarge" - } - }, - "ML_M5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.4xlarge" - } - }, - "ML_M5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.8xlarge" - } - }, - "ML_M5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.12xlarge" - } - }, - "ML_M5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.16xlarge" - } - }, - "ML_M5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.24xlarge" - } - }, - "ML_T3_MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.medium" - } - }, - "ML_T3_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.large" - } - }, - "ML_T3_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.xlarge" - } - }, - "ML_T3_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.2xlarge" - } - }, - "ML_G6_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.xlarge" - } - }, - "ML_G6_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.2xlarge" - } - }, - "ML_G6_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.4xlarge" - } - }, - "ML_G6_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.8xlarge" - } - }, - "ML_G6_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.16xlarge" - } - }, - "ML_G6_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.12xlarge" - } - }, - "ML_G6_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.24xlarge" - } - }, - "ML_G6_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.48xlarge" - } - }, - "ML_GR6_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.gr6.4xlarge" - } - }, - "ML_GR6_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.gr6.8xlarge" - } - }, - "ML_G6E_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.xlarge" - } - }, - "ML_G6E_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.2xlarge" - } - }, - "ML_G6E_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.4xlarge" - } - }, - "ML_G6E_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.8xlarge" - } - }, - "ML_G6E_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.16xlarge" - } - }, - "ML_G6E_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.12xlarge" - } - }, - "ML_G6E_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.24xlarge" - } - }, - "ML_G6E_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.48xlarge" - } - }, - "ML_P5E_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p5e.48xlarge" - } - }, - "ML_P5EN_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p5en.48xlarge" - } - }, - "ML_TRN2_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn2.48xlarge" - } - }, - "ML_C6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.large" - } - }, - "ML_C6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.xlarge" - } - }, - "ML_C6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.2xlarge" - } - }, - "ML_C6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.4xlarge" - } - }, - "ML_C6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.8xlarge" - } - }, - "ML_C6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.12xlarge" - } - }, - "ML_C6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.16xlarge" - } - }, - "ML_C6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.24xlarge" - } - }, - "ML_C6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.32xlarge" - } - }, - "ML_M6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.large" - } - }, - "ML_M6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.xlarge" - } - }, - "ML_M6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.2xlarge" - } - }, - "ML_M6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.4xlarge" - } - }, - "ML_M6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.8xlarge" - } - }, - "ML_M6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.12xlarge" - } - }, - "ML_M6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.16xlarge" - } - }, - "ML_M6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.24xlarge" - } - }, - "ML_M6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.32xlarge" - } - }, - "ML_R6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.large" - } - }, - "ML_R6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.xlarge" - } - }, - "ML_R6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.2xlarge" - } - }, - "ML_R6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.4xlarge" - } - }, - "ML_R6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.8xlarge" - } - }, - "ML_R6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.12xlarge" - } - }, - "ML_R6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.16xlarge" - } - }, - "ML_R6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.24xlarge" - } - }, - "ML_R6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.32xlarge" - } - } - } - }, - "com.amazonaws.sagemaker#ClusterLifeCycleConfig": { - "type": "structure", - "members": { - "SourceS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An Amazon S3 bucket path where your lifecycle scripts are stored.
\nMake sure that the S3 bucket path starts with s3://sagemaker-. The\n IAM role for SageMaker HyperPod has the managed \n AmazonSageMakerClusterInstanceRolePolicy\n attached, which\n allows access to S3 buckets with the specific prefix sagemaker-.
The file name of the entrypoint script of lifecycle scripts under\n SourceS3Uri. This entrypoint script runs during cluster creation.
The lifecycle configuration for a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#ClusterLifeCycleConfigFileName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[\\S\\s]+$" - } - }, - "com.amazonaws.sagemaker#ClusterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" - } - }, - "com.amazonaws.sagemaker#ClusterNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" - } - }, - "com.amazonaws.sagemaker#ClusterNodeDetails": { - "type": "structure", - "members": { - "InstanceGroupName": { - "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", - "traits": { - "smithy.api#documentation": "The instance group name in which the instance is.
" - } - }, - "InstanceId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The ID of the instance.
" - } - }, - "InstanceStatus": { - "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", - "traits": { - "smithy.api#documentation": "The status of the instance.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ClusterInstanceType", - "traits": { - "smithy.api#documentation": "The type of the instance.
" - } - }, - "LaunchTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the instance is launched.
" - } - }, - "LifeCycleConfig": { - "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", - "traits": { - "smithy.api#documentation": "The LifeCycle configuration applied to the instance.
" - } - }, - "OverrideVpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig" - }, - "ThreadsPerCore": { - "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", - "traits": { - "smithy.api#documentation": "The number of threads per CPU core you specified under\n CreateCluster.
The configurations of additional storage specified to the instance group where the\n instance (node) is launched.
" - } - }, - "PrivatePrimaryIp": { - "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp", - "traits": { - "smithy.api#documentation": "The private primary IP address of the SageMaker HyperPod cluster node.
" - } - }, - "PrivatePrimaryIpv6": { - "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIpv6", - "traits": { - "smithy.api#documentation": "The private primary IPv6 address of the SageMaker HyperPod cluster node.
" - } - }, - "PrivateDnsHostname": { - "target": "com.amazonaws.sagemaker#ClusterPrivateDnsHostname", - "traits": { - "smithy.api#documentation": "The private DNS hostname of the SageMaker HyperPod cluster node.
" - } - }, - "Placement": { - "target": "com.amazonaws.sagemaker#ClusterInstancePlacement", - "traits": { - "smithy.api#documentation": "The placement details of the SageMaker HyperPod cluster node.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details of an instance (also called a node interchangeably) in a\n SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#ClusterNodeId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$" - } - }, - "com.amazonaws.sagemaker#ClusterNodeIds": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClusterNodeId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 99 - } - } - }, - "com.amazonaws.sagemaker#ClusterNodeRecovery": { - "type": "enum", - "members": { - "AUTOMATIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Automatic" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - } - } - }, - "com.amazonaws.sagemaker#ClusterNodeSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClusterNodeSummary" - } - }, - "com.amazonaws.sagemaker#ClusterNodeSummary": { - "type": "structure", - "members": { - "InstanceGroupName": { - "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the instance group in which the instance is.
", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the instance.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ClusterInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of the instance.
", - "smithy.api#required": {} - } - }, - "LaunchTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when the instance is launched.
", - "smithy.api#required": {} - } - }, - "InstanceStatus": { - "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the instance.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Lists a summary of the properties of an instance (also called a\n node interchangeably) of a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#ClusterOrchestrator": { - "type": "structure", - "members": { - "Eks": { - "target": "com.amazonaws.sagemaker#ClusterOrchestratorEksConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The type of orchestrator used for the SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#ClusterOrchestratorEksConfig": { - "type": "structure", - "members": { - "ClusterArn": { - "target": "com.amazonaws.sagemaker#EksClusterArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod\n cluster.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration settings for the Amazon EKS cluster used as the orchestrator for the\n SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#ClusterPrivateDnsHostname": { - "type": "string", - "traits": { - "smithy.api#pattern": "^ip-((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)-?\\b){4}\\..*$" - } - }, - "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp": { - "type": "string", - "traits": { - "smithy.api#pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$" - } - }, - "com.amazonaws.sagemaker#ClusterPrivatePrimaryIpv6": { - "type": "string" - }, - "com.amazonaws.sagemaker#ClusterSchedulerConfigArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}$" - } - }, - "com.amazonaws.sagemaker#ClusterSchedulerConfigId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 12 - }, - "smithy.api#pattern": "^[a-z0-9]{12}$" - } - }, - "com.amazonaws.sagemaker#ClusterSchedulerConfigSummary": { - "type": "structure", - "members": { - "ClusterSchedulerConfigArn": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the cluster policy.
", - "smithy.api#required": {} - } - }, - "ClusterSchedulerConfigId": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the cluster policy.
", - "smithy.api#required": {} - } - }, - "ClusterSchedulerConfigVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "Version of the cluster policy.
" - } - }, - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the cluster policy.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Creation time of the cluster policy.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Last modified time of the cluster policy.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the cluster policy.
", - "smithy.api#required": {} - } - }, - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#documentation": "ARN of the cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summary of the cluster policy.
" - } - }, - "com.amazonaws.sagemaker#ClusterSchedulerConfigSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#ClusterSchedulerPriorityClassName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" - } - }, - "com.amazonaws.sagemaker#ClusterSortBy": { - "type": "enum", - "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_TIME" - } - }, - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAME" - } - } - } - }, - "com.amazonaws.sagemaker#ClusterStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "INSERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "ROLLINGBACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RollingBack" - } - }, - "SYSTEMUPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SystemUpdating" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - } - } - }, - "com.amazonaws.sagemaker#ClusterSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ClusterSummary" - } - }, - "com.amazonaws.sagemaker#ClusterSummary": { - "type": "structure", - "members": { - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "ClusterName": { - "target": "com.amazonaws.sagemaker#ClusterName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when the SageMaker HyperPod cluster is created.
", - "smithy.api#required": {} - } - }, - "ClusterStatus": { - "target": "com.amazonaws.sagemaker#ClusterStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "TrainingPlanArns": { - "target": "com.amazonaws.sagemaker#TrainingPlanArns", - "traits": { - "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) of the training plans associated with this\n cluster.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Lists a summary of the properties of a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#ClusterThreadsPerCore": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.sagemaker#CodeEditorAppImageConfig": { - "type": "structure", - "members": { - "FileSystemConfig": { - "target": "com.amazonaws.sagemaker#FileSystemConfig" - }, - "ContainerConfig": { - "target": "com.amazonaws.sagemaker#ContainerConfig" - } - }, - "traits": { - "smithy.api#documentation": "The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. \n The FileSystemConfig object is not supported.
A list of custom SageMaker images that are configured to run as a Code Editor app.
" - } - }, - "LifecycleConfigArns": { - "target": "com.amazonaws.sagemaker#LifecycleConfigArns", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Code Editor application \n lifecycle configuration.
" - } - }, - "AppLifecycleManagement": { - "target": "com.amazonaws.sagemaker#AppLifecycleManagement", - "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of CodeEditor\n applications.
" - } - }, - "BuiltInLifecycleConfigArn": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", - "traits": { - "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Code Editor application settings.
\nFor more information about Code Editor, see Get started with Code \n Editor in Amazon SageMaker.
" - } - }, - "com.amazonaws.sagemaker#CodeRepositories": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CodeRepository" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#CodeRepository": { - "type": "structure", - "members": { - "RepositoryUrl": { - "target": "com.amazonaws.sagemaker#RepositoryUrl", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The URL of the Git repository.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A Git repository that SageMaker AI automatically displays to users for cloning in the\n JupyterServer application.
" - } - }, - "com.amazonaws.sagemaker#CodeRepositoryArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}$" - } - }, - "com.amazonaws.sagemaker#CodeRepositoryContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.sagemaker#CodeRepositoryNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" - } - }, - "com.amazonaws.sagemaker#CodeRepositorySortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "LAST_MODIFIED_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastModifiedTime" - } - } - } - }, - "com.amazonaws.sagemaker#CodeRepositorySortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.sagemaker#CodeRepositorySummary": { - "type": "structure", - "members": { - "CodeRepositoryName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Git repository.
", - "smithy.api#required": {} - } - }, - "CodeRepositoryArn": { - "target": "com.amazonaws.sagemaker#CodeRepositoryArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Git repository.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the Git repository was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the Git repository was last modified.
", - "smithy.api#required": {} - } - }, - "GitConfig": { - "target": "com.amazonaws.sagemaker#GitConfig", - "traits": { - "smithy.api#documentation": "Configuration details for the Git repository, including the URL where it is located\n and the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies summary information about a Git repository.
" - } - }, - "com.amazonaws.sagemaker#CodeRepositorySummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CodeRepositorySummary" - } - }, - "com.amazonaws.sagemaker#CognitoConfig": { - "type": "structure", - "members": { - "UserPool": { - "target": "com.amazonaws.sagemaker#CognitoUserPool", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A \n user pool is a user directory in Amazon Cognito. \n With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. \n Your users can also sign in through social identity providers like \n Google, Facebook, Amazon, or Apple, and through SAML identity providers.
", - "smithy.api#required": {} - } - }, - "ClientId": { - "target": "com.amazonaws.sagemaker#ClientId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The client ID for your Amazon Cognito user pool.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Use this parameter to configure your Amazon Cognito workforce. \n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.
" - } - }, - "com.amazonaws.sagemaker#CognitoMemberDefinition": { - "type": "structure", - "members": { - "UserPool": { - "target": "com.amazonaws.sagemaker#CognitoUserPool", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An identifier for a user pool. The user pool must be in the same region as the service\n that you are calling.
", - "smithy.api#required": {} - } - }, - "UserGroup": { - "target": "com.amazonaws.sagemaker#CognitoUserGroup", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An identifier for a user group.
", - "smithy.api#required": {} - } - }, - "ClientId": { - "target": "com.amazonaws.sagemaker#ClientId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An identifier for an application client. You must create the app client ID using\n Amazon Cognito.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Identifies a Amazon Cognito user group. A user group can be used in on or more work\n teams.
" - } - }, - "com.amazonaws.sagemaker#CognitoUserGroup": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" - } - }, - "com.amazonaws.sagemaker#CognitoUserPool": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 55 - }, - "smithy.api#pattern": "^[\\w-]+_[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.sagemaker#CollectionConfig": { - "type": "union", - "members": { - "VectorConfig": { - "target": "com.amazonaws.sagemaker#VectorConfig", - "traits": { - "smithy.api#documentation": "Configuration for your vector collection type.
\n\n Dimension: The number of elements in your vector.
Configuration for your collection.
" - } - }, - "com.amazonaws.sagemaker#CollectionConfiguration": { - "type": "structure", - "members": { - "CollectionName": { - "target": "com.amazonaws.sagemaker#CollectionName", - "traits": { - "smithy.api#documentation": "The name of the tensor collection. The name must be unique relative to other rule configuration names.
" - } - }, - "CollectionParameters": { - "target": "com.amazonaws.sagemaker#CollectionParameters", - "traits": { - "smithy.api#documentation": "Parameter values for the tensor collection. The allowed parameters are\n \"name\", \"include_regex\", \"reduction_config\",\n \"save_config\", \"tensor_names\", and\n \"save_histogram\".
Configuration information for the Amazon SageMaker Debugger output tensor collections.
" - } - }, - "com.amazonaws.sagemaker#CollectionConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CollectionConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#CollectionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#CollectionParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#ConfigKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#ConfigValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#CollectionType": { - "type": "enum", - "members": { - "LIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "List" - } - }, - "SET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Set" - } - }, - "VECTOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Vector" - } - } - } - }, - "com.amazonaws.sagemaker#CompilationJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/" - } - }, - "com.amazonaws.sagemaker#CompilationJobStatus": { - "type": "enum", - "members": { - "INPROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INPROGRESS" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.sagemaker#CompilationJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CompilationJobSummary" - } - }, - "com.amazonaws.sagemaker#CompilationJobSummary": { - "type": "structure", - "members": { - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model compilation job that you want a summary for.
", - "smithy.api#required": {} - } - }, - "CompilationJobArn": { - "target": "com.amazonaws.sagemaker#CompilationJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model compilation job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when the model compilation job was created.
", - "smithy.api#required": {} - } - }, - "CompilationStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the model compilation job started.
" - } - }, - "CompilationEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the model compilation job completed.
" - } - }, - "CompilationTargetDevice": { - "target": "com.amazonaws.sagemaker#TargetDevice", - "traits": { - "smithy.api#documentation": "The type of device that the model will run on after the compilation job has\n completed.
" - } - }, - "CompilationTargetPlatformOs": { - "target": "com.amazonaws.sagemaker#TargetPlatformOs", - "traits": { - "smithy.api#documentation": "The type of OS that the model will run on after the compilation job has\n completed.
" - } - }, - "CompilationTargetPlatformArch": { - "target": "com.amazonaws.sagemaker#TargetPlatformArch", - "traits": { - "smithy.api#documentation": "The type of architecture that the model will run on after the compilation job has\n completed.
" - } - }, - "CompilationTargetPlatformAccelerator": { - "target": "com.amazonaws.sagemaker#TargetPlatformAccelerator", - "traits": { - "smithy.api#documentation": "The type of accelerator that the model will run on after the compilation job has\n completed.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "The time when the model compilation job was last modified.
" - } - }, - "CompilationJobStatus": { - "target": "com.amazonaws.sagemaker#CompilationJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the model compilation job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of a model compilation job.
" - } - }, - "com.amazonaws.sagemaker#CompilerOptions": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#CompleteOnConvergence": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - }, - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Enabled" - } - } - } - }, - "com.amazonaws.sagemaker#CompressionType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - }, - "GZIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gzip" - } - } - } - }, - "com.amazonaws.sagemaker#CompressionTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CompressionType" - } - }, - "com.amazonaws.sagemaker#ComputeQuotaArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}$" - } - }, - "com.amazonaws.sagemaker#ComputeQuotaConfig": { - "type": "structure", - "members": { - "ComputeQuotaResources": { - "target": "com.amazonaws.sagemaker#ComputeQuotaResourceConfigList", - "traits": { - "smithy.api#documentation": "Allocate compute resources by instance types.
" - } - }, - "ResourceSharingConfig": { - "target": "com.amazonaws.sagemaker#ResourceSharingConfig", - "traits": { - "smithy.api#documentation": "Resource sharing configuration. This defines how an entity can lend and borrow idle\n compute with other entities within the cluster.
" - } - }, - "PreemptTeamTasks": { - "target": "com.amazonaws.sagemaker#PreemptTeamTasks", - "traits": { - "smithy.api#documentation": "Allows workloads from within an entity to preempt same-team workloads. When set to\n LowerPriority, the entity's lower priority tasks are preempted by their own\n higher priority tasks.
Default is LowerPriority.
Configuration of the compute allocation definition for an entity. This includes the\n resource sharing option and the setting to preempt low priority tasks.
" - } - }, - "com.amazonaws.sagemaker#ComputeQuotaId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-z0-9]{12}$" - } - }, - "com.amazonaws.sagemaker#ComputeQuotaResourceConfig": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.sagemaker#ClusterInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The instance type of the instance group for the cluster.
", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.sagemaker#InstanceCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of instances to add to the instance group of a SageMaker HyperPod\n cluster.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration of the resources used for the compute allocation definition.
" - } - }, - "com.amazonaws.sagemaker#ComputeQuotaResourceConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ComputeQuotaResourceConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 15 - } - } - }, - "com.amazonaws.sagemaker#ComputeQuotaSummary": { - "type": "structure", - "members": { - "ComputeQuotaArn": { - "target": "com.amazonaws.sagemaker#ComputeQuotaArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "ComputeQuotaId": { - "target": "com.amazonaws.sagemaker#ComputeQuotaId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "ComputeQuotaVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "Version of the compute allocation definition.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#documentation": "ARN of the cluster.
" - } - }, - "ComputeQuotaConfig": { - "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", - "traits": { - "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" - } - }, - "ComputeQuotaTarget": { - "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The target entity to allocate compute resources to.
", - "smithy.api#required": {} - } - }, - "ActivationState": { - "target": "com.amazonaws.sagemaker#ActivationState", - "traits": { - "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Creation time of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Last modified time of the compute allocation definition.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summary of the compute allocation definition.
" - } - }, - "com.amazonaws.sagemaker#ComputeQuotaSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ComputeQuotaSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#ComputeQuotaTarget": { - "type": "structure", - "members": { - "TeamName": { - "target": "com.amazonaws.sagemaker#ComputeQuotaTargetTeamName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the team to allocate compute resources to.
", - "smithy.api#required": {} - } - }, - "FairShareWeight": { - "target": "com.amazonaws.sagemaker#FairShareWeight", - "traits": { - "smithy.api#documentation": "Assigned entity fair-share weight. Idle compute will be shared across entities based on\n these assigned weights. This weight is only used when FairShare is\n enabled.
A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The target entity to allocate compute resources to.
" - } - }, - "com.amazonaws.sagemaker#ComputeQuotaTargetTeamName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" - } - }, - "com.amazonaws.sagemaker#ConditionOutcome": { - "type": "enum", - "members": { - "TRUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "True" - } - }, - "FALSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "False" - } - } - } - }, - "com.amazonaws.sagemaker#ConditionStepMetadata": { - "type": "structure", - "members": { - "Outcome": { - "target": "com.amazonaws.sagemaker#ConditionOutcome", - "traits": { - "smithy.api#documentation": "The outcome of the Condition step evaluation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for a Condition step.
" - } - }, - "com.amazonaws.sagemaker#ConfigKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ConfigValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.sagemaker#FailureReason" - } - }, - "traits": { - "smithy.api#documentation": "There was a conflict when you attempted to modify a SageMaker entity such as an\n Experiment or Artifact.
The arguments for the container when you're running the application.
" - } - }, - "ContainerEntrypoint": { - "target": "com.amazonaws.sagemaker#CustomImageContainerEntrypoint", - "traits": { - "smithy.api#documentation": "The entrypoint used to run the application in the container.
" - } - }, - "ContainerEnvironmentVariables": { - "target": "com.amazonaws.sagemaker#CustomImageContainerEnvironmentVariables", - "traits": { - "smithy.api#documentation": "The environment variables to set in the container
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration used to run the application image container.
" - } - }, - "com.amazonaws.sagemaker#ContainerDefinition": { - "type": "structure", - "members": { - "ContainerHostname": { - "target": "com.amazonaws.sagemaker#ContainerHostname", - "traits": { - "smithy.api#documentation": "This parameter is ignored for models that contain only a\n PrimaryContainer.
When a ContainerDefinition is part of an inference pipeline, the value of\n the parameter uniquely identifies the container for the purposes of logging and metrics.\n For information, see Use Logs and Metrics\n to Monitor an Inference Pipeline. If you don't specify a value for this\n parameter for a ContainerDefinition that is part of an inference pipeline,\n a unique name is automatically assigned based on the position of the\n ContainerDefinition in the pipeline. If you specify a value for the\n ContainerHostName for any ContainerDefinition that is part\n of an inference pipeline, you must specify a value for the\n ContainerHostName parameter of every ContainerDefinition\n in that pipeline.
The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.
The model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nSpecifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a\n private Docker registry, see Use a\n Private Docker Registry for Real-Time Inference Containers.
\nThe model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nWhether the container hosts a single model or multiple models.
" - } - }, - "ModelDataUrl": { - "target": "com.amazonaws.sagemaker#Url", - "traits": { - "smithy.api#documentation": "The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.
\nThe model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.
\nIf you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token\n Service to download model artifacts from the S3 path you provide. Amazon Web Services STS\n is activated in your Amazon Web Services account by default. If you previously\n deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nIf you use a built-in algorithm to create a model, SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.
Specifies the location of ML model data to deploy.
\nCurrently you cannot use ModelDataSource in conjunction with SageMaker\n batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.
Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.
The environment variables to set in the Docker container. Don't include any\n sensitive data in your environment variables.
\nThe maximum length of each key and value in the Environment map is\n 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If\n you pass multiple containers to a CreateModel request, then the maximum\n length of all of their maps, combined, is also 32 KB.
The name or Amazon Resource Name (ARN) of the model package to use to create the\n model.
" - } - }, - "InferenceSpecificationName": { - "target": "com.amazonaws.sagemaker#InferenceSpecificationName", - "traits": { - "smithy.api#documentation": "The inference specification name in the model package version.
" - } - }, - "MultiModelConfig": { - "target": "com.amazonaws.sagemaker#MultiModelConfig", - "traits": { - "smithy.api#documentation": "Specifies additional configuration for multi-model endpoints.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the container, as part of model definition.
" - } - }, - "com.amazonaws.sagemaker#ContainerDefinitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ContainerDefinition" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 15 - } - } - }, - "com.amazonaws.sagemaker#ContainerEntrypoint": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ContainerEntrypointString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#ContainerEntrypointString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ContainerHostname": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#ContainerImage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.sagemaker#ContainerMode": { - "type": "enum", - "members": { - "SINGLE_MODEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SingleModel" - } - }, - "MULTI_MODEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MultiModel" - } - } - } - }, - "com.amazonaws.sagemaker#ContentClassifier": { - "type": "enum", - "members": { - "FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FreeOfPersonallyIdentifiableInformation" - } - }, - "FREE_OF_ADULT_CONTENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FreeOfAdultContent" - } - } - } - }, - "com.amazonaws.sagemaker#ContentClassifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ContentClassifier" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#ContentColumn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#ContentDigest": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 72 - }, - "smithy.api#pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" - } - }, - "com.amazonaws.sagemaker#ContentType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ContentTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ContentType" - } - }, - "com.amazonaws.sagemaker#ContextArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/" - } - }, - "com.amazonaws.sagemaker#ContextName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 120 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}$" - } - }, - "com.amazonaws.sagemaker#ContextNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context\\/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119})$" - } - }, - "com.amazonaws.sagemaker#ContextSource": { - "type": "structure", - "members": { - "SourceUri": { - "target": "com.amazonaws.sagemaker#SourceUri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The URI of the source.
", - "smithy.api#required": {} - } - }, - "SourceType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The type of the source.
" - } - }, - "SourceId": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The ID of the source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure describing the source of a context.
" - } - }, - "com.amazonaws.sagemaker#ContextSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ContextSummary" - } - }, - "com.amazonaws.sagemaker#ContextSummary": { - "type": "structure", - "members": { - "ContextArn": { - "target": "com.amazonaws.sagemaker#ContextArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" - } - }, - "ContextName": { - "target": "com.amazonaws.sagemaker#ContextName", - "traits": { - "smithy.api#documentation": "The name of the context.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ContextSource", - "traits": { - "smithy.api#documentation": "The source of the context.
" - } - }, - "ContextType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The type of the context.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the context was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the context was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Lists a summary of the properties of a context. A context provides a logical grouping\n of other entities.
" - } - }, - "com.amazonaws.sagemaker#ContinuousParameterRange": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#ParameterKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the continuous hyperparameter to tune.
", - "smithy.api#required": {} - } - }, - "MinValue": { - "target": "com.amazonaws.sagemaker#ParameterValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The minimum value for the hyperparameter.\n The\n tuning job uses floating-point values between this value and MaxValuefor\n tuning.
The maximum value for the hyperparameter. The tuning job uses floating-point values\n between MinValue value and this value for tuning.
The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
\nSageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.
\nLogarithmic scaling works only for ranges that have only values greater\n than 0.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.
\nReverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.
\nA list of continuous hyperparameters to tune.
" - } - }, - "com.amazonaws.sagemaker#ContinuousParameterRangeSpecification": { - "type": "structure", - "members": { - "MinValue": { - "target": "com.amazonaws.sagemaker#ParameterValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The minimum floating-point value allowed.
", - "smithy.api#required": {} - } - }, - "MaxValue": { - "target": "com.amazonaws.sagemaker#ParameterValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum floating-point value allowed.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the possible values for a continuous hyperparameter.
" - } - }, - "com.amazonaws.sagemaker#ContinuousParameterRanges": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ContinuousParameterRange" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.sagemaker#ConvergenceDetected": { - "type": "structure", - "members": { - "CompleteOnConvergence": { - "target": "com.amazonaws.sagemaker#CompleteOnConvergence", - "traits": { - "smithy.api#documentation": "A flag to stop a tuning job once AMT has detected that the job has converged.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A flag to indicating that automatic model tuning (AMT) has detected model convergence,\n defined as a lack of significant improvement (1% or less) against an objective\n metric.
" - } - }, - "com.amazonaws.sagemaker#CountryCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - }, - "smithy.api#pattern": "^[A-Z]{2}$" - } - }, - "com.amazonaws.sagemaker#CreateAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateActionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateActionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an action. An action is a lineage tracking entity that\n represents an action or activity. For example, a model deployment or an HPO job.\n Generally, an action involves at least one input or output artifact. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" - } - }, - "com.amazonaws.sagemaker#CreateActionRequest": { - "type": "structure", - "members": { - "ActionName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the action. Must be unique to your account in an Amazon Web Services Region.
", - "smithy.api#required": {} - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ActionSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The source type, ID, and URI.
", - "smithy.api#required": {} - } - }, - "ActionType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The action type.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ExperimentDescription", - "traits": { - "smithy.api#documentation": "The description of the action.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#ActionStatus", - "traits": { - "smithy.api#documentation": "The status of the action.
" - } - }, - "Properties": { - "target": "com.amazonaws.sagemaker#LineageEntityParameters", - "traits": { - "smithy.api#documentation": "A list of properties to add to the action.
" - } - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags to apply to the action.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateActionResponse": { - "type": "structure", - "members": { - "ActionArn": { - "target": "com.amazonaws.sagemaker#ActionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateAlgorithm": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateAlgorithmInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateAlgorithmOutput" - }, - "traits": { - "smithy.api#documentation": "Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
" - } - }, - "com.amazonaws.sagemaker#CreateAlgorithmInput": { - "type": "structure", - "members": { - "AlgorithmName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the algorithm.
", - "smithy.api#required": {} - } - }, - "AlgorithmDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A description of the algorithm.
" - } - }, - "TrainingSpecification": { - "target": "com.amazonaws.sagemaker#TrainingSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies details about training jobs run by this algorithm, including the\n following:
\nThe Amazon ECR path of the container and the version digest of the\n algorithm.
\nThe hyperparameters that the algorithm supports.
\nThe instance types that the algorithm supports for training.
\nWhether the algorithm supports distributed training.
\nThe metrics that the algorithm emits to Amazon CloudWatch.
\nWhich metrics that the algorithm emits can be used as the objective metric for\n hyperparameter tuning jobs.
\nThe input channels that the algorithm supports for training data. For example,\n an algorithm might support train, validation, and\n test channels.
Specifies details about inference jobs that the algorithm runs, including the\n following:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the algorithm supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the algorithm supports for\n inference.
\nSpecifies configurations for one or more training jobs and that SageMaker runs to test the\n algorithm's training code and, optionally, one or more batch transform jobs that SageMaker\n runs to test the algorithm's inference code.
" - } - }, - "CertifyForMarketplace": { - "target": "com.amazonaws.sagemaker#CertifyForMarketplace", - "traits": { - "smithy.api#documentation": "Whether to certify the algorithm so that it can be listed in Amazon Web Services\n Marketplace.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateAlgorithmOutput": { - "type": "structure", - "members": { - "AlgorithmArn": { - "target": "com.amazonaws.sagemaker#AlgorithmArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new algorithm.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateAppRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active\n simultaneously.
" - } - }, - "com.amazonaws.sagemaker#CreateAppImageConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateAppImageConfigRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateAppImageConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - } - ], - "traits": { - "smithy.api#documentation": "Creates a configuration for running a SageMaker AI image as a KernelGateway app. The\n configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the\n kernels in the image.
" - } - }, - "com.amazonaws.sagemaker#CreateAppImageConfigRequest": { - "type": "structure", - "members": { - "AppImageConfigName": { - "target": "com.amazonaws.sagemaker#AppImageConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the AppImageConfig. Must be unique to your account.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags to apply to the AppImageConfig.
" - } - }, - "KernelGatewayImageConfig": { - "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", - "traits": { - "smithy.api#documentation": "The KernelGatewayImageConfig. You can only specify one image kernel in the \n AppImageConfig API. This kernel will be shown to users before the \n image starts. Once the image runs, all kernels are visible in JupyterLab.
" - } - }, - "JupyterLabAppImageConfig": { - "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", - "traits": { - "smithy.api#documentation": "The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.
The CodeEditorAppImageConfig. You can only specify one image kernel \n in the AppImageConfig API. This kernel is shown to users before the image starts. \n After the image runs, all kernels are visible in Code Editor.
The ARN of the AppImageConfig.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateAppRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The domain ID.
", - "smithy.api#required": {} - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be\n set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
The type of app.
", - "smithy.api#required": {} - } - }, - "AppName": { - "target": "com.amazonaws.sagemaker#AppName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" - } - }, - "ResourceSpec": { - "target": "com.amazonaws.sagemaker#ResourceSpec", - "traits": { - "smithy.api#documentation": "The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image\n created on the instance.
\nThe value of InstanceType passed as part of the ResourceSpec\n in the CreateApp call overrides the value passed as part of the\n ResourceSpec configured for the user profile or the domain. If\n InstanceType is not specified in any of those three ResourceSpec\n values for a KernelGateway app, the CreateApp call fails with a\n request validation error.
The Amazon Resource Name (ARN) of the app.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateArtifact": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateArtifactRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateArtifactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an artifact. An artifact is a lineage tracking entity that\n represents a URI addressable object or data. Some examples are the S3 URI of a dataset and\n the ECR registry path of an image. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" - } - }, - "com.amazonaws.sagemaker#CreateArtifactRequest": { - "type": "structure", - "members": { - "ArtifactName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the artifact. Must be unique to your account in an Amazon Web Services Region.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ArtifactSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID, ID type, and URI of the source.
", - "smithy.api#required": {} - } - }, - "ArtifactType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The artifact type.
", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.sagemaker#ArtifactProperties", - "traits": { - "smithy.api#documentation": "A list of properties to add to the artifact.
" - } - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags to apply to the artifact.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateArtifactResponse": { - "type": "structure", - "members": { - "ArtifactArn": { - "target": "com.amazonaws.sagemaker#ArtifactArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateAutoMLJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateAutoMLJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateAutoMLJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
\nAn AutoML job in SageMaker AI is a fully automated process that allows you to build machine\n learning models with minimal effort and machine learning expertise. When initiating an\n AutoML job, you provide your data and optionally specify parameters tailored to your use\n case. SageMaker AI then automates the entire model development lifecycle, including data\n preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify\n and accelerate the model building process by automating various tasks and exploring\n different combinations of machine learning algorithms, data preprocessing techniques, and\n hyperparameter values. The output of an AutoML job comprises one or more trained models\n ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate\n model leaderboard, allowing you to select the best-performing model for deployment.
\nFor more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html\n in the SageMaker AI developer guide.
\nWe recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.
\n\n CreateAutoMLJobV2 can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob, as well as time-series forecasting,\n non-tabular problem types such as image or text classification, and text generation\n (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.
" - } - }, - "com.amazonaws.sagemaker#CreateAutoMLJobRequest": { - "type": "structure", - "members": { - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies an Autopilot job. The name must be unique to your account and is case\n insensitive.
", - "smithy.api#required": {} - } - }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of channel objects that describes the input data and its location. Each channel\n is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A\n minimum of 500 rows is required for the training dataset. There is not a minimum number of\n rows required for the validation dataset.
Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job. Format(s) supported: CSV.
", - "smithy.api#required": {} - } - }, - "ProblemType": { - "target": "com.amazonaws.sagemaker#ProblemType", - "traits": { - "smithy.api#documentation": "Defines the type of supervised learning problem available for the candidates. For more\n information, see \n SageMaker Autopilot problem types.
" - } - }, - "AutoMLJobObjective": { - "target": "com.amazonaws.sagemaker#AutoMLJobObjective", - "traits": { - "smithy.api#documentation": "Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.
" - } - }, - "AutoMLJobConfig": { - "target": "com.amazonaws.sagemaker#AutoMLJobConfig", - "traits": { - "smithy.api#documentation": "A collection of settings used to configure an AutoML job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the role that is used to access the data.
", - "smithy.api#required": {} - } - }, - "GenerateCandidateDefinitionsOnly": { - "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", - "traits": { - "smithy.api#documentation": "Generates possible candidates without training the models. A candidate is a combination\n of data preprocessors, algorithms, and algorithm parameter settings.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per\n resource.
" - } - }, - "ModelDeployConfig": { - "target": "com.amazonaws.sagemaker#ModelDeployConfig", - "traits": { - "smithy.api#documentation": "Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateAutoMLJobResponse": { - "type": "structure", - "members": { - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique ARN assigned to the AutoML job when it is created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateAutoMLJobV2": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateAutoMLJobV2Request" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateAutoMLJobV2Response" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
\nAn AutoML job in SageMaker AI is a fully automated process that allows you to build machine\n learning models with minimal effort and machine learning expertise. When initiating an\n AutoML job, you provide your data and optionally specify parameters tailored to your use\n case. SageMaker AI then automates the entire model development lifecycle, including data\n preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify\n and accelerate the model building process by automating various tasks and exploring\n different combinations of machine learning algorithms, data preprocessing techniques, and\n hyperparameter values. The output of an AutoML job comprises one or more trained models\n ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate\n model leaderboard, allowing you to select the best-performing model for deployment.
\nFor more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html\n in the SageMaker AI developer guide.
\nAutoML jobs V2 support various problem types such as regression, binary, and multiclass\n classification with tabular data, text and image classification, time-series forecasting,\n and fine-tuning of large language models (LLMs) for text generation.
\n\n CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob\n and DescribeAutoMLJob which offer backward compatibility.
\n\n CreateAutoMLJobV2 can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob, as well as time-series forecasting,\n non-tabular problem types such as image or text classification, and text generation\n (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
For the list of available problem types supported by CreateAutoMLJobV2, see\n AutoMLProblemTypeConfig.
You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.
" - } - }, - "com.amazonaws.sagemaker#CreateAutoMLJobV2Request": { - "type": "structure", - "members": { - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies an Autopilot job. The name must be unique to your account and is case\n insensitive.
", - "smithy.api#required": {} - } - }, - "AutoMLJobInputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLJobInputDataConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of channel objects describing the input data and their location. Each channel\n is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters.\n The supported formats depend on the problem type:
For tabular problem types: S3Prefix,\n ManifestFile.
For image classification: S3Prefix, ManifestFile,\n AugmentedManifestFile.
For text classification: S3Prefix.
For time-series forecasting: S3Prefix.
For text generation (LLMs fine-tuning): S3Prefix.
Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job.
", - "smithy.api#required": {} - } - }, - "AutoMLProblemTypeConfig": { - "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Defines the configuration settings of one of the supported problem types.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the role that is used to access the data.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, such as by purpose, owner, or environment. For more\n information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per\n resource.
" - } - }, - "SecurityConfig": { - "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", - "traits": { - "smithy.api#documentation": "The security configuration for traffic encryption or Amazon VPC settings.
" - } - }, - "AutoMLJobObjective": { - "target": "com.amazonaws.sagemaker#AutoMLJobObjective", - "traits": { - "smithy.api#documentation": "Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. For the list of default values\n per problem type, see AutoMLJobObjective.
\nFor tabular problem types: You must either provide both the\n AutoMLJobObjective and indicate the type of supervised learning\n problem in AutoMLProblemTypeConfig\n (TabularJobConfig.ProblemType), or none at all.
For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.
Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.
" - } - }, - "DataSplitConfig": { - "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", - "traits": { - "smithy.api#documentation": "This structure specifies how to split the data into train and validation\n datasets.
\nThe validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.
This attribute must not be set for the time-series forecasting problem type, as Autopilot\n automatically splits the input dataset into training and validation sets.
\nSpecifies the compute configuration for the AutoML job V2.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateAutoMLJobV2Response": { - "type": "structure", - "members": { - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique ARN assigned to the AutoMLJob when it is created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateClusterRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the\n Amazon SageMaker Developer Guide.
" - } - }, - "com.amazonaws.sagemaker#CreateClusterRequest": { - "type": "structure", - "members": { - "ClusterName": { - "target": "com.amazonaws.sagemaker#ClusterName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name for the new SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "InstanceGroups": { - "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The instance groups to be created in the SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging\n Amazon Web Services Resources User Guide.
" - } - }, - "Orchestrator": { - "target": "com.amazonaws.sagemaker#ClusterOrchestrator", - "traits": { - "smithy.api#documentation": "The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported\n value is \"eks\", which is to use an Amazon Elastic Kubernetes Service (EKS)\n cluster as the orchestrator.
The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic,\n SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set\n to None, cluster administrators will need to manually manage any faulty\n cluster instances.
The Amazon Resource Name (ARN) of the cluster.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateClusterSchedulerConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfigRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Create cluster policy configuration. This policy is used for task prioritization and\n fair-share allocation of idle compute. This helps prioritize critical workloads and distributes\n idle compute across entities.
" - } - }, - "com.amazonaws.sagemaker#CreateClusterSchedulerConfigRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name for the cluster policy.
", - "smithy.api#required": {} - } - }, - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the cluster.
", - "smithy.api#required": {} - } - }, - "SchedulerConfig": { - "target": "com.amazonaws.sagemaker#SchedulerConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configuration about the monitoring schedule.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "Description of the cluster policy.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Tags of the cluster policy.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateClusterSchedulerConfigResponse": { - "type": "structure", - "members": { - "ClusterSchedulerConfigArn": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the cluster policy.
", - "smithy.api#required": {} - } - }, - "ClusterSchedulerConfigId": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the cluster policy.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateCodeRepository": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateCodeRepositoryInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateCodeRepositoryOutput" - }, - "traits": { - "smithy.api#documentation": "Creates a Git repository as a resource in your SageMaker AI account. You can\n associate the repository with notebook instances so that you can use Git source control\n for the notebooks you create. The Git repository is a resource in your SageMaker AI\n account, so it can be associated with more than one notebook instance, and it persists\n independently from the lifecycle of any notebook instances it is associated with.
\nThe repository can be hosted either in Amazon Web Services CodeCommit\n or in any other Git repository.
" - } - }, - "com.amazonaws.sagemaker#CreateCodeRepositoryInput": { - "type": "structure", - "members": { - "CodeRepositoryName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Git repository. The name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).
", - "smithy.api#required": {} - } - }, - "GitConfig": { - "target": "com.amazonaws.sagemaker#GitConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies details about the repository, including the URL where the repository is\n located, the default branch, and credentials to use to access the repository.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateCodeRepositoryOutput": { - "type": "structure", - "members": { - "CodeRepositoryArn": { - "target": "com.amazonaws.sagemaker#CodeRepositoryArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new repository.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateCompilationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateCompilationJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateCompilationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI saves the\n resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
\nIf\n you choose to host your model using Amazon SageMaker AI hosting services, you can use the resulting\n model artifacts as part of the model. You can also use the artifacts with\n Amazon Web Services IoT Greengrass. In that case, deploy them as an ML\n resource.
\nIn the request body, you provide the following:
\nA name for the compilation job
\nInformation about the input model artifacts
\nThe output location for the compiled model and the device (target) that the\n model runs on
\nThe Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker AI assumes to perform\n the model compilation job.
\nYou can also provide a Tag to track the model compilation job's resource\n use and costs. The response body contains the\n CompilationJobArn\n for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation\n job, use DescribeCompilationJob. To get information about multiple model compilation\n jobs, use ListCompilationJobs.
" - } - }, - "com.amazonaws.sagemaker#CreateCompilationJobRequest": { - "type": "structure", - "members": { - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on\n your behalf.
\nDuring model compilation, Amazon SageMaker AI needs your permission to:
\nRead input data from an S3 bucket
\nWrite model artifacts to an S3 bucket
\nWrite logs to Amazon CloudWatch Logs
\nPublish metrics to Amazon CloudWatch
\nYou grant permissions for all of these tasks to an IAM role. To pass this role to\n Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For\n more information, see Amazon SageMaker AI\n Roles.\n
The Amazon Resource Name (ARN) of a versioned model package. Provide either a \n ModelPackageVersionArn or an InputConfig object in the \n request syntax. The presence of both objects in the CreateCompilationJob \n request will return an exception.
Provides information about the location of input model artifacts, the name and shape\n of the expected data inputs, and the framework in which the model was trained.
" - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#OutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Provides information about the output location for the compiled model and the target\n device the model runs on.
", - "smithy.api#required": {} - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#NeoVpcConfig", - "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your compilation job\n to connect to. Control access to your models by configuring the VPC. For more\n information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
" - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model compilation job can run. When the job reaches\n the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training\n costs.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateCompilationJobResponse": { - "type": "structure", - "members": { - "CompilationJobArn": { - "target": "com.amazonaws.sagemaker#CompilationJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker AI returns\n the following data in JSON format:
\n\n CompilationJobArn: The Amazon Resource Name (ARN) of the compiled\n job.
Create compute allocation definition. This defines how compute is allocated, shared, and\n borrowed for specified entities. Specifically, how to lend and borrow idle compute and\n assign a fair-share weight to the specified entities.
" - } - }, - "com.amazonaws.sagemaker#CreateComputeQuotaRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name to the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "Description of the compute allocation definition.
" - } - }, - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the cluster.
", - "smithy.api#required": {} - } - }, - "ComputeQuotaConfig": { - "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
", - "smithy.api#required": {} - } - }, - "ComputeQuotaTarget": { - "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The target entity to allocate compute resources to.
", - "smithy.api#required": {} - } - }, - "ActivationState": { - "target": "com.amazonaws.sagemaker#ActivationState", - "traits": { - "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Tags of the compute allocation definition.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateComputeQuotaResponse": { - "type": "structure", - "members": { - "ComputeQuotaArn": { - "target": "com.amazonaws.sagemaker#ComputeQuotaArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "ComputeQuotaId": { - "target": "com.amazonaws.sagemaker#ComputeQuotaId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the compute allocation definition.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateContext": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateContextRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateContextResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a context. A context is a lineage tracking entity that\n represents a logical grouping of other tracking or experiment entities. Some examples are\n an endpoint and a model package. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" - } - }, - "com.amazonaws.sagemaker#CreateContextRequest": { - "type": "structure", - "members": { - "ContextName": { - "target": "com.amazonaws.sagemaker#ContextName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the context. Must be unique to your account in an Amazon Web Services Region.
", - "smithy.api#required": {} - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ContextSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The source type, ID, and URI.
", - "smithy.api#required": {} - } - }, - "ContextType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The context type.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ExperimentDescription", - "traits": { - "smithy.api#documentation": "The description of the context.
" - } - }, - "Properties": { - "target": "com.amazonaws.sagemaker#LineageEntityParameters", - "traits": { - "smithy.api#documentation": "A list of properties to add to the context.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags to apply to the context.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateContextResponse": { - "type": "structure", - "members": { - "ContextArn": { - "target": "com.amazonaws.sagemaker#ContextArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateDataQualityJobDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a definition for a job that monitors data quality and drift. For information\n about model monitor, see Amazon SageMaker AI Model\n Monitor.
" - } - }, - "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name for the monitoring job definition.
", - "smithy.api#required": {} - } - }, - "DataQualityBaselineConfig": { - "target": "com.amazonaws.sagemaker#DataQualityBaselineConfig", - "traits": { - "smithy.api#documentation": "Configures the constraints and baselines for the monitoring job.
" - } - }, - "DataQualityAppSpecification": { - "target": "com.amazonaws.sagemaker#DataQualityAppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the container that runs the monitoring job.
", - "smithy.api#required": {} - } - }, - "DataQualityJobInput": { - "target": "com.amazonaws.sagemaker#DataQualityJobInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of inputs for the monitoring job. Currently endpoints are supported as monitoring\n inputs.
", - "smithy.api#required": {} - } - }, - "DataQualityJobOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "JobResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", - "traits": { - "smithy.api#documentation": "Specifies networking configuration for the monitoring job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionResponse": { - "type": "structure", - "members": { - "JobDefinitionArn": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job definition.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateDeviceFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateDeviceFleetRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a device fleet.
" - } - }, - "com.amazonaws.sagemaker#CreateDeviceFleetRequest": { - "type": "structure", - "members": { - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet that the device belongs to.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#DeviceFleetDescription", - "traits": { - "smithy.api#documentation": "A description of the fleet.
" - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#EdgeOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The output configuration for storing sample data collected by the fleet.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Creates tags for the specified fleet.
" - } - }, - "EnableIotRoleAlias": { - "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", - "traits": { - "smithy.api#documentation": "Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".
\nFor example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateDomainRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateDomainResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a Domain. A domain consists of an associated Amazon Elastic File System\n volume, a list of authorized users, and a variety of security, application, policy, and\n Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files\n and other artifacts with each other.
\n EFS storage\n
\nWhen a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks, Git\n repositories, and data files.
\nSageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services\n KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key\n by default. For more control, you can specify a customer managed key. For more information,\n see Protect Data\n at Rest Using Encryption.
\n\n VPC configuration\n
\nAll traffic between the domain and the Amazon EFS volume is through the specified\n VPC and subnets. For other traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to the domain. The following options are available:
\n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker AI, which allows internet access. This is the default value.
\n VpcOnly - All traffic is through the specified VPC and subnets. Internet\n access is disabled by default. To allow internet access, you must specify a NAT\n gateway.
When internet access is disabled, you won't be able to run a Amazon SageMaker AI\n Studio notebook or to train or host models unless your VPC has an interface endpoint to\n the SageMaker AI API and runtime or a NAT gateway and your security groups allow\n outbound connections.
\nNFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a Amazon SageMaker AI Studio app successfully.
\nFor more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.
" - } - }, - "com.amazonaws.sagemaker#CreateDomainRequest": { - "type": "structure", - "members": { - "DomainName": { - "target": "com.amazonaws.sagemaker#DomainName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A name for the domain.
", - "smithy.api#required": {} - } - }, - "AuthMode": { - "target": "com.amazonaws.sagemaker#AuthMode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The mode of authentication that members use to access the domain.
", - "smithy.api#required": {} - } - }, - "DefaultUserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The default settings to use to create a user profile when UserSettings isn't\n specified in the call to the CreateUserProfile API.
\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.
A collection of Domain settings.
The VPC subnets that the domain uses for communication.
", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.sagemaker#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag\n keys must be unique per resource. Tags are searchable using the Search\n API.
Tags that you specify for the Domain are also added to all Apps that the Domain\n launches.
" - } - }, - "AppNetworkAccessType": { - "target": "com.amazonaws.sagemaker#AppNetworkAccessType", - "traits": { - "smithy.api#documentation": "Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Use KmsKeyId.
SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to\n the domain with an Amazon Web Services managed key by default. For more control, specify a\n customer managed key.
" - } - }, - "AppSecurityGroupManagement": { - "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", - "traits": { - "smithy.api#documentation": "The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.
Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.
The default settings for shared spaces that users create in the domain.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateDomainResponse": { - "type": "structure", - "members": { - "DomainArn": { - "target": "com.amazonaws.sagemaker#DomainArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created domain.
" - } - }, - "Url": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The URL to the created domain.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateEdgeDeploymentPlan": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an edge deployment plan, consisting of multiple stages. Each stage may have a\n different deployment configuration and devices.
" - } - }, - "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanRequest": { - "type": "structure", - "members": { - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "ModelConfigs": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentModelConfigs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List of models associated with the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The device fleet used for this edge deployment plan.
", - "smithy.api#required": {} - } - }, - "Stages": { - "target": "com.amazonaws.sagemaker#DeploymentStages", - "traits": { - "smithy.api#documentation": "List of stages of the edge deployment plan. The number of stages is limited to 10 per\n deployment.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "List of tags with which to tag the edge deployment plan.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanResponse": { - "type": "structure", - "members": { - "EdgeDeploymentPlanArn": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the edge deployment plan.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateEdgeDeploymentStage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentStageRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new stage in an existing edge deployment plan.
" - } - }, - "com.amazonaws.sagemaker#CreateEdgeDeploymentStageRequest": { - "type": "structure", - "members": { - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "Stages": { - "target": "com.amazonaws.sagemaker#DeploymentStages", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List of stages to be added to the edge deployment plan.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateEdgePackagingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateEdgePackagingJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
" - } - }, - "com.amazonaws.sagemaker#CreateEdgePackagingJobRequest": { - "type": "structure", - "members": { - "EdgePackagingJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge packaging job.
", - "smithy.api#required": {} - } - }, - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
", - "smithy.api#required": {} - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model.
", - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.sagemaker#EdgeVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the model.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.
", - "smithy.api#required": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#EdgeOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Provides information about the output location for the packaged model.
", - "smithy.api#required": {} - } - }, - "ResourceKey": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Creates tags for the packaging job.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateEndpointInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateEndpointOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.
\nUse this API to deploy models using SageMaker hosting services.
\n You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.
\nWhen it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.
\nWhen you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services\n account by default. If you previously deactivated Amazon Web Services STS for a region,\n you need to reactivate Amazon Web Services STS for that region. For more information, see\n Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nTo add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the\n role.
\nOption 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:
\n\n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n
\n \"Resource\": [\n
\n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n
\n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n
\n ]\n
For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.
\nCreates an endpoint configuration that SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want SageMaker to\n provision. Then you call the CreateEndpoint\n API.
Use this API if you want to use SageMaker hosting services to deploy models into\n production.
\nIn the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.
The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
", - "smithy.api#required": {} - } - }, - "ProductionVariants": { - "target": "com.amazonaws.sagemaker#ProductionVariantList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that\n hosts the endpoint.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n
Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nSpecifies configuration for how an endpoint performs asynchronous inference. This is a\n required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
" - } - }, - "ExplainerConfig": { - "target": "com.amazonaws.sagemaker#ExplainerConfig", - "traits": { - "smithy.api#documentation": "A member of CreateEndpointConfig that enables explainers.
An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants. If you use this field, you can only\n specify one variant for ProductionVariants and one variant for\n ShadowProductionVariants.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. For more information, see SageMaker AI\n Roles.
\nTo be able to pass this role to Amazon SageMaker AI, the caller of this action must\n have the iam:PassRole permission.
Sets whether all model containers deployed to the endpoint are isolated. If they are, no\n inbound or outbound network calls can be made to or from the model containers.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateEndpointConfigOutput": { - "type": "structure", - "members": { - "EndpointConfigArn": { - "target": "com.amazonaws.sagemaker#EndpointConfigArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateEndpointInput": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint.The name must be unique within an Amazon Web Services\n Region in your Amazon Web Services account. The name is case-insensitive in\n CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.
The name of an endpoint configuration. For more information, see CreateEndpointConfig.
", - "smithy.api#required": {} - } - }, - "DeploymentConfig": { - "target": "com.amazonaws.sagemaker#DeploymentConfig" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateEndpointOutput": { - "type": "structure", - "members": { - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateExperimentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.
\nIn the Studio UI, trials are referred to as run groups and trial\n components are referred to as runs.
\nThe goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
\nTo add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
" - } - }, - "com.amazonaws.sagemaker#CreateExperimentRequest": { - "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the experiment. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment as displayed. The name doesn't need to be unique. If you don't\n specify DisplayName, the value in ExperimentName is\n displayed.
The description of the experiment.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags to associate with the experiment. You can use Search API\n to search on the tags.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateExperimentResponse": { - "type": "structure", - "members": { - "ExperimentArn": { - "target": "com.amazonaws.sagemaker#ExperimentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateFeatureGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateFeatureGroupRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateFeatureGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Create a new FeatureGroup. A FeatureGroup is a group of\n Features defined in the FeatureStore to describe a\n Record.
The FeatureGroup defines the schema and features contained in the\n FeatureGroup. A FeatureGroup definition is composed of a list\n of Features, a RecordIdentifierFeatureName, an\n EventTimeFeatureName and configurations for its OnlineStore\n and OfflineStore. Check Amazon Web Services service\n quotas to see the FeatureGroups quota for your Amazon Web Services\n account.
Note that it can take approximately 10-15 minutes to provision an\n OnlineStore\n FeatureGroup with the InMemory\n StorageType.
You must include at least one of OnlineStoreConfig and\n OfflineStoreConfig to create a FeatureGroup.
The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
The name:
\nMust start with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe name of the Feature whose value uniquely identifies a\n Record defined in the FeatureStore. Only the latest record per\n identifier value will be stored in the OnlineStore.\n RecordIdentifierFeatureName must be one of feature definitions'\n names.
You use the RecordIdentifierFeatureName to access data in a\n FeatureStore.
This name:
\nMust start with an alphanumeric character.
\nCan only contains alphanumeric characters, hyphens, underscores. Spaces are not\n allowed.
\nThe name of the feature that stores the EventTime of a Record\n in a FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds to\n the creation or update of a Record in a FeatureGroup. All\n Records in the FeatureGroup must have a corresponding\n EventTime.
An EventTime can be a String or Fractional.
\n Fractional: EventTime feature values must be a Unix\n timestamp in seconds.
\n String: EventTime feature values must be an ISO-8601\n string in the format. The following formats are supported\n yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ\n where yyyy, MM, and dd represent the year,\n month, and day respectively and HH, mm, ss,\n and if applicable, SSS represent the hour, month, second and\n milliseconds respsectively. 'T' and Z are constants.
A list of Feature names and types. Name and Type\n is compulsory per Feature.
Valid feature FeatureTypes are Integral,\n Fractional and String.
\n FeatureNames cannot be any of the following: is_deleted,\n write_time, api_invocation_time\n
You can create up to 2,500 FeatureDefinitions per\n FeatureGroup.
You can turn the OnlineStore on or off by specifying True for\n the EnableOnlineStore flag in OnlineStoreConfig.
You can also include an Amazon Web Services KMS key ID (KMSKeyId) for\n at-rest encryption of the OnlineStore.
The default value is False.
Use this to configure an OfflineFeatureStore. This parameter allows you to\n specify:
The Amazon Simple Storage Service (Amazon S3) location of an\n OfflineStore.
A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data\n catalog.
\nAn KMS encryption key to encrypt the Amazon S3 location used for\n OfflineStore. If KMS encryption key is not specified, by default we\n encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level\n key for SSE, you can reduce Amazon Web Services KMS requests costs by up to\n 99 percent.
Format for the offline store table. Supported formats are Glue (Default) and\n Apache Iceberg.
\nTo learn more about this parameter, see OfflineStoreConfig.
" - } - }, - "ThroughputConfig": { - "target": "com.amazonaws.sagemaker#ThroughputConfig" - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the\n OfflineStore if an OfflineStoreConfig is provided.
A free-form description of a FeatureGroup.
Tags used to identify Features in each FeatureGroup.
The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique\n identifier for the feature group.
Creates a flow definition.
" - } - }, - "com.amazonaws.sagemaker#CreateFlowDefinitionRequest": { - "type": "structure", - "members": { - "FlowDefinitionName": { - "target": "com.amazonaws.sagemaker#FlowDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of your flow definition.
", - "smithy.api#required": {} - } - }, - "HumanLoopRequestSource": { - "target": "com.amazonaws.sagemaker#HumanLoopRequestSource", - "traits": { - "smithy.api#documentation": "Container for configuring the source of human task requests. Use to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.
" - } - }, - "HumanLoopActivationConfig": { - "target": "com.amazonaws.sagemaker#HumanLoopActivationConfig", - "traits": { - "smithy.api#documentation": "An object containing information about the events that trigger a human workflow.
" - } - }, - "HumanLoopConfig": { - "target": "com.amazonaws.sagemaker#HumanLoopConfig", - "traits": { - "smithy.api#documentation": "An object containing information about the tasks the human reviewers will perform.
" - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An object containing information about where the human review results will be uploaded.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateFlowDefinitionResponse": { - "type": "structure", - "members": { - "FlowDefinitionArn": { - "target": "com.amazonaws.sagemaker#FlowDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow definition you create.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateHub": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateHubRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateHubResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Create a hub.
" - } - }, - "com.amazonaws.sagemaker#CreateHubContentReference": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateHubContentReferenceRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateHubContentReferenceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.
" - } - }, - "com.amazonaws.sagemaker#CreateHubContentReferenceRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub to add the hub content reference to.
", - "smithy.api#required": {} - } - }, - "SageMakerPublicHubContentArn": { - "target": "com.amazonaws.sagemaker#SageMakerPublicHubContentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the public hub content to reference.
", - "smithy.api#required": {} - } - }, - "HubContentName": { - "target": "com.amazonaws.sagemaker#HubContentName", - "traits": { - "smithy.api#documentation": "The name of the hub content to reference.
" - } - }, - "MinVersion": { - "target": "com.amazonaws.sagemaker#HubContentVersion", - "traits": { - "smithy.api#documentation": "The minimum version of the hub content to reference.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Any tags associated with the hub content to reference.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateHubContentReferenceResponse": { - "type": "structure", - "members": { - "HubArn": { - "target": "com.amazonaws.sagemaker#HubArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the hub that the hub content reference was added to.
", - "smithy.api#required": {} - } - }, - "HubContentArn": { - "target": "com.amazonaws.sagemaker#HubContentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the hub content.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateHubRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub to create.
", - "smithy.api#required": {} - } - }, - "HubDescription": { - "target": "com.amazonaws.sagemaker#HubDescription", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A description of the hub.
", - "smithy.api#required": {} - } - }, - "HubDisplayName": { - "target": "com.amazonaws.sagemaker#HubDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the hub.
" - } - }, - "HubSearchKeywords": { - "target": "com.amazonaws.sagemaker#HubSearchKeywordList", - "traits": { - "smithy.api#documentation": "The searchable keywords for the hub.
" - } - }, - "S3StorageConfig": { - "target": "com.amazonaws.sagemaker#HubS3StorageConfig", - "traits": { - "smithy.api#documentation": "The Amazon S3 storage configuration for the hub.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Any tags to associate with the hub.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateHubResponse": { - "type": "structure", - "members": { - "HubArn": { - "target": "com.amazonaws.sagemaker#HubArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateHumanTaskUi": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateHumanTaskUiRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateHumanTaskUiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
" - } - }, - "com.amazonaws.sagemaker#CreateHumanTaskUiRequest": { - "type": "structure", - "members": { - "HumanTaskUiName": { - "target": "com.amazonaws.sagemaker#HumanTaskUiName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the user interface you are creating.
", - "smithy.api#required": {} - } - }, - "UiTemplate": { - "target": "com.amazonaws.sagemaker#UiTemplate", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateHumanTaskUiResponse": { - "type": "structure", - "members": { - "HumanTaskUiArn": { - "target": "com.amazonaws.sagemaker#HumanTaskUiArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human review workflow user interface you create.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateHyperParameterTuningJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateHyperParameterTuningJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateHyperParameterTuningJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version\n of a model by running many training jobs on your dataset using the algorithm you choose\n and values for hyperparameters within ranges that you specify. It then chooses the\n hyperparameter values that result in a model that performs the best, as measured by an\n objective metric that you choose.
\nA hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and\n trial components for each training job that it runs. You can view these entities in\n Amazon SageMaker Studio. For more information, see View\n Experiments, Trials, and Trial Components.
\nDo not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.
\nThe name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid\n characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case\n sensitive.
", - "smithy.api#required": {} - } - }, - "HyperParameterTuningJobConfig": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The HyperParameterTuningJobConfig object that describes the tuning job,\n including the search strategy, the objective metric used to evaluate training jobs,\n ranges of parameters to search, and resource limits for the tuning job. For more\n information, see How\n Hyperparameter Tuning Works.
", - "smithy.api#required": {} - } - }, - "TrainingJobDefinition": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", - "traits": { - "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that describes the training jobs\n that this tuning job launches, including static hyperparameters, input data\n configuration, output data configuration, resource configuration, and stopping\n condition.
" - } - }, - "TrainingJobDefinitions": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", - "traits": { - "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.
" - } - }, - "WarmStartConfig": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig", - "traits": { - "smithy.api#documentation": "Specifies the configuration for starting the hyperparameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.
\nAll training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the\n WarmStartType value for the warm start configuration, the training job\n that performs the best in the new tuning job is compared to the best training jobs from\n the parent tuning jobs. From these, the training job that performs the best as measured\n by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.
\nAn array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
\nTags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.
" - } - }, - "Autotune": { - "target": "com.amazonaws.sagemaker#Autotune", - "traits": { - "smithy.api#documentation": "Configures SageMaker Automatic model tuning (AMT) to automatically find optimal\n parameters for the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.
\nThe Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a\n hyperparameter tuning job when you create it.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateImageRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateImageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image\n version represents a container image stored in Amazon ECR. For more information, see\n Bring your own SageMaker AI image.
" - } - }, - "com.amazonaws.sagemaker#CreateImageRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.sagemaker#ImageDescription", - "traits": { - "smithy.api#documentation": "The description of the image.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ImageDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the image. If not provided, ImageName is displayed.
The name of the image. Must be unique to your account.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags to apply to the image.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateImageResponse": { - "type": "structure", - "members": { - "ImageArn": { - "target": "com.amazonaws.sagemaker#ImageArn", - "traits": { - "smithy.api#documentation": "The ARN of the image.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateImageVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateImageVersionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateImageVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Creates a version of the SageMaker AI image specified by ImageName. The version\n represents the Amazon ECR container image specified by BaseImage.
The registry path of the container image to use as the starting point for this\n version. The path is an Amazon ECR URI in the following format:
\n\n
A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python\n (Boto3), add a unique value to the call.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ImageName of the Image to create a version of.
A list of aliases created with the image version.
" - } - }, - "VendorGuidance": { - "target": "com.amazonaws.sagemaker#VendorGuidance", - "traits": { - "smithy.api#documentation": "The stability of the image version, specified by the maintainer.
\n\n NOT_PROVIDED: The maintainers did not provide a status for image version stability.
\n STABLE: The image version is stable.
\n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
\n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
\n\n TRAINING: The image version is compatible with SageMaker AI training jobs.
\n INFERENCE: The image version is compatible with SageMaker AI inference jobs.
\n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
The machine learning framework vended in the image version.
" - } - }, - "ProgrammingLang": { - "target": "com.amazonaws.sagemaker#ProgrammingLang", - "traits": { - "smithy.api#documentation": "The supported programming language and its version.
" - } - }, - "Processor": { - "target": "com.amazonaws.sagemaker#Processor", - "traits": { - "smithy.api#documentation": "Indicates CPU or GPU compatibility.
\n\n CPU: The image version is compatible with CPU.
\n GPU: The image version is compatible with GPU.
Indicates Horovod compatibility.
" - } - }, - "ReleaseNotes": { - "target": "com.amazonaws.sagemaker#ReleaseNotes", - "traits": { - "smithy.api#documentation": "The maintainer description of the image version.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateImageVersionResponse": { - "type": "structure", - "members": { - "ImageVersionArn": { - "target": "com.amazonaws.sagemaker#ImageVersionArn", - "traits": { - "smithy.api#documentation": "The ARN of the image version.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateInferenceComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateInferenceComponentInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateInferenceComponentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an inference component, which is a SageMaker AI hosting object that you can\n use to deploy a model to an endpoint. In the inference component settings, you specify the\n model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You\n can optimize resource utilization by tailoring how the required CPU cores, accelerators,\n and memory are allocated. You can deploy multiple inference components to an endpoint,\n where each inference component contains one model and the resource utilization needs for\n that individual model. After you deploy an inference component, you can directly invoke the\n associated model when you use the InvokeEndpoint API action.
" - } - }, - "com.amazonaws.sagemaker#CreateInferenceComponentInput": { - "type": "structure", - "members": { - "InferenceComponentName": { - "target": "com.amazonaws.sagemaker#InferenceComponentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique name to assign to the inference component.
", - "smithy.api#required": {} - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of an existing endpoint where you host the inference component.
", - "smithy.api#required": {} - } - }, - "VariantName": { - "target": "com.amazonaws.sagemaker#VariantName", - "traits": { - "smithy.api#documentation": "The name of an existing production variant where you host the inference\n component.
" - } - }, - "Specification": { - "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.
", - "smithy.api#required": {} - } - }, - "RuntimeConfig": { - "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", - "traits": { - "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General\n Reference.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateInferenceComponentOutput": { - "type": "structure", - "members": { - "InferenceComponentArn": { - "target": "com.amazonaws.sagemaker#InferenceComponentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateInferenceExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateInferenceExperimentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateInferenceExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "\n Creates an inference experiment using the configurations specified in the request.\n
\n\n Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For\n more information about inference experiments, see Shadow tests.\n
\n\n Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based\n on your specified configuration.\n
\n\n While the experiment is in progress or after it has concluded, you can view metrics that compare your model\n variants. For more information, see View, monitor, and edit shadow tests.\n
" - } - }, - "com.amazonaws.sagemaker#CreateInferenceExperimentRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#InferenceExperimentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name for the inference experiment.
", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.sagemaker#InferenceExperimentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The type of the inference experiment that you want to run. The following types of experiments are possible:\n
\n\n ShadowMode: You can use this type to validate a shadow variant. For more information,\n see Shadow tests.\n
\n The duration for which you want the inference experiment to run. If you don't specify this field, the\n experiment automatically starts immediately upon creation and concludes after 7 days.\n
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#InferenceExperimentDescription", - "traits": { - "smithy.api#documentation": "A description for the inference experiment.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n
", - "smithy.api#required": {} - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.\n
", - "smithy.api#required": {} - } - }, - "ModelVariants": { - "target": "com.amazonaws.sagemaker#ModelVariantConfigList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n An array of ModelVariantConfig objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfig object in the array describes the infrastructure\n configuration for the corresponding variant.\n
\n The Amazon S3 location and configuration for storing inference request and response data.\n
\n\n This is an optional parameter that you can use for data capture. For more information, see Capture data.\n
" - } - }, - "ShadowModeConfig": { - "target": "com.amazonaws.sagemaker#ShadowModeConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n
\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can\n be any of the following formats:\n
KMS key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
KMS key Alias
\n\n \"alias/ExampleAlias\"\n
Amazon Resource Name (ARN) of a KMS key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
\n If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to\n call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for\n your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for\n OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that\n only allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed Encryption Keys\n in the Amazon Simple Storage Service Developer Guide.\n
\n The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.\n
\n Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different\n ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateInferenceExperimentResponse": { - "type": "structure", - "members": { - "InferenceExperimentArn": { - "target": "com.amazonaws.sagemaker#InferenceExperimentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN for your inference experiment.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateInferenceRecommendationsJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Starts a recommendation job. You can create either an instance \n recommendation or load test job.
" - } - }, - "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobRequest": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.sagemaker#RecommendationJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A name for the recommendation job. The name must be unique within \n the Amazon Web Services Region and within your Amazon Web Services account.\n The job name is passed down to the resources created by the recommendation job.\n The names of resources (such as the model, endpoint configuration, endpoint, and compilation)\n that are prefixed with the job name are truncated at 40 characters.
", - "smithy.api#required": {} - } - }, - "JobType": { - "target": "com.amazonaws.sagemaker#RecommendationJobType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Defines the type of recommendation job. Specify Default to initiate an instance \n recommendation and Advanced to initiate a load test. If left unspecified, \n Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.
", - "smithy.api#required": {} - } - }, - "InputConfig": { - "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Provides information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations.
", - "smithy.api#required": {} - } - }, - "JobDescription": { - "target": "com.amazonaws.sagemaker#RecommendationJobDescription", - "traits": { - "smithy.api#documentation": "Description of the recommendation job.
" - } - }, - "StoppingConditions": { - "target": "com.amazonaws.sagemaker#RecommendationJobStoppingConditions", - "traits": { - "smithy.api#documentation": "A set of conditions for stopping a recommendation job. If any of \n the conditions are met, the job is automatically stopped.
" - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#RecommendationJobOutputConfig", - "traits": { - "smithy.api#documentation": "Provides information about the output artifacts and the KMS key \n to use for Amazon S3 server-side encryption.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "The metadata that you apply to Amazon Web Services resources to help you \n categorize and organize them. Each tag consists of a key and a value, both of \n which you define. For more information, see \n Tagging Amazon Web Services Resources \n in the Amazon Web Services General Reference.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobResponse": { - "type": "structure", - "members": { - "JobArn": { - "target": "com.amazonaws.sagemaker#RecommendationJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommendation job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateLabelingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateLabelingJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateLabelingJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a job that uses workers to label the data objects in your input dataset. You\n can use the labeled data to train machine learning models.
\nYou can select your workforce from one of three providers:
\nA private workforce that you create. It can include employees, contractors,\n and outside experts. Use a private workforce when want the data to stay within\n your organization or when a specific set of skills is required.
\nOne or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide\n expertise in specific areas.
\nThe Amazon Mechanical Turk workforce. This is the largest workforce, but it\n should only be used for public data or data that has been stripped of any\n personally identifiable information.
\nYou can also use automated data labeling to reduce the number of\n data objects that need to be labeled by a human. Automated data labeling uses\n active learning to determine if a data object can be labeled by\n machine or if it needs to be sent to a human worker. For more information, see Using\n Automated Data Labeling.
\nThe data objects to be labeled are contained in an Amazon S3 bucket. You create a\n manifest file that describes the location of each object. For\n more information, see Using Input and Output Data.
\nThe output can be used as the manifest file for another labeling job or as training\n data for your machine learning models.
\nYou can use this operation to create a static labeling job or a streaming labeling\n job. A static labeling job stops if all data objects in the input manifest file\n identified in ManifestS3Uri have been labeled. A streaming labeling job\n runs perpetually until it is manually stopped, or remains idle for 10 days. You can send\n new data objects to an active (InProgress) streaming labeling job in real\n time. To learn how to create a static labeling job, see Create a Labeling Job\n (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming\n labeling job, see Create a Streaming Labeling\n Job.
The name of the labeling job. This name is used to identify the job in a list of\n labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region.\n LabelingJobName is not case sensitive. For example, Example-job and\n example-job are considered the same labeling job name by Ground Truth.
The attribute name to use for the label in the output manifest file. This is the key\n for the key/value pair formed with the label that a worker assigns to the object. The\n LabelAttributeName must meet the following requirements.
The name can't end with \"-metadata\".
\nIf you are using one of the following built-in task types,\n the attribute name must end with \"-ref\". If the task type\n you are using is not listed below, the attribute name must\n not end with \"-ref\".
\nImage semantic segmentation (SemanticSegmentation), and\n adjustment (AdjustmentSemanticSegmentation) and\n verification (VerificationSemanticSegmentation) labeling\n jobs for this task type.
Video frame object detection (VideoObjectDetection), and\n adjustment and verification\n (AdjustmentVideoObjectDetection) labeling jobs for this\n task type.
Video frame object tracking (VideoObjectTracking), and\n adjustment and verification (AdjustmentVideoObjectTracking)\n labeling jobs for this task type.
3D point cloud semantic segmentation\n (3DPointCloudSemanticSegmentation), and adjustment and\n verification (Adjustment3DPointCloudSemanticSegmentation)\n labeling jobs for this task type.
3D point cloud object tracking\n (3DPointCloudObjectTracking), and adjustment and\n verification (Adjustment3DPointCloudObjectTracking)\n labeling jobs for this task type.
If you are creating an adjustment or verification labeling job, you must use a\n different\n LabelAttributeName than the one used in the original labeling job. The\n original labeling job is the Ground Truth labeling job that produced the labels that you\n want verified or adjusted. To learn more about adjustment and verification labeling\n jobs, see Verify and Adjust\n Labels.
Input data for the labeling job, such as the Amazon S3 location of the data objects and the\n location of the manifest file that describes the data objects.
\nYou must specify at least one of the following: S3DataSource or\n SnsDataSource.
Use SnsDataSource to specify an SNS input topic for a streaming\n labeling job. If you do not specify and SNS input topic ARN, Ground Truth will\n create a one-time labeling job that stops after all data objects in the input\n manifest file have been labeled.
Use S3DataSource to specify an input manifest file for both\n streaming and one-time labeling jobs. Adding an S3DataSource is\n optional if you use SnsDataSource to create a streaming labeling\n job.
If you use the Amazon Mechanical Turk workforce, your input data should not include\n confidential information, personal information or protected health information. Use\n ContentClassifiers to specify that your data is free of personally\n identifiable information and adult content.
The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt\n the output data, if any.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf\n during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker\n can successfully complete data labeling.
", - "smithy.api#required": {} - } - }, - "LabelCategoryConfigS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The S3 URI of the file, referred to as a label category configuration\n file, that defines the categories used to label the data objects.
\nFor 3D point cloud and video frame task types, you can add label category attributes\n and frame attributes to your label category configuration file. To learn how, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
\nFor named entity recognition jobs, in addition to Add Instructions Add additional instructions.\"labels\", you must\n provide worker instructions in the label category configuration file using the\n \"instructions\" parameter: \"instructions\":\n {\"shortInstruction\":\". For details\n and an example, see Create a\n Named Entity Recognition Labeling Job (API) .Add header
For all other built-in task types and custom\n tasks, your label category configuration file must be a JSON file in the\n following format. Identify the labels you want to use by replacing label_1,\n label_2,...,label_n with your label\n categories.
\n { \n
\n \"document-version\": \"2018-11-28\",\n
\n \"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\":\n \"label_n\"}]\n
\n }\n
Note the following about the label category configuration file:
\nFor image classification and text classification (single and multi-label) you\n must specify at least two label categories. For all other task types, the\n minimum number of label categories required is one.
\nEach label category must be unique, you cannot specify duplicate label\n categories.
\nIf you create a 3D point cloud or video frame adjustment or verification\n labeling job, you must include auditLabelAttributeName in the label\n category configuration. Use this parameter to enter the \n LabelAttributeName\n of the labeling job you want to\n adjust or verify annotations of.
A set of conditions for stopping the labeling job. If any of the conditions are met,\n the job is automatically stopped. You can use these conditions to control the cost of\n data labeling.
" - } - }, - "LabelingJobAlgorithmsConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig", - "traits": { - "smithy.api#documentation": "Configures the information required to perform automated data labeling.
" - } - }, - "HumanTaskConfig": { - "target": "com.amazonaws.sagemaker#HumanTaskConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateLabelingJobResponse": { - "type": "structure", - "members": { - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the\n labeling job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateMlflowTrackingServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact\n store. For more information, see Create an MLflow Tracking\n Server.
" - } - }, - "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest": { - "type": "structure", - "members": { - "TrackingServerName": { - "target": "com.amazonaws.sagemaker#TrackingServerName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique string identifying the tracking server name. This string is part of the tracking server\n ARN.
", - "smithy.api#required": {} - } - }, - "ArtifactStoreUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact\n store.
", - "smithy.api#required": {} - } - }, - "TrackingServerSize": { - "target": "com.amazonaws.sagemaker#TrackingServerSize", - "traits": { - "smithy.api#documentation": "The size of the tracking server you want to create. You can choose between\n \"Small\", \"Medium\", and \"Large\". The default MLflow\n Tracking Server configuration size is \"Small\". You can choose a size depending on\n the projected use of the tracking server such as the volume of data logged, number of users,\n and frequency of use.
We recommend using a small tracking server for teams of up to 25 users, a medium tracking\n server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
" - } - }, - "MlflowVersion": { - "target": "com.amazonaws.sagemaker#MlflowVersion", - "traits": { - "smithy.api#documentation": "The version of MLflow that the tracking server uses. To see which MLflow versions are\n available to use, see How it works.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to\n access the artifact store in Amazon S3. The role should have AmazonS3FullAccess\n permissions. For more information on IAM permissions for tracking server creation, see\n Set up IAM permissions for MLflow.
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Tags consisting of key-value pairs used to manage metadata for the tracking server.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse": { - "type": "structure", - "members": { - "TrackingServerArn": { - "target": "com.amazonaws.sagemaker#TrackingServerArn", - "traits": { - "smithy.api#documentation": "The ARN of the tracking server.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateModelInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateModelOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.
\nUse this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.
\nTo host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.
To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.
In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
" - } - }, - "com.amazonaws.sagemaker#CreateModelBiasJobDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates the definition for a model bias job.
" - } - }, - "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "ModelBiasBaselineConfig": { - "target": "com.amazonaws.sagemaker#ModelBiasBaselineConfig", - "traits": { - "smithy.api#documentation": "The baseline configuration for a model bias job.
" - } - }, - "ModelBiasAppSpecification": { - "target": "com.amazonaws.sagemaker#ModelBiasAppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configures the model bias job to run a specified Docker container image.
", - "smithy.api#required": {} - } - }, - "ModelBiasJobInput": { - "target": "com.amazonaws.sagemaker#ModelBiasJobInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Inputs for the model bias job.
", - "smithy.api#required": {} - } - }, - "ModelBiasJobOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "JobResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", - "traits": { - "smithy.api#documentation": "Networking options for a model bias job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionResponse": { - "type": "structure", - "members": { - "JobDefinitionArn": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model bias job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateModelCard": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateModelCardRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateModelCardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an Amazon SageMaker Model Card.
\nFor information about how to use model cards, see Amazon SageMaker Model Card.
" - } - }, - "com.amazonaws.sagemaker#CreateModelCardExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateModelCardExportJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateModelCardExportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Creates an Amazon SageMaker Model Card export job.
" - } - }, - "com.amazonaws.sagemaker#CreateModelCardExportJobRequest": { - "type": "structure", - "members": { - "ModelCardName": { - "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model card to export.
", - "smithy.api#required": {} - } - }, - "ModelCardVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.
" - } - }, - "ModelCardExportJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model card export job.
", - "smithy.api#required": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#ModelCardExportOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The model card output configuration that specifies the Amazon S3 path for exporting.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateModelCardExportJobResponse": { - "type": "structure", - "members": { - "ModelCardExportJobArn": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card export job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateModelCardRequest": { - "type": "structure", - "members": { - "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique name of the model card.
", - "smithy.api#required": {} - } - }, - "SecurityConfig": { - "target": "com.amazonaws.sagemaker#ModelCardSecurityConfig", - "traits": { - "smithy.api#documentation": "An optional Key Management Service \n key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with\n highly sensitive data.
" - } - }, - "Content": { - "target": "com.amazonaws.sagemaker#ModelCardContent", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The content of the model card. Content must be in model card JSON schema and provided as a string.
", - "smithy.api#required": {} - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
Key-value pairs used to manage metadata for model cards.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateModelCardResponse": { - "type": "structure", - "members": { - "ModelCardArn": { - "target": "com.amazonaws.sagemaker#ModelCardArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the successfully created model card.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates the definition for a model explainability job.
" - } - }, - "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "ModelExplainabilityBaselineConfig": { - "target": "com.amazonaws.sagemaker#ModelExplainabilityBaselineConfig", - "traits": { - "smithy.api#documentation": "The baseline configuration for a model explainability job.
" - } - }, - "ModelExplainabilityAppSpecification": { - "target": "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configures the model explainability job to run a specified Docker container image.
", - "smithy.api#required": {} - } - }, - "ModelExplainabilityJobInput": { - "target": "com.amazonaws.sagemaker#ModelExplainabilityJobInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Inputs for the model explainability job.
", - "smithy.api#required": {} - } - }, - "ModelExplainabilityJobOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "JobResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", - "traits": { - "smithy.api#documentation": "Networking options for a model explainability job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionResponse": { - "type": "structure", - "members": { - "JobDefinitionArn": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model explainability job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateModelInput": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the new model.
", - "smithy.api#required": {} - } - }, - "PrimaryContainer": { - "target": "com.amazonaws.sagemaker#ContainerDefinition", - "traits": { - "smithy.api#documentation": "The location of the primary docker image containing inference code, associated\n artifacts, and custom environment map that the inference code uses when the model is\n deployed for predictions.
" - } - }, - "Containers": { - "target": "com.amazonaws.sagemaker#ContainerDefinitionList", - "traits": { - "smithy.api#documentation": "Specifies the containers in the inference pipeline.
" - } - }, - "InferenceExecutionConfig": { - "target": "com.amazonaws.sagemaker#InferenceExecutionConfig", - "traits": { - "smithy.api#documentation": "Specifies details of how containers in a multi-container endpoint are called.
" - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.
\nTo be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", - "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your model to connect\n to. Control access to and from your model container by configuring the VPC.\n VpcConfig is used in hosting services and in batch transform. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch\n Transform Jobs by Using an Amazon Virtual Private Cloud.
Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateModelOutput": { - "type": "structure", - "members": { - "ModelArn": { - "target": "com.amazonaws.sagemaker#ModelArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the model created in SageMaker.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateModelPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateModelPackageInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateModelPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a model package that you can use to create SageMaker models or list on Amazon Web Services\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
\nTo create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.
There are two types of model packages:
\nVersioned - a model that is part of a model group in the model\n registry.
\nUnversioned - a model package that is not part of a model group.
\nCreates a model group. A model group contains a group of model versions.
" - } - }, - "com.amazonaws.sagemaker#CreateModelPackageGroupInput": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model group.
", - "smithy.api#required": {} - } - }, - "ModelPackageGroupDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A description for the model group.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of key value pairs associated with the model group. For more information, see\n Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateModelPackageGroupOutput": { - "type": "structure", - "members": { - "ModelPackageGroupArn": { - "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateModelPackageInput": { - "type": "structure", - "members": { - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the model package. The name must have 1 to 63 characters. Valid characters\n are a-z, A-Z, 0-9, and - (hyphen).
\nThis parameter is required for unversioned models. It is not applicable to versioned\n models.
" - } - }, - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#ArnOrName", - "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
\nThis parameter is required for versioned models, and does not apply to unversioned\n models.
" - } - }, - "ModelPackageDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A description of the model package.
" - } - }, - "InferenceSpecification": { - "target": "com.amazonaws.sagemaker#InferenceSpecification", - "traits": { - "smithy.api#documentation": "Specifies details about inference jobs that you can run with models based on this model\n package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nSpecifies configurations for one or more transform jobs that SageMaker runs to test the\n model package.
" - } - }, - "SourceAlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", - "traits": { - "smithy.api#documentation": "Details about the algorithm that was used to create the model package.
" - } - }, - "CertifyForMarketplace": { - "target": "com.amazonaws.sagemaker#CertifyForMarketplace", - "traits": { - "smithy.api#documentation": "Whether to certify the model package for listing on Amazon Web Services Marketplace.
\nThis parameter is optional for unversioned models, and does not apply to versioned\n models.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
\nIf you supply ModelPackageGroupName, your model package belongs to the model group\n\t you specify and uses the tags associated with the model group. In this case, you cannot\n\t supply a tag argument.\n
Whether the model is approved for deployment.
\nThis parameter is optional for versioned models, and does not apply to unversioned\n models.
\nFor versioned models, the value of this parameter must be set to Approved\n to deploy the model.
A structure that contains model metrics reports.
" - } - }, - "ClientToken": { - "target": "com.amazonaws.sagemaker#ClientToken", - "traits": { - "smithy.api#documentation": "A unique token that guarantees that the call to this API is idempotent.
", - "smithy.api#idempotencyToken": {} - } - }, - "Domain": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.
" - } - }, - "Task": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification. The following\n tasks are supported by Inference Recommender:\n \"IMAGE_CLASSIFICATION\" | \"OBJECT_DETECTION\" | \"TEXT_GENERATION\" |\"IMAGE_SEGMENTATION\" |\n \"FILL_MASK\" | \"CLASSIFICATION\" | \"REGRESSION\" | \"OTHER\".
Specify \"OTHER\" if none of the tasks listed fit your use case.
" - } - }, - "SamplePayloadUrl": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point\n to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files\n that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the\n InvokeEndpoint call.
" - } - }, - "CustomerMetadataProperties": { - "target": "com.amazonaws.sagemaker#CustomerMetadataMap", - "traits": { - "smithy.api#documentation": "The metadata properties associated with the model package versions.
" - } - }, - "DriftCheckBaselines": { - "target": "com.amazonaws.sagemaker#DriftCheckBaselines", - "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.\n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n
" - } - }, - "AdditionalInferenceSpecifications": { - "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", - "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the\n compiled artifacts.
" - } - }, - "SkipModelValidation": { - "target": "com.amazonaws.sagemaker#SkipModelValidation", - "traits": { - "smithy.api#documentation": "Indicates if you want to skip model validation.
" - } - }, - "SourceUri": { - "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", - "traits": { - "smithy.api#documentation": "The URI of the source for the model package. If you want to clone a model package,\n set it to the model package Amazon Resource Name (ARN). If you want to register a model,\n set it to the model ARN.
" - } - }, - "SecurityConfig": { - "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", - "traits": { - "smithy.api#documentation": "The KMS Key ID (KMSKeyId) used for encryption of model package information.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
\n A structure describing the current state of the model in its life cycle.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateModelPackageOutput": { - "type": "structure", - "members": { - "ModelPackageArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new model package.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateModelQualityJobDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a definition for a job that monitors model quality and drift. For information\n about model monitor, see Amazon SageMaker AI Model\n Monitor.
" - } - }, - "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the monitoring job definition.
", - "smithy.api#required": {} - } - }, - "ModelQualityBaselineConfig": { - "target": "com.amazonaws.sagemaker#ModelQualityBaselineConfig", - "traits": { - "smithy.api#documentation": "Specifies the constraints and baselines for the monitoring job.
" - } - }, - "ModelQualityAppSpecification": { - "target": "com.amazonaws.sagemaker#ModelQualityAppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The container that runs the monitoring job.
", - "smithy.api#required": {} - } - }, - "ModelQualityJobInput": { - "target": "com.amazonaws.sagemaker#ModelQualityJobInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of the inputs that are monitored. Currently endpoints are supported.
", - "smithy.api#required": {} - } - }, - "ModelQualityJobOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "JobResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", - "traits": { - "smithy.api#documentation": "Specifies the network configuration for the monitoring job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionResponse": { - "type": "structure", - "members": { - "JobDefinitionArn": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model quality monitoring job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateMonitoringSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateMonitoringScheduleRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateMonitoringScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to\n monitor the data captured for an Amazon SageMaker AI Endpoint.
" - } - }, - "com.amazonaws.sagemaker#CreateMonitoringScheduleRequest": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "MonitoringScheduleConfig": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost\n Management User Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateMonitoringScheduleResponse": { - "type": "structure", - "members": { - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateNotebookInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateNotebookInstanceInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateNotebookInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an SageMaker AI notebook instance. A notebook instance is a machine\n learning (ML) compute instance running on a Jupyter notebook.
\nIn a CreateNotebookInstance request, specify the type of ML compute\n instance that you want to run. SageMaker AI launches the instance, installs common\n libraries that you can use to explore datasets for model training, and attaches an ML\n storage volume to the notebook instance.
SageMaker AI also provides a set of example notebooks. Each notebook\n demonstrates how to use SageMaker AI with a specific algorithm or with a machine\n learning framework.
\nAfter receiving the request, SageMaker AI does the following:
\nCreates a network interface in the SageMaker AI VPC.
\n(Option) If you specified SubnetId, SageMaker AI creates\n a network interface in your own VPC, which is inferred from the subnet ID that\n you provide in the input. When creating this network interface, SageMaker AI attaches the security group that you specified in the request to the network\n interface that it creates in your VPC.
Launches an EC2 instance of the type specified in the request in the\n SageMaker AI VPC. If you specified SubnetId of your VPC,\n SageMaker AI specifies both network interfaces when launching this\n instance. This enables inbound traffic from your own VPC to the notebook\n instance, assuming that the security groups allow it.
After creating the notebook instance, SageMaker AI returns its Amazon Resource\n Name (ARN). You can't change the name of a notebook instance after you create\n it.
\nAfter SageMaker AI creates the notebook instance, you can connect to the\n Jupyter server and work in Jupyter notebooks. For example, you can write code to explore\n a dataset that you can use for model training, train a model, host models by creating\n SageMaker AI endpoints, and validate hosted models.
\nFor more information, see How It Works.
" - } - }, - "com.amazonaws.sagemaker#CreateNotebookInstanceInput": { - "type": "structure", - "members": { - "NotebookInstanceName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the new notebook instance.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#InstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of ML compute instance to launch for the notebook instance.
", - "smithy.api#required": {} - } - }, - "SubnetId": { - "target": "com.amazonaws.sagemaker#SubnetId", - "traits": { - "smithy.api#documentation": "The ID of the subnet in a VPC to which you would like to have a connectivity from\n your ML compute instance.
" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be\n for the same VPC as specified in the subnet.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "When you send any requests to Amazon Web Services resources from the notebook\n instance, SageMaker AI assumes this role to perform tasks on your behalf. You must\n grant this role necessary permissions so SageMaker AI can perform these tasks. The\n policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com)\n permissions to assume this role. For more information, see SageMaker AI Roles.
\nTo be able to pass this role to SageMaker AI, the caller of this API must\n have the iam:PassRole permission.
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker AI uses to encrypt data on the storage volume attached to your\n notebook instance. The KMS key you provide must be enabled. For information, see Enabling and\n Disabling Keys in the Amazon Web Services Key Management Service\n Developer Guide.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - }, - "LifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#documentation": "The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.
" - } - }, - "DirectInternetAccess": { - "target": "com.amazonaws.sagemaker#DirectInternetAccess", - "traits": { - "smithy.api#documentation": "Sets whether SageMaker AI provides internet access to the notebook instance. If\n you set this to Disabled this notebook instance is able to access resources\n only in your VPC, and is not be able to connect to SageMaker AI training and\n endpoint services unless you configure a NAT Gateway in your VPC.
For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.
The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB.
" - } - }, - "AcceleratorTypes": { - "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", - "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of EI instance types to associate with this\n notebook instance.
" - } - }, - "DefaultCodeRepository": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", - "traits": { - "smithy.api#documentation": "A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" - } - }, - "AdditionalCodeRepositories": { - "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", - "traits": { - "smithy.api#documentation": "An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" - } - }, - "RootAccess": { - "target": "com.amazonaws.sagemaker#RootAccess", - "traits": { - "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.
Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.
\nThe platform identifier of the notebook instance runtime environment.
" - } - }, - "InstanceMetadataServiceConfiguration": { - "target": "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration", - "traits": { - "smithy.api#documentation": "Information on the IMDS configuration of the notebook instance
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a lifecycle configuration that you can associate with a notebook instance. A\n lifecycle configuration is a collection of shell scripts that\n run when you create or start a notebook instance.
\nEach lifecycle configuration script has a limit of 16384 characters.
\nThe value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log\n group /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" - } - }, - "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigInput": { - "type": "structure", - "members": { - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the lifecycle configuration.
", - "smithy.api#required": {} - } - }, - "OnCreate": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", - "traits": { - "smithy.api#documentation": "A shell script that runs only once, when you create a notebook instance. The shell\n script must be a base64-encoded string.
" - } - }, - "OnStart": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", - "traits": { - "smithy.api#documentation": "A shell script that runs every time you start a notebook instance, including when you\n create the notebook instance. The shell script must be a base64-encoded string.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigOutput": { - "type": "structure", - "members": { - "NotebookInstanceLifecycleConfigArn": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle configuration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateNotebookInstanceOutput": { - "type": "structure", - "members": { - "NotebookInstanceArn": { - "target": "com.amazonaws.sagemaker#NotebookInstanceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the notebook instance.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateOptimizationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateOptimizationJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateOptimizationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a job that optimizes a model for inference performance. To create the job, you\n provide the location of a source model, and you provide the settings for the optimization\n techniques that you want the job to apply. When the job completes successfully, SageMaker\n uploads the new optimized model to the output destination that you specify.
\nFor more information about how to use this action, and about the supported optimization\n techniques, see Optimize model inference with Amazon SageMaker.
" - } - }, - "com.amazonaws.sagemaker#CreateOptimizationJobRequest": { - "type": "structure", - "members": { - "OptimizationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A custom name for the new optimization job.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
\nDuring model optimization, Amazon SageMaker AI needs your permission to:
\nRead input data from an S3 bucket
\nWrite model artifacts to an S3 bucket
\nWrite logs to Amazon CloudWatch Logs
\nPublish metrics to Amazon CloudWatch
\nYou grant permissions for all of these tasks to an IAM role. To pass this\n role to Amazon SageMaker AI, the caller of this API must have the\n iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.\n
The location of the source model to optimize with an optimization job.
", - "smithy.api#required": {} - } - }, - "DeploymentInstanceType": { - "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of instance that hosts the optimized model that you create with the optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationEnvironment": { - "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", - "traits": { - "smithy.api#documentation": "The environment variables to set in the model container.
" - } - }, - "OptimizationConfigs": { - "target": "com.amazonaws.sagemaker#OptimizationConfigs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Settings for each of the optimization techniques that the job applies.
", - "smithy.api#required": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#OptimizationJobOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Details for where to store the optimized model that you create with the optimization job.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of key-value pairs associated with the optimization job. For more information,\n see Tagging Amazon Web Services resources in the Amazon Web Services General Reference\n Guide.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#OptimizationVpcConfig", - "traits": { - "smithy.api#documentation": "A VPC in Amazon VPC that your optimized model has access to.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateOptimizationJobResponse": { - "type": "structure", - "members": { - "OptimizationJobArn": { - "target": "com.amazonaws.sagemaker#OptimizationJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the optimization job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreatePartnerApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreatePartnerAppRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreatePartnerAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates an Amazon SageMaker Partner AI App.
" - } - }, - "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Creates a presigned URL to access an Amazon SageMaker Partner AI App.
" - } - }, - "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlRequest": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#PartnerAppArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to create the presigned URL for.
", - "smithy.api#required": {} - } - }, - "ExpiresInSeconds": { - "target": "com.amazonaws.sagemaker#ExpiresInSeconds", - "traits": { - "smithy.api#documentation": "The time that will pass before the presigned URL expires.
" - } - }, - "SessionExpirationDurationInSeconds": { - "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", - "traits": { - "smithy.api#documentation": "Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlResponse": { - "type": "structure", - "members": { - "Url": { - "target": "com.amazonaws.sagemaker#String2048", - "traits": { - "smithy.api#documentation": "The presigned URL that you can use to access the SageMaker Partner AI App.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreatePartnerAppRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#PartnerAppName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name to give the SageMaker Partner AI App.
", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.sagemaker#PartnerAppType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The ARN of the IAM role that the partner application uses.
", - "smithy.api#required": {} - } - }, - "MaintenanceConfig": { - "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", - "traits": { - "smithy.api#documentation": "Maintenance configuration settings for the SageMaker Partner AI App.
" - } - }, - "Tier": { - "target": "com.amazonaws.sagemaker#NonEmptyString64", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
", - "smithy.api#required": {} - } - }, - "ApplicationConfig": { - "target": "com.amazonaws.sagemaker#PartnerAppConfig", - "traits": { - "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" - } - }, - "AuthType": { - "target": "com.amazonaws.sagemaker#PartnerAppAuthType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The authorization type that users use to access the SageMaker Partner AI App.
", - "smithy.api#required": {} - } - }, - "EnableIamSessionBasedIdentity": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
A unique token that guarantees that the call to this API is idempotent.
", - "smithy.api#idempotencyToken": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreatePartnerAppResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#PartnerAppArn", - "traits": { - "smithy.api#documentation": "The ARN of the SageMaker Partner AI App.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreatePipeline": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreatePipelineRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreatePipelineResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Creates a pipeline using a JSON pipeline definition.
" - } - }, - "com.amazonaws.sagemaker#CreatePipelineRequest": { - "type": "structure", - "members": { - "PipelineName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the pipeline.
", - "smithy.api#required": {} - } - }, - "PipelineDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline.
" - } - }, - "PipelineDefinition": { - "target": "com.amazonaws.sagemaker#PipelineDefinition", - "traits": { - "smithy.api#documentation": "The JSON \n pipeline definition of the pipeline.
" - } - }, - "PipelineDefinitionS3Location": { - "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", - "traits": { - "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.
" - } - }, - "PipelineDescription": { - "target": "com.amazonaws.sagemaker#PipelineDescription", - "traits": { - "smithy.api#documentation": "A description of the pipeline.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.sagemaker#IdempotencyToken", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags to apply to the created pipeline.
" - } - }, - "ParallelismConfiguration": { - "target": "com.amazonaws.sagemaker#ParallelismConfiguration", - "traits": { - "smithy.api#documentation": "This is the configuration that controls the parallelism of the pipeline. \n If specified, it applies to all runs of this pipeline by default.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreatePipelineResponse": { - "type": "structure", - "members": { - "PipelineArn": { - "target": "com.amazonaws.sagemaker#PipelineArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created pipeline.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreatePresignedDomainUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreatePresignedDomainUrlRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreatePresignedDomainUrlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the\n user will be automatically signed in to the domain, and granted access to all of the Apps and\n files associated with the Domain's Amazon Elastic File System volume. This operation can only be\n called when the authentication mode equals IAM.
\nThe IAM role or user passed to this API defines the permissions to access\n the app. Once the presigned URL is created, no additional permission is required to access\n this URL. IAM authorization policies for this API are also enforced for every\n HTTP request and WebSocket frame that attempts to connect to the app.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker AI\n Studio Through an Interface VPC Endpoint .
\nThe URL that you get from a call to CreatePresignedDomainUrl has a\n default timeout of 5 minutes. You can configure this value using\n ExpiresInSeconds. If you try to use the URL after the timeout limit\n expires, you are directed to the Amazon Web Services console sign-in page.
The JupyterLab session default expiration time is 12 hours. You can configure this\n value using SessionExpirationDurationInSeconds.
\nThe domain ID.
", - "smithy.api#required": {} - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the UserProfile to sign-in as.
", - "smithy.api#required": {} - } - }, - "SessionExpirationDurationInSeconds": { - "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", - "traits": { - "smithy.api#documentation": "The session expiration duration in seconds. This value defaults to 43200.
" - } - }, - "ExpiresInSeconds": { - "target": "com.amazonaws.sagemaker#ExpiresInSeconds", - "traits": { - "smithy.api#documentation": "The number of seconds until the pre-signed URL expires. This value defaults to 300.
" - } - }, - "SpaceName": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#documentation": "The name of the space.
" - } - }, - "LandingUri": { - "target": "com.amazonaws.sagemaker#LandingUri", - "traits": { - "smithy.api#documentation": "The landing page that the user is directed to when accessing the presigned URL. Using this\n value, users can access Studio or Studio Classic, even if it is not the default experience for\n the domain. The supported values are:
\n\n studio::relative/path: Directs users to the relative path in\n Studio.
\n app:JupyterServer:relative/path: Directs users to the relative path in\n the Studio Classic application.
\n app:JupyterLab:relative/path: Directs users to the relative path in the\n JupyterLab application.
\n app:RStudioServerPro:relative/path: Directs users to the relative path in\n the RStudio application.
\n app:CodeEditor:relative/path: Directs users to the relative path in the\n Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
\n app:Canvas:relative/path: Directs users to the relative path in the\n Canvas application.
The presigned URL.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns a presigned URL that you can use to connect to the MLflow UI attached to your\n tracking server. For more information, see Launch the MLflow UI using a presigned URL.
" - } - }, - "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest": { - "type": "structure", - "members": { - "TrackingServerName": { - "target": "com.amazonaws.sagemaker#TrackingServerName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the tracking server to connect to your MLflow UI.
", - "smithy.api#required": {} - } - }, - "ExpiresInSeconds": { - "target": "com.amazonaws.sagemaker#ExpiresInSeconds", - "traits": { - "smithy.api#documentation": "The duration in seconds that your presigned URL is valid. The presigned URL can be used\n only once.
" - } - }, - "SessionExpirationDurationInSeconds": { - "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", - "traits": { - "smithy.api#documentation": "The duration in seconds that your MLflow UI session is valid.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse": { - "type": "structure", - "members": { - "AuthorizedUrl": { - "target": "com.amazonaws.sagemaker#TrackingServerUrl", - "traits": { - "smithy.api#documentation": "A presigned URL with an authorization token.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput" - }, - "traits": { - "smithy.api#documentation": "Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker AI console, when you choose Open next to a\n notebook instance, SageMaker AI opens a new tab showing the Jupyter server home\n page from the notebook instance. The console uses this API to get the URL and show the\n page.
The IAM role or user used to call this API defines the permissions to\n access the notebook instance. Once the presigned URL is created, no additional\n permission is required to access this URL. IAM authorization policies for\n this API are also enforced for every HTTP request and WebSocket frame that attempts to\n connect to the notebook instance.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you\n try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.
\nThe name of the notebook instance.
", - "smithy.api#required": {} - } - }, - "SessionExpirationDurationInSeconds": { - "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", - "traits": { - "smithy.api#documentation": "The duration of the session, in seconds. The default is 12 hours.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput": { - "type": "structure", - "members": { - "AuthorizedUrl": { - "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", - "traits": { - "smithy.api#documentation": "A JSON object that contains the URL string.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateProcessingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateProcessingJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateProcessingJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Creates a processing job.
" - } - }, - "com.amazonaws.sagemaker#CreateProcessingJobRequest": { - "type": "structure", - "members": { - "ProcessingInputs": { - "target": "com.amazonaws.sagemaker#ProcessingInputs", - "traits": { - "smithy.api#documentation": "An array of inputs configuring the data to download into the \n processing container.
" - } - }, - "ProcessingOutputConfig": { - "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", - "traits": { - "smithy.api#documentation": "Output configuration for the processing job.
" - } - }, - "ProcessingJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "ProcessingResources": { - "target": "com.amazonaws.sagemaker#ProcessingResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", - "traits": { - "smithy.api#documentation": "The time limit for how long the processing job is allowed to run.
" - } - }, - "AppSpecification": { - "target": "com.amazonaws.sagemaker#AppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configures the processing job to run a specified Docker container image.
", - "smithy.api#required": {} - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container. Up to \n 100 key and values entries in the map are supported.
" - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#NetworkConfig", - "traits": { - "smithy.api#documentation": "Networking options for a processing job, such as whether to allow inbound and \n outbound network calls to and from processing containers, and the VPC subnets and \n security groups to use for VPC-enabled processing jobs.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.
" - } - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateProcessingJobResponse": { - "type": "structure", - "members": { - "ProcessingJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateProjectInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateProjectOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a machine learning (ML) project that can contain one or more templates that set\n up an ML pipeline from training to deploying an approved model.
" - } - }, - "com.amazonaws.sagemaker#CreateProjectInput": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.sagemaker#ProjectEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the project.
", - "smithy.api#required": {} - } - }, - "ProjectDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A description for the project.
" - } - }, - "ServiceCatalogProvisioningDetails": { - "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. The provisioning \n artifact ID will default to the latest provisioning artifact ID of the product, if you don't \n provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service\n Catalog.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs that you want to use to organize and track your Amazon Web Services\n resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateProjectOutput": { - "type": "structure", - "members": { - "ProjectArn": { - "target": "com.amazonaws.sagemaker#ProjectArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
", - "smithy.api#required": {} - } - }, - "ProjectId": { - "target": "com.amazonaws.sagemaker#ProjectId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the new project.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateSpace": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateSpaceRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateSpaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a private space or a space used for real time collaboration in a domain.
" - } - }, - "com.amazonaws.sagemaker#CreateSpaceRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the associated domain.
", - "smithy.api#required": {} - } - }, - "SpaceName": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the space.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Tags to associated with the space. Each tag consists of a key and an optional value. Tag\n keys must be unique for each resource. Tags are searchable using the Search\n API.
A collection of space settings.
" - } - }, - "OwnershipSettings": { - "target": "com.amazonaws.sagemaker#OwnershipSettings", - "traits": { - "smithy.api#documentation": "A collection of ownership settings.
" - } - }, - "SpaceSharingSettings": { - "target": "com.amazonaws.sagemaker#SpaceSharingSettings", - "traits": { - "smithy.api#documentation": "A collection of space sharing settings.
" - } - }, - "SpaceDisplayName": { - "target": "com.amazonaws.sagemaker#NonEmptyString64", - "traits": { - "smithy.api#documentation": "The name of the space that appears in the SageMaker Studio UI.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateSpaceResponse": { - "type": "structure", - "members": { - "SpaceArn": { - "target": "com.amazonaws.sagemaker#SpaceArn", - "traits": { - "smithy.api#documentation": "The space's Amazon Resource Name (ARN).
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateStudioLifecycleConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateStudioLifecycleConfigRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateStudioLifecycleConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.
" - } - }, - "com.amazonaws.sagemaker#CreateStudioLifecycleConfigRequest": { - "type": "structure", - "members": { - "StudioLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create.
", - "smithy.api#required": {} - } - }, - "StudioLifecycleConfigContent": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This\n content must be base64 encoded.
", - "smithy.api#required": {} - } - }, - "StudioLifecycleConfigAppType": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The App type that the Lifecycle Configuration is attached to.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an\n optional value. Tag keys must be unique per resource. Tags are searchable using the Search\n API.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateStudioLifecycleConfigResponse": { - "type": "structure", - "members": { - "StudioLifecycleConfigArn": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", - "traits": { - "smithy.api#documentation": "The ARN of your created Lifecycle Configuration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateTrainingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateTrainingJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateTrainingJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.
\nIf you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n
\nIn the request body, you provide the following:
\n\n AlgorithmSpecification - Identifies the training algorithm to\n use.\n
\n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access\n IDs, secrets or tokens in any hyperparameter field. If the use of\n security-sensitive credentials are detected, SageMaker will reject your training\n job request and return an exception error.
\n\n InputDataConfig - Describes the input required by the training\n job and the Amazon S3, EFS, or FSx location where it is stored.
\n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.
\n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.
\n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.
\n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.
\n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.
\n Environment - The environment variables to set in the Docker\n container.
\n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" - } - }, - "com.amazonaws.sagemaker#CreateTrainingJobRequest": { - "type": "structure", - "members": { - "TrainingJobName": { - "target": "com.amazonaws.sagemaker#TrainingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the training job. The name must be unique within an Amazon Web Services\n Region in an Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "HyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", - "traits": { - "smithy.api#documentation": "Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
\nYou can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.
Do not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.
\nThe registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform\n tasks on your behalf.
\nDuring model training, SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see SageMaker\n Roles.
\nTo be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.
An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.
Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be downloaded.
\nYour input must be in the same Amazon Web Services region as your training\n job.
" - } - }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#OutputDataConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the path to the S3 location where you want to store model artifacts. SageMaker\n creates subfolders for the artifacts.
", - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The resources, including the ML compute instances and ML storage volumes, to use\n for model training.
\nML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.
A VpcConfig object that specifies the VPC that you want your training job to\n connect to. Control access to and from your training container by configuring the VPC.\n For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n you enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
" - } - }, - "EnableInterContainerTrafficEncryption": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training. For more information, see Protect Communications Between ML\n Compute Instances in a Distributed Training Job.
To train models using managed spot training, choose True. Managed spot\n training provides a fully managed and scalable infrastructure for training machine\n learning models. this option is useful when training jobs can be interrupted and when\n there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be\n used as a starting point to train models incrementally. Amazon SageMaker provides metrics and\n logs in CloudWatch. They can be used to see when managed spot training jobs are running,\n interrupted, resumed, or completed.
" - } - }, - "CheckpointConfig": { - "target": "com.amazonaws.sagemaker#CheckpointConfig", - "traits": { - "smithy.api#documentation": "Contains information about the output location for managed spot training checkpoint\n data.
" - } - }, - "DebugHookConfig": { - "target": "com.amazonaws.sagemaker#DebugHookConfig" - }, - "DebugRuleConfigurations": { - "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", - "traits": { - "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
" - } - }, - "TensorBoardOutputConfig": { - "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - }, - "ProfilerConfig": { - "target": "com.amazonaws.sagemaker#ProfilerConfig" - }, - "ProfilerRuleConfigurations": { - "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", - "traits": { - "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.
" - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container.
" - } - }, - "RetryStrategy": { - "target": "com.amazonaws.sagemaker#RetryStrategy", - "traits": { - "smithy.api#documentation": "The number of times to retry the job when the job fails due to an\n InternalServerError.
Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" - } - }, - "InfraCheckConfig": { - "target": "com.amazonaws.sagemaker#InfraCheckConfig", - "traits": { - "smithy.api#documentation": "Contains information about the infrastructure health check configuration for the training job.
" - } - }, - "SessionChainingConfig": { - "target": "com.amazonaws.sagemaker#SessionChainingConfig", - "traits": { - "smithy.api#documentation": "Contains information about attribute-based access control (ABAC) for the training\n job.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateTrainingJobResponse": { - "type": "structure", - "members": { - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateTrainingPlan": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateTrainingPlanRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateTrainingPlanResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new training plan in SageMaker to reserve compute capacity.
\nAmazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU\n capacity for large-scale AI model training. It provides a way to secure predictable access\n to computational resources within specific timelines and budgets, without the need to\n manage underlying infrastructure.
\n\n How it works\n
\nPlans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod\n clusters, automatically provisioning resources, setting up infrastructure, executing\n workloads, and handling infrastructure failures.
\n\n Plan creation workflow\n
\nUsers search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration) using the \n SearchTrainingPlanOfferings\n API operation.
They create a plan that best matches their needs using the ID of the plan offering\n they want to use.
\nAfter successful upfront payment, the plan's status becomes\n Scheduled.
The plan can be used to:
\nQueue training jobs.
\nAllocate to an instance group of a SageMaker HyperPod cluster.
\nWhen the plan start date arrives, it becomes Active. Based on\n available reserved capacity:
Training jobs are launched.
\nInstance groups are provisioned.
\n\n Plan composition\n
\nA plan can consist of one or more Reserved Capacities, each defined by a specific\n instance type, quantity, Availability Zone, duration, and start and end times. For more\n information about Reserved Capacity, see \n ReservedCapacitySummary\n .
The name of the training plan to create.
", - "smithy.api#required": {} - } - }, - "TrainingPlanOfferingId": { - "target": "com.amazonaws.sagemaker#TrainingPlanOfferingId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique identifier of the training plan offering to use for creating this\n plan.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs to apply to this training plan.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateTrainingPlanResponse": { - "type": "structure", - "members": { - "TrainingPlanArn": { - "target": "com.amazonaws.sagemaker#TrainingPlanArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN); of the created training plan.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateTransformJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateTransformJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateTransformJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.
\nTo perform batch transformations, you create a transform job and use the data that you\n have readily available.
\nIn the request body, you provide the following:
\n\n TransformJobName - Identifies the transform job. The name must be\n unique within an Amazon Web Services Region in an Amazon Web Services account.
\n ModelName - Identifies the model to use. ModelName\n must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services\n\t\t account. For information on creating a model, see CreateModel.
\n TransformInput - Describes the dataset to be transformed and the\n Amazon S3 location where it is stored.
\n TransformOutput - Identifies the Amazon S3 location where you want\n Amazon SageMaker to save the results from the transform job.
\n TransformResources - Identifies the ML compute instances for the\n transform job.
For more information about how batch transformation works, see Batch\n Transform.
" - } - }, - "com.amazonaws.sagemaker#CreateTransformJobRequest": { - "type": "structure", - "members": { - "TransformJobName": { - "target": "com.amazonaws.sagemaker#TransformJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the transform job. The name must be unique within an Amazon Web Services Region in an\n Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model that you want to use for the transform job.\n ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services\n Region in an Amazon Web Services account.
The maximum number of parallel requests that can be sent to each instance in a\n transform job. If MaxConcurrentTransforms is set to 0 or left\n unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your\n chosen algorithm. If the execution-parameters endpoint is not enabled, the default value\n is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to\n set a value for MaxConcurrentTransforms.
Configures the timeout and maximum number of retries for processing a transform job\n invocation.
" - } - }, - "MaxPayloadInMB": { - "target": "com.amazonaws.sagemaker#MaxPayloadInMB", - "traits": { - "smithy.api#documentation": "The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n
The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify\n the MaxConcurrentTransforms parameter, the value of\n (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100\n MB.
For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.
Specifies the number of records to include in a mini-batch for an HTTP inference\n request. A record\n is a single unit of input data that\n inference can be made on. For example, a single line in a CSV file is a record.
\nTo enable the batch strategy, you must set the SplitType property to\n Line, RecordIO, or TFRecord.
To use only one record when making an HTTP invocation request to a container, set\n BatchStrategy to SingleRecord and SplitType\n to Line.
To fit as many records in a mini-batch as can fit within the\n MaxPayloadInMB limit, set BatchStrategy to\n MultiRecord and SplitType to Line.
The environment variables to set in the Docker container. Don't include any\n sensitive data in your environment variables. We support up to 16 key and\n values entries in the map.
" - } - }, - "TransformInput": { - "target": "com.amazonaws.sagemaker#TransformInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the input source and\n the\n way the transform job consumes it.
", - "smithy.api#required": {} - } - }, - "TransformOutput": { - "target": "com.amazonaws.sagemaker#TransformOutput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the results of the transform job.
", - "smithy.api#required": {} - } - }, - "DataCaptureConfig": { - "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig", - "traits": { - "smithy.api#documentation": "Configuration to control how SageMaker captures inference data.
" - } - }, - "TransformResources": { - "target": "com.amazonaws.sagemaker#TransformResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the resources, including\n ML\n instance types and ML instance count, to use for the transform\n job.
", - "smithy.api#required": {} - } - }, - "DataProcessing": { - "target": "com.amazonaws.sagemaker#DataProcessing", - "traits": { - "smithy.api#documentation": "The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "(Optional)\n An\n array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.
" - } - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateTransformJobResponse": { - "type": "structure", - "members": { - "TransformJobArn": { - "target": "com.amazonaws.sagemaker#TransformJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateTrial": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateTrialRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateTrialResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Creates an SageMaker trial. A trial is a set of steps called\n trial components that produce a machine learning model. A trial is part\n of a single SageMaker experiment.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to a trial and then use the Search API to search for\n the tags.
\nTo get a list of all your trials, call the ListTrials API. To view a\n trial's properties, call the DescribeTrial API. To create a trial component,\n call the CreateTrialComponent API.
" - } - }, - "com.amazonaws.sagemaker#CreateTrialComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateTrialComponentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateTrialComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a trial component, which is a stage of a machine learning\n trial. A trial is composed of one or more trial components. A trial\n component can be used in multiple trials.
\nTrial components include pre-processing jobs, training jobs, and batch transform\n jobs.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to a trial component and then use the Search API to\n search for the tags.
" - } - }, - "com.amazonaws.sagemaker#CreateTrialComponentRequest": { - "type": "structure", - "members": { - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the component. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.
The status of the component. States include:
\nInProgress
\nCompleted
\nFailed
\nWhen the component started.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component ended.
" - } - }, - "Parameters": { - "target": "com.amazonaws.sagemaker#TrialComponentParameters", - "traits": { - "smithy.api#documentation": "The hyperparameters for the component.
" - } - }, - "InputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", - "traits": { - "smithy.api#documentation": "The input artifacts for the component. Examples of input artifacts are datasets,\n algorithms, hyperparameters, source code, and instance types.
" - } - }, - "OutputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", - "traits": { - "smithy.api#documentation": "The output artifacts for the component. Examples of output artifacts are metrics,\n snapshots, logs, and images.
" - } - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags to associate with the component. You can use Search API\n to search on the tags.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateTrialComponentResponse": { - "type": "structure", - "members": { - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateTrialRequest": { - "type": "structure", - "members": { - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the trial. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.
The name of the experiment to associate the trial with.
", - "smithy.api#required": {} - } - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags to associate with the trial. You can use Search API to\n search on the tags.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateTrialResponse": { - "type": "structure", - "members": { - "TrialArn": { - "target": "com.amazonaws.sagemaker#TrialArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateUserProfileRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateUserProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to a domain. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user\n profile is automatically created. A user profile is the primary holder of settings for an\n individual user and has a reference to the user's private Amazon Elastic File System home\n directory.
" - } - }, - "com.amazonaws.sagemaker#CreateUserProfileRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the associated Domain.
", - "smithy.api#required": {} - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A name for the UserProfile. This value is not case sensitive.
", - "smithy.api#required": {} - } - }, - "SingleSignOnUserIdentifier": { - "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", - "traits": { - "smithy.api#documentation": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only\n supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is\n required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.\n
" - } - }, - "SingleSignOnUserValue": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The username of the associated Amazon Web Services Single Sign-On User for this\n UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must\n match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
\nTags that you specify for the User Profile are also added to all Apps that the User\n Profile launches.
" - } - }, - "UserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", - "traits": { - "smithy.api#documentation": "A collection of settings.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateUserProfileResponse": { - "type": "structure", - "members": { - "UserProfileArn": { - "target": "com.amazonaws.sagemaker#UserProfileArn", - "traits": { - "smithy.api#documentation": "The user profile Amazon Resource Name (ARN).
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateWorkforce": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateWorkforceRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateWorkforceResponse" - }, - "traits": { - "smithy.api#documentation": "Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the Amazon Web Services Region that you specify. You can only\n create one workforce in each Amazon Web Services Region per Amazon Web Services account.
\nIf you want to create a new workforce in an Amazon Web Services Region where \n a workforce already exists, use the DeleteWorkforce API\n operation to delete the existing workforce and then use CreateWorkforce \n to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. Your OIDC IdP must support groups\n because groups are used by Ground Truth and Amazon A2I to create work teams. \n For more information, see \n Create a Private Workforce (OIDC IdP).
Use this parameter to configure an Amazon Cognito private workforce.\n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.
\nDo not use OidcConfig if you specify values for \n CognitoConfig.
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
\nDo not use CognitoConfig if you specify values for \n OidcConfig.
The name of the private workforce.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs that contain metadata to help you categorize and \n organize our workforce. Each tag consists of a key and a value, \n both of which you define.
" - } - }, - "WorkforceVpcConfig": { - "target": "com.amazonaws.sagemaker#WorkforceVpcConfigRequest", - "traits": { - "smithy.api#documentation": "Use this parameter to configure a workforce using VPC.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateWorkforceResponse": { - "type": "structure", - "members": { - "WorkforceArn": { - "target": "com.amazonaws.sagemaker#WorkforceArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workforce.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreateWorkteam": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#CreateWorkteamRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#CreateWorkteamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new work team for labeling your data. A work team is defined by one or more\n Amazon Cognito user pools. You must first create the user pools before you can create a work\n team.
\nYou cannot create more than 25 work teams in an account and region.
" - } - }, - "com.amazonaws.sagemaker#CreateWorkteamRequest": { - "type": "structure", - "members": { - "WorkteamName": { - "target": "com.amazonaws.sagemaker#WorkteamName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the work team. Use this name to identify the work team.
", - "smithy.api#required": {} - } - }, - "WorkforceName": { - "target": "com.amazonaws.sagemaker#WorkforceName", - "traits": { - "smithy.api#documentation": "The name of the workforce.
" - } - }, - "MemberDefinitions": { - "target": "com.amazonaws.sagemaker#MemberDefinitions", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For\n private workforces created using Amazon Cognito use CognitoMemberDefinition. For\n workforces created using your own OIDC identity provider (IdP) use\n OidcMemberDefinition. Do not provide input for both of these parameters\n in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to \n include in your private work team in OidcMemberDefinition by listing those groups\n in Groups.
A description of the work team.
", - "smithy.api#required": {} - } - }, - "NotificationConfiguration": { - "target": "com.amazonaws.sagemaker#NotificationConfiguration", - "traits": { - "smithy.api#documentation": "Configures notification of workers regarding available or expiring work items.
" - } - }, - "WorkerAccessConfiguration": { - "target": "com.amazonaws.sagemaker#WorkerAccessConfiguration", - "traits": { - "smithy.api#documentation": "Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs.
\nFor more information, see Resource\n Tag and Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#CreateWorkteamResponse": { - "type": "structure", - "members": { - "WorkteamArn": { - "target": "com.amazonaws.sagemaker#WorkteamArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the\n work team.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#CreationTime": { - "type": "timestamp" - }, - "com.amazonaws.sagemaker#CrossAccountFilterOption": { - "type": "enum", - "members": { - "SAME_ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SameAccount" - } - }, - "CROSS_ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CrossAccount" - } - } - } - }, - "com.amazonaws.sagemaker#CsvContentType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*$" - } - }, - "com.amazonaws.sagemaker#CsvContentTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CsvContentType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#CurrencyCode": { - "type": "string" - }, - "com.amazonaws.sagemaker#CustomFileSystem": { - "type": "union", - "members": { - "EFSFileSystem": { - "target": "com.amazonaws.sagemaker#EFSFileSystem", - "traits": { - "smithy.api#documentation": "A custom file system in Amazon EFS.
" - } - }, - "FSxLustreFileSystem": { - "target": "com.amazonaws.sagemaker#FSxLustreFileSystem", - "traits": { - "smithy.api#documentation": "A custom file system in Amazon FSx for Lustre.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\n Studio.
" - } - }, - "com.amazonaws.sagemaker#CustomFileSystemConfig": { - "type": "union", - "members": { - "EFSFileSystemConfig": { - "target": "com.amazonaws.sagemaker#EFSFileSystemConfig", - "traits": { - "smithy.api#documentation": "The settings for a custom Amazon EFS file system.
" - } - }, - "FSxLustreFileSystemConfig": { - "target": "com.amazonaws.sagemaker#FSxLustreFileSystemConfig", - "traits": { - "smithy.api#documentation": "The settings for a custom Amazon FSx for Lustre file system.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\n Studio.
" - } - }, - "com.amazonaws.sagemaker#CustomFileSystemConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CustomFileSystemConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#CustomFileSystems": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CustomFileSystem" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#CustomImage": { - "type": "structure", - "members": { - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the CustomImage. Must be unique to your account.
", - "smithy.api#required": {} - } - }, - "ImageVersionNumber": { - "target": "com.amazonaws.sagemaker#ImageVersionNumber", - "traits": { - "smithy.api#documentation": "The version number of the CustomImage.
" - } - }, - "AppImageConfigName": { - "target": "com.amazonaws.sagemaker#AppImageConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the AppImageConfig.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A custom SageMaker AI image. For more information, see\n Bring your own SageMaker AI image.
" - } - }, - "com.amazonaws.sagemaker#CustomImageContainerArguments": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#NonEmptyString64" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#CustomImageContainerEntrypoint": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#NonEmptyString256" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#CustomImageContainerEnvironmentVariables": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#NonEmptyString256" - }, - "value": { - "target": "com.amazonaws.sagemaker#String256" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.sagemaker#CustomImages": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CustomImage" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.sagemaker#CustomPosixUserConfig": { - "type": "structure", - "members": { - "Uid": { - "target": "com.amazonaws.sagemaker#Uid", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The POSIX user ID.
", - "smithy.api#required": {} - } - }, - "Gid": { - "target": "com.amazonaws.sagemaker#Gid", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The POSIX group ID.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the POSIX identity that is used for file system operations.
" - } - }, - "com.amazonaws.sagemaker#CustomerMetadataKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}$" - } - }, - "com.amazonaws.sagemaker#CustomerMetadataKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#CustomerMetadataKey" - } - }, - "com.amazonaws.sagemaker#CustomerMetadataMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#CustomerMetadataKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#CustomerMetadataValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#CustomerMetadataValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}$" - } - }, - "com.amazonaws.sagemaker#CustomizedMetricSpecification": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The name of the customized metric.
" - } - }, - "Namespace": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The namespace of the customized metric.
" - } - }, - "Statistic": { - "target": "com.amazonaws.sagemaker#Statistic", - "traits": { - "smithy.api#documentation": "The statistic of the customized metric.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A customized metric.
" - } - }, - "com.amazonaws.sagemaker#DataCaptureConfig": { - "type": "structure", - "members": { - "EnableCapture": { - "target": "com.amazonaws.sagemaker#EnableCapture", - "traits": { - "smithy.api#documentation": "Whether data capture should be enabled or disabled (defaults to enabled).
" - } - }, - "InitialSamplingPercentage": { - "target": "com.amazonaws.sagemaker#SamplingPercentage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The percentage of requests SageMaker AI will capture. A lower value is recommended\n for Endpoints with high traffic.
", - "smithy.api#required": {} - } - }, - "DestinationS3Uri": { - "target": "com.amazonaws.sagemaker#DestinationS3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 location used to capture the data.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI\n uses to encrypt the captured data at rest using Amazon S3 server-side\n encryption.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
Specifies data Model Monitor will capture. You can configure whether to collect only\n input, only output, or both
", - "smithy.api#required": {} - } - }, - "CaptureContentTypeHeader": { - "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader", - "traits": { - "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified\n SageMaker AI will by default base64 encode when capturing the data.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration to control how SageMaker AI captures inference data.
" - } - }, - "com.amazonaws.sagemaker#DataCaptureConfigSummary": { - "type": "structure", - "members": { - "EnableCapture": { - "target": "com.amazonaws.sagemaker#EnableCapture", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Whether data capture is enabled or disabled.
", - "smithy.api#required": {} - } - }, - "CaptureStatus": { - "target": "com.amazonaws.sagemaker#CaptureStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Whether data capture is currently functional.
", - "smithy.api#required": {} - } - }, - "CurrentSamplingPercentage": { - "target": "com.amazonaws.sagemaker#SamplingPercentage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The percentage of requests being captured by your Endpoint.
", - "smithy.api#required": {} - } - }, - "DestinationS3Uri": { - "target": "com.amazonaws.sagemaker#DestinationS3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 location being used to capture the data.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The KMS key being used to encrypt the data in Amazon S3.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The currently active data capture configuration used by your Endpoint.
" - } - }, - "com.amazonaws.sagemaker#DataCatalogConfig": { - "type": "structure", - "members": { - "TableName": { - "target": "com.amazonaws.sagemaker#TableName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Glue table.
", - "smithy.api#required": {} - } - }, - "Catalog": { - "target": "com.amazonaws.sagemaker#Catalog", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Glue table catalog.
", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.sagemaker#Database", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Glue table database.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The meta data of the Glue table which serves as data catalog for the\n OfflineStore.
A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.
Examples: \"$\", \"$[1:]\", \"$.features\"\n
A JSONPath expression used to select a portion of the joined dataset to save\n in the output file for a batch transform job. If you want SageMaker to store the entire input\n dataset in the output file, leave the default value, $. If you specify\n indexes that aren't within the dimension size of the joined dataset, you get an\n error.
Examples: \"$\", \"$[0,5:]\",\n \"$['id','SageMakerOutput']\"\n
Specifies the source of the data to join with the transformed data. The valid values\n are None and Input. The default value is None,\n which specifies not to join the input with the transformed data. If you want the batch\n transform job to join the original input data with the transformed data, set\n JoinSource to Input. You can specify\n OutputFilter as an additional filter to select a portion of the joined\n dataset and store it in the output file.
For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to\n the input JSON object in an attribute called SageMakerOutput. The joined\n result for JSON must be a key-value pair object. If the input is not a key-value pair\n object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored\n under the SageMakerInput key and the results are stored in\n SageMakerOutput.
For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with\n the input by appending each transformed row to the end of the input. The joined data has\n the original input data followed by the transformed data and the output is a CSV\n file.
\nFor information on how joining in applied, see Workflow for Associating Inferences with Input Records.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.
" - } - }, - "com.amazonaws.sagemaker#DataQualityAppSpecification": { - "type": "structure", - "members": { - "ImageUri": { - "target": "com.amazonaws.sagemaker#ImageUri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The container image that the data quality monitoring job runs.
", - "smithy.api#required": {} - } - }, - "ContainerEntrypoint": { - "target": "com.amazonaws.sagemaker#ContainerEntrypoint", - "traits": { - "smithy.api#documentation": "The entrypoint for a container used to run a monitoring job.
" - } - }, - "ContainerArguments": { - "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", - "traits": { - "smithy.api#documentation": "The arguments to send to the container that the monitoring job runs.
" - } - }, - "RecordPreprocessorSourceUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" - } - }, - "PostAnalyticsProcessorSourceUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", - "traits": { - "smithy.api#documentation": "Sets the environment variables in the container that the monitoring job runs.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the container that a data quality monitoring job runs.
" - } - }, - "com.amazonaws.sagemaker#DataQualityBaselineConfig": { - "type": "structure", - "members": { - "BaseliningJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#documentation": "The name of the job that performs baselining for the data quality monitoring job.
" - } - }, - "ConstraintsResource": { - "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" - }, - "StatisticsResource": { - "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource" - } - }, - "traits": { - "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" - } - }, - "com.amazonaws.sagemaker#DataQualityJobInput": { - "type": "structure", - "members": { - "EndpointInput": { - "target": "com.amazonaws.sagemaker#EndpointInput" - }, - "BatchTransformInput": { - "target": "com.amazonaws.sagemaker#BatchTransformInput", - "traits": { - "smithy.api#documentation": "Input object for the batch transform job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input for the data quality monitoring job. Currently endpoints are supported for\n input.
" - } - }, - "com.amazonaws.sagemaker#DataSource": { - "type": "structure", - "members": { - "S3DataSource": { - "target": "com.amazonaws.sagemaker#S3DataSource", - "traits": { - "smithy.api#documentation": "The S3 location of the data source that is associated with a channel.
" - } - }, - "FileSystemDataSource": { - "target": "com.amazonaws.sagemaker#FileSystemDataSource", - "traits": { - "smithy.api#documentation": "The file system that is associated with a channel.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the location of the channel data.
" - } - }, - "com.amazonaws.sagemaker#DataSourceName": { - "type": "enum", - "members": { - "SalesforceGenie": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SalesforceGenie" - } - }, - "Snowflake": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Snowflake" - } - } - } - }, - "com.amazonaws.sagemaker#Database": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" - } - }, - "com.amazonaws.sagemaker#DatasetDefinition": { - "type": "structure", - "members": { - "AthenaDatasetDefinition": { - "target": "com.amazonaws.sagemaker#AthenaDatasetDefinition" - }, - "RedshiftDatasetDefinition": { - "target": "com.amazonaws.sagemaker#RedshiftDatasetDefinition" - }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#ProcessingLocalPath", - "traits": { - "smithy.api#documentation": "The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a\n processing job. LocalPath is an absolute path to the input data. This is a required\n parameter when AppManaged is False (default).
Whether the generated dataset is FullyReplicated or\n ShardedByS3Key (default).
Whether to use File or Pipe input mode. In File (default) mode,\n Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store\n (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used\n input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your\n algorithm without using the EBS volume.
Configuration for Dataset Definition inputs. The Dataset Definition input must specify\n exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition\n types.
Path to local storage location for metrics and tensors. Defaults to\n /opt/ml/output/tensors/.
Path to Amazon S3 storage location for metrics and tensors.
", - "smithy.api#required": {} - } - }, - "HookParameters": { - "target": "com.amazonaws.sagemaker#HookParameters", - "traits": { - "smithy.api#documentation": "Configuration information for the Amazon SageMaker Debugger hook parameters.
" - } - }, - "CollectionConfigurations": { - "target": "com.amazonaws.sagemaker#CollectionConfigurations", - "traits": { - "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about\n how to configure the CollectionConfiguration parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n
Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and\n storage paths. To learn more about\n how to configure the DebugHookConfig parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the rule configuration. It must be unique relative to other rule\n configuration names.
", - "smithy.api#required": {} - } - }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#DirectoryPath", - "traits": { - "smithy.api#documentation": "Path to local storage location for output of rules. Defaults to\n /opt/ml/processing/output/rule/.
Path to Amazon S3 storage location for rules.
" - } - }, - "RuleEvaluatorImage": { - "target": "com.amazonaws.sagemaker#AlgorithmImage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProcessingInstanceType", - "traits": { - "smithy.api#documentation": "The instance type to deploy a custom rule for debugging a training job.
" - } - }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", - "traits": { - "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to the processing instance.
" - } - }, - "RuleParameters": { - "target": "com.amazonaws.sagemaker#RuleParameters", - "traits": { - "smithy.api#documentation": "Runtime configuration for rule container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration information for SageMaker Debugger rules for debugging. To learn more about\n how to configure the DebugRuleConfiguration parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the rule configuration.
" - } - }, - "RuleEvaluationJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule evaluation job.
" - } - }, - "RuleEvaluationStatus": { - "target": "com.amazonaws.sagemaker#RuleEvaluationStatus", - "traits": { - "smithy.api#documentation": "Status of the rule evaluation.
" - } - }, - "StatusDetails": { - "target": "com.amazonaws.sagemaker#StatusDetails", - "traits": { - "smithy.api#documentation": "Details from the rule evaluation.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Timestamp when the rule evaluation status was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the status of the rule evaluation.
" - } - }, - "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatus" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#DeepHealthCheckType": { - "type": "enum", - "members": { - "INSTANCE_STRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceStress" - } - }, - "INSTANCE_CONNECTIVITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceConnectivity" - } - } - } - }, - "com.amazonaws.sagemaker#DefaultEbsStorageSettings": { - "type": "structure", - "members": { - "DefaultEbsVolumeSizeInGb": { - "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The default size of the EBS storage volume for a space.
", - "smithy.api#required": {} - } - }, - "MaximumEbsVolumeSizeInGb": { - "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum size of the EBS storage volume for a space.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
" - } - }, - "com.amazonaws.sagemaker#DefaultGid": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.sagemaker#DefaultSpaceSettings": { - "type": "structure", - "members": { - "ExecutionRole": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The ARN of the execution role for the space.
" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.sagemaker#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "The security group IDs for the Amazon VPC that the space uses for\n communication.
" - } - }, - "JupyterServerAppSettings": { - "target": "com.amazonaws.sagemaker#JupyterServerAppSettings" - }, - "KernelGatewayAppSettings": { - "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings" - }, - "JupyterLabAppSettings": { - "target": "com.amazonaws.sagemaker#JupyterLabAppSettings" - }, - "SpaceStorageSettings": { - "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings" - }, - "CustomPosixUserConfig": { - "target": "com.amazonaws.sagemaker#CustomPosixUserConfig" - }, - "CustomFileSystemConfigs": { - "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", - "traits": { - "smithy.api#documentation": "The settings for assigning a custom file system to a domain. Permitted users can access\n this file system in Amazon SageMaker AI Studio.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The default settings for shared spaces that users create in the domain.
\nSageMaker applies these settings only to shared spaces. It doesn't apply them to private\n spaces.
" - } - }, - "com.amazonaws.sagemaker#DefaultSpaceStorageSettings": { - "type": "structure", - "members": { - "DefaultEbsStorageSettings": { - "target": "com.amazonaws.sagemaker#DefaultEbsStorageSettings", - "traits": { - "smithy.api#documentation": "The default EBS storage settings for a space.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The default storage settings for a space.
" - } - }, - "com.amazonaws.sagemaker#DefaultUid": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.sagemaker#DeleteAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteActionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteActionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an action.
" - } - }, - "com.amazonaws.sagemaker#DeleteActionRequest": { - "type": "structure", - "members": { - "ActionName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the action to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteActionResponse": { - "type": "structure", - "members": { - "ActionArn": { - "target": "com.amazonaws.sagemaker#ActionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteAlgorithm": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteAlgorithmInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - } - ], - "traits": { - "smithy.api#documentation": "Removes the specified algorithm from your account.
" - } - }, - "com.amazonaws.sagemaker#DeleteAlgorithmInput": { - "type": "structure", - "members": { - "AlgorithmName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the algorithm to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteAppRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Used to stop and delete an app.
" - } - }, - "com.amazonaws.sagemaker#DeleteAppImageConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteAppImageConfigRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an AppImageConfig.
" - } - }, - "com.amazonaws.sagemaker#DeleteAppImageConfigRequest": { - "type": "structure", - "members": { - "AppImageConfigName": { - "target": "com.amazonaws.sagemaker#AppImageConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the AppImageConfig to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteAppRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The domain ID.
", - "smithy.api#required": {} - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be\n set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
The type of app.
", - "smithy.api#required": {} - } - }, - "AppName": { - "target": "com.amazonaws.sagemaker#AppName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteArtifact": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteArtifactRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteArtifactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an artifact. Either ArtifactArn or Source must be\n specified.
The Amazon Resource Name (ARN) of the artifact to delete.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ArtifactSource", - "traits": { - "smithy.api#documentation": "The URI of the source.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteArtifactResponse": { - "type": "structure", - "members": { - "ArtifactArn": { - "target": "com.amazonaws.sagemaker#ArtifactArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteAssociationRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an association.
" - } - }, - "com.amazonaws.sagemaker#DeleteAssociationRequest": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the source.
", - "smithy.api#required": {} - } - }, - "DestinationArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteAssociationResponse": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#documentation": "The ARN of the source.
" - } - }, - "DestinationArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteClusterRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Delete a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#DeleteClusterRequest": { - "type": "structure", - "members": { - "ClusterName": { - "target": "com.amazonaws.sagemaker#ClusterNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteClusterResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteClusterSchedulerConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteClusterSchedulerConfigRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the cluster policy of the cluster.
" - } - }, - "com.amazonaws.sagemaker#DeleteClusterSchedulerConfigRequest": { - "type": "structure", - "members": { - "ClusterSchedulerConfigId": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the cluster policy.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteCodeRepository": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteCodeRepositoryInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Deletes the specified Git repository from your account.
" - } - }, - "com.amazonaws.sagemaker#DeleteCodeRepositoryInput": { - "type": "structure", - "members": { - "CodeRepositoryName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Git repository to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteCompilationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteCompilationJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified compilation job. This action deletes only the compilation job\n resource in Amazon SageMaker AI. It doesn't delete other resources that are related to\n that job, such as the model artifacts that the job creates, the compilation logs in\n CloudWatch, the compiled model, or the IAM role.
\nYou can delete a compilation job only if its current status is COMPLETED,\n FAILED, or STOPPED. If the job status is\n STARTING or INPROGRESS, stop the job, and then delete it\n after its status becomes STOPPED.
The name of the compilation job to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteComputeQuota": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteComputeQuotaRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the compute allocation from the cluster.
" - } - }, - "com.amazonaws.sagemaker#DeleteComputeQuotaRequest": { - "type": "structure", - "members": { - "ComputeQuotaId": { - "target": "com.amazonaws.sagemaker#ComputeQuotaId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the compute allocation definition.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteContext": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteContextRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteContextResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an context.
" - } - }, - "com.amazonaws.sagemaker#DeleteContextRequest": { - "type": "structure", - "members": { - "ContextName": { - "target": "com.amazonaws.sagemaker#ContextName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the context to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteContextResponse": { - "type": "structure", - "members": { - "ContextArn": { - "target": "com.amazonaws.sagemaker#ContextArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteDataQualityJobDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteDataQualityJobDefinitionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a data quality monitoring job definition.
" - } - }, - "com.amazonaws.sagemaker#DeleteDataQualityJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the data quality monitoring job definition to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteDeviceFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteDeviceFleetRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a fleet.
" - } - }, - "com.amazonaws.sagemaker#DeleteDeviceFleetRequest": { - "type": "structure", - "members": { - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteDomainRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Used to delete a domain. If you onboarded with IAM mode, you will need to delete your\n domain to onboard again using IAM Identity Center. Use with caution. All of the members of the\n domain will lose access to their EFS volume, including data, notebooks, and other artifacts.\n
" - } - }, - "com.amazonaws.sagemaker#DeleteDomainRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The domain ID.
", - "smithy.api#required": {} - } - }, - "RetentionPolicy": { - "target": "com.amazonaws.sagemaker#RetentionPolicy", - "traits": { - "smithy.api#documentation": "The retention policy for this domain, which specifies whether resources will be retained\n after the Domain is deleted. By default, all resources are retained (not automatically\n deleted).
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlan": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlanRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an edge deployment plan if (and only if) all the stages in the plan are\n inactive or there are no stages in the plan.
" - } - }, - "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlanRequest": { - "type": "structure", - "members": { - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteEdgeDeploymentStage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteEdgeDeploymentStageRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - } - ], - "traits": { - "smithy.api#documentation": "Delete a stage in an edge deployment plan if (and only if) the stage is\n inactive.
" - } - }, - "com.amazonaws.sagemaker#DeleteEdgeDeploymentStageRequest": { - "type": "structure", - "members": { - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan from which the stage will be deleted.
", - "smithy.api#required": {} - } - }, - "StageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stage.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteEndpointInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the\n endpoint was created.
\nSageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.
\nWhen you delete your endpoint, SageMaker asynchronously deletes associated endpoint\n resources such as KMS key grants. You might still see these resources in your account\n for a few minutes after deleting your endpoint. Do not delete or revoke the permissions\n for your \n ExecutionRoleArn\n , otherwise SageMaker cannot delete these\n resources.
Deletes an endpoint configuration. The DeleteEndpointConfig API\n deletes only the specified configuration. It does not delete endpoints created using the\n configuration.
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint operations\n are being performed on the endpoint. If you delete the EndpointConfig of an\n endpoint that is active or being created or updated you may lose visibility into the\n instance type the endpoint is using. The endpoint must be deleted in order to stop\n incurring charges.
The name of the endpoint configuration that you want to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteEndpointInput": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint that you want to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteExperimentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an SageMaker experiment. All trials associated with the experiment must be deleted\n first. Use the ListTrials API to get a list of the trials associated with\n the experiment.
" - } - }, - "com.amazonaws.sagemaker#DeleteExperimentRequest": { - "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the experiment to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteExperimentResponse": { - "type": "structure", - "members": { - "ExperimentArn": { - "target": "com.amazonaws.sagemaker#ExperimentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment that is being deleted.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteFeatureGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteFeatureGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Delete the FeatureGroup and any data that was written to the\n OnlineStore of the FeatureGroup. Data cannot be accessed from\n the OnlineStore immediately after DeleteFeatureGroup is called.
Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your\n OfflineStore are not deleted.
Note that it can take approximately 10-15 minutes to delete an OnlineStore\n FeatureGroup with the InMemory\n StorageType.
The name of the FeatureGroup you want to delete. The name must be unique\n within an Amazon Web Services Region in an Amazon Web Services account.
Deletes the specified flow definition.
" - } - }, - "com.amazonaws.sagemaker#DeleteFlowDefinitionRequest": { - "type": "structure", - "members": { - "FlowDefinitionName": { - "target": "com.amazonaws.sagemaker#FlowDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the flow definition you are deleting.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteFlowDefinitionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteHub": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteHubRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Delete a hub.
" - } - }, - "com.amazonaws.sagemaker#DeleteHubContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteHubContentRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Delete the contents of a hub.
" - } - }, - "com.amazonaws.sagemaker#DeleteHubContentReference": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteHubContentReferenceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Delete a hub content reference in order to remove a model from a private hub.
" - } - }, - "com.amazonaws.sagemaker#DeleteHubContentReferenceRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub to delete the hub content reference from.
", - "smithy.api#required": {} - } - }, - "HubContentType": { - "target": "com.amazonaws.sagemaker#HubContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of hub content reference to delete. The only supported type of hub content reference to delete is ModelReference.
The name of the hub content to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteHubContentRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub that you want to delete content in.
", - "smithy.api#required": {} - } - }, - "HubContentType": { - "target": "com.amazonaws.sagemaker#HubContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of content that you want to delete from a hub.
", - "smithy.api#required": {} - } - }, - "HubContentName": { - "target": "com.amazonaws.sagemaker#HubContentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the content that you want to delete from a hub.
", - "smithy.api#required": {} - } - }, - "HubContentVersion": { - "target": "com.amazonaws.sagemaker#HubContentVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the content that you want to delete from a hub.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteHubRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteHumanTaskUi": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteHumanTaskUiRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteHumanTaskUiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Use this operation to delete a human task user interface (worker task template).
\n\n To see a list of human task user interfaces\n (work task templates) in your account, use ListHumanTaskUis.\n When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.
The name of the human task user interface (work task template) you want to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteHumanTaskUiResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteHyperParameterTuningJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteHyperParameterTuningJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob\n API deletes only the tuning job entry that was created in SageMaker when you called the\n CreateHyperParameterTuningJob API. It does not delete training jobs,\n artifacts, or the IAM role that you specified when creating the model.
The name of the hyperparameter tuning job that you want to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteImageRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteImageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a SageMaker AI image and all versions of the image. The container images aren't\n deleted.
" - } - }, - "com.amazonaws.sagemaker#DeleteImageRequest": { - "type": "structure", - "members": { - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteImageResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteImageVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteImageVersionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteImageVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a version of a SageMaker AI image. The container image the version represents isn't\n deleted.
" - } - }, - "com.amazonaws.sagemaker#DeleteImageVersionRequest": { - "type": "structure", - "members": { - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image to delete.
", - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.sagemaker#ImageVersionNumber", - "traits": { - "smithy.api#documentation": "The version to delete.
" - } - }, - "Alias": { - "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", - "traits": { - "smithy.api#documentation": "The alias of the image to delete.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteImageVersionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteInferenceComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteInferenceComponentInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Deletes an inference component.
" - } - }, - "com.amazonaws.sagemaker#DeleteInferenceComponentInput": { - "type": "structure", - "members": { - "InferenceComponentName": { - "target": "com.amazonaws.sagemaker#InferenceComponentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference component to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteInferenceExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteInferenceExperimentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteInferenceExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an inference experiment.
\n\n This operation does not delete your endpoint, variants, or any underlying resources. This operation only\n deletes the metadata of your experiment.\n
\nThe name of the inference experiment you want to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteInferenceExperimentResponse": { - "type": "structure", - "members": { - "InferenceExperimentArn": { - "target": "com.amazonaws.sagemaker#InferenceExperimentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the deleted inference experiment.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteMlflowTrackingServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
" - } - }, - "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest": { - "type": "structure", - "members": { - "TrackingServerName": { - "target": "com.amazonaws.sagemaker#TrackingServerName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the the tracking server to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse": { - "type": "structure", - "members": { - "TrackingServerArn": { - "target": "com.amazonaws.sagemaker#TrackingServerArn", - "traits": { - "smithy.api#documentation": "A TrackingServerArn object, the ARN of the tracking server that is deleted if\n successfully found.
Deletes a model. The DeleteModel API deletes only the model entry that\n was created in SageMaker when you called the CreateModel API. It does not delete\n model artifacts, inference code, or the IAM role that you specified when creating the\n model.
Deletes an Amazon SageMaker AI model bias job definition.
" - } - }, - "com.amazonaws.sagemaker#DeleteModelBiasJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model bias job definition to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteModelCard": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteModelCardRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an Amazon SageMaker Model Card.
" - } - }, - "com.amazonaws.sagemaker#DeleteModelCardRequest": { - "type": "structure", - "members": { - "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model card to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinitionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an Amazon SageMaker AI model explainability job definition.
" - } - }, - "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model explainability job definition to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteModelInput": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteModelPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteModelPackageInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a model package.
\nA model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can\n subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
" - } - }, - "com.amazonaws.sagemaker#DeleteModelPackageGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified model group.
" - } - }, - "com.amazonaws.sagemaker#DeleteModelPackageGroupInput": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#ArnOrName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model group to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicyInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Deletes a model group resource policy.
" - } - }, - "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicyInput": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model group for which to delete the policy.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteModelPackageInput": { - "type": "structure", - "members": { - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#VersionedArnOrName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to delete.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteModelQualityJobDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteModelQualityJobDefinitionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the secified model quality monitoring job definition.
" - } - }, - "com.amazonaws.sagemaker#DeleteModelQualityJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model quality monitoring job definition to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteMonitoringSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteMonitoringScheduleRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a monitoring schedule. Also stops the schedule had not already been stopped.\n This does not delete the job execution history of the monitoring schedule.
" - } - }, - "com.amazonaws.sagemaker#DeleteMonitoringScheduleRequest": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the monitoring schedule to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteNotebookInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": " Deletes an SageMaker AI notebook instance. Before you can delete a notebook\n instance, you must call the StopNotebookInstance API.
When you delete a notebook instance, you lose all of your data. SageMaker AI removes the ML compute instance, and deletes the ML storage volume and the\n network interface associated with the notebook instance.
\nThe name of the SageMaker AI notebook instance to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfigInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Deletes a notebook instance lifecycle configuration.
" - } - }, - "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfigInput": { - "type": "structure", - "members": { - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the lifecycle configuration to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteOptimizationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteOptimizationJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an optimization job.
" - } - }, - "com.amazonaws.sagemaker#DeleteOptimizationJobRequest": { - "type": "structure", - "members": { - "OptimizationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name that you assigned to the optimization job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeletePartnerApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeletePartnerAppRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeletePartnerAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a SageMaker Partner AI App.
" - } - }, - "com.amazonaws.sagemaker#DeletePartnerAppRequest": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#PartnerAppArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to delete.
", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.sagemaker#ClientToken", - "traits": { - "smithy.api#documentation": "A unique token that guarantees that the call to this API is idempotent.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeletePartnerAppResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#PartnerAppArn", - "traits": { - "smithy.api#documentation": "The ARN of the SageMaker Partner AI App that was deleted.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeletePipeline": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeletePipelineRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeletePipelineResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a pipeline if there are no running instances of the pipeline. To delete a\n pipeline, you must stop all running instances of the pipeline using the\n StopPipelineExecution API. When you delete a pipeline, all instances of the\n pipeline are deleted.
The name of the pipeline to delete.
", - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.sagemaker#IdempotencyToken", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeletePipelineResponse": { - "type": "structure", - "members": { - "PipelineArn": { - "target": "com.amazonaws.sagemaker#PipelineArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline to delete.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteProjectInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - } - ], - "traits": { - "smithy.api#documentation": "Delete the specified project.
" - } - }, - "com.amazonaws.sagemaker#DeleteProjectInput": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.sagemaker#ProjectEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the project to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteSpace": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteSpaceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Used to delete a space.
" - } - }, - "com.amazonaws.sagemaker#DeleteSpaceRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the associated domain.
", - "smithy.api#required": {} - } - }, - "SpaceName": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the space.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteStudioLifecycleConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the\n Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You\n must also remove the Lifecycle Configuration from UserSettings in all Domains and\n UserProfiles.
" - } - }, - "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest": { - "type": "structure", - "members": { - "StudioLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteTagsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteTagsOutput" - }, - "traits": { - "smithy.api#documentation": "Deletes the specified tags from an SageMaker resource.
\nTo list a resource's tags, use the ListTags API.
When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.
\nWhen you call this API to delete tags from a SageMaker Domain or User Profile, the\n deleted tags are not removed from Apps that the SageMaker Domain or User Profile\n launched before you called this API.
\nThe Amazon Resource Name (ARN) of the resource whose tags you want to\n delete.
", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.sagemaker#TagKeyList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array or one or more tag keys to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteTagsOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteTrial": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteTrialRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteTrialResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified trial. All trial components that make up the trial must be deleted\n first. Use the DescribeTrialComponent API to get the list of trial\n components.
" - } - }, - "com.amazonaws.sagemaker#DeleteTrialComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteTrialComponentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteTrialComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified trial component. A trial component must be disassociated from all\n trials before the trial component can be deleted. To disassociate a trial component from a\n trial, call the DisassociateTrialComponent API.
" - } - }, - "com.amazonaws.sagemaker#DeleteTrialComponentRequest": { - "type": "structure", - "members": { - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the component to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteTrialComponentResponse": { - "type": "structure", - "members": { - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the component is being deleted.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteTrialRequest": { - "type": "structure", - "members": { - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the trial to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteTrialResponse": { - "type": "structure", - "members": { - "TrialArn": { - "target": "com.amazonaws.sagemaker#TrialArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial that is being deleted.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteUserProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a user profile. When a user profile is deleted, the user loses access to their EFS\n volume, including data, notebooks, and other artifacts.
" - } - }, - "com.amazonaws.sagemaker#DeleteUserProfileRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The domain ID.
", - "smithy.api#required": {} - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The user profile name.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteWorkforce": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteWorkforceRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteWorkforceResponse" - }, - "traits": { - "smithy.api#documentation": "Use this operation to delete a workforce.
\nIf you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use CreateWorkforce\n to create a new workforce.
\nIf a private workforce contains one or more work teams, you must use \n the DeleteWorkteam\n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will receive a ResourceInUse error.
The name of the workforce.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteWorkforceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DeleteWorkteam": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeleteWorkteamRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DeleteWorkteamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an existing work team. This operation can't be undone.
" - } - }, - "com.amazonaws.sagemaker#DeleteWorkteamRequest": { - "type": "structure", - "members": { - "WorkteamName": { - "target": "com.amazonaws.sagemaker#WorkteamName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the work team to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DeleteWorkteamResponse": { - "type": "structure", - "members": { - "Success": { - "target": "com.amazonaws.sagemaker#Success", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns true if the work team was successfully deleted; otherwise,\n returns false.
The image path you specified when you created the model.
" - } - }, - "ResolvedImage": { - "target": "com.amazonaws.sagemaker#ContainerImage", - "traits": { - "smithy.api#documentation": "The specific digest path of the image hosted in this\n ProductionVariant.
The date and time when the image path for the model resolved to the\n ResolvedImage\n
Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.
\nIf you used the registry/repository[:tag] form to specify the image path\n of the primary container when you created the model hosted in this\n ProductionVariant, the path resolves to a path of the form\n registry/repository[@digest]. A digest is a hash value that identifies\n a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.
Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.
" - } - }, - "RollingUpdatePolicy": { - "target": "com.amazonaws.sagemaker#RollingUpdatePolicy", - "traits": { - "smithy.api#documentation": "Specifies a rolling deployment strategy for updating a SageMaker endpoint.
" - } - }, - "AutoRollbackConfiguration": { - "target": "com.amazonaws.sagemaker#AutoRollbackConfig", - "traits": { - "smithy.api#documentation": "Automatic rollback configuration for handling endpoint deployment failures and\n recovery.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.
" - } - }, - "com.amazonaws.sagemaker#DeploymentRecommendation": { - "type": "structure", - "members": { - "RecommendationStatus": { - "target": "com.amazonaws.sagemaker#RecommendationStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker\n is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS,\n retry your API call after a few seconds to get a COMPLETED deployment recommendation.
A list of RealTimeInferenceRecommendation items.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A set of recommended deployment configurations for the model. To get more advanced recommendations, see\n CreateInferenceRecommendationsJob\n to create an inference recommendation job.
" - } - }, - "com.amazonaws.sagemaker#DeploymentStage": { - "type": "structure", - "members": { - "StageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stage.
", - "smithy.api#required": {} - } - }, - "DeviceSelectionConfig": { - "target": "com.amazonaws.sagemaker#DeviceSelectionConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configuration of the devices in the stage.
", - "smithy.api#required": {} - } - }, - "DeploymentConfig": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentConfig", - "traits": { - "smithy.api#documentation": "Configuration of the deployment details.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a stage in an edge deployment plan.
" - } - }, - "com.amazonaws.sagemaker#DeploymentStageMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#DeploymentStageStatusSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#DeploymentStageStatusSummary" - } - }, - "com.amazonaws.sagemaker#DeploymentStageStatusSummary": { - "type": "structure", - "members": { - "StageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stage.
", - "smithy.api#required": {} - } - }, - "DeviceSelectionConfig": { - "target": "com.amazonaws.sagemaker#DeviceSelectionConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configuration of the devices in the stage.
", - "smithy.api#required": {} - } - }, - "DeploymentConfig": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configuration of the deployment details.
", - "smithy.api#required": {} - } - }, - "DeploymentStatus": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "General status of the current state.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information summarizing the deployment stage results.
" - } - }, - "com.amazonaws.sagemaker#DeploymentStages": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#DeploymentStage" - } - }, - "com.amazonaws.sagemaker#DeregisterDevices": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DeregisterDevicesRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
" - } - }, - "com.amazonaws.sagemaker#DeregisterDevicesRequest": { - "type": "structure", - "members": { - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet the devices belong to.
", - "smithy.api#required": {} - } - }, - "DeviceNames": { - "target": "com.amazonaws.sagemaker#DeviceNames", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique IDs of the devices.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DerivedInformation": { - "type": "structure", - "members": { - "DerivedDataInputConfig": { - "target": "com.amazonaws.sagemaker#DataInputConfig", - "traits": { - "smithy.api#documentation": "The data input configuration that SageMaker Neo automatically derived for the model.\n When SageMaker Neo derives this information, you don't need to specify the data input\n configuration when you create a compilation job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information that SageMaker Neo automatically derived about the model.
" - } - }, - "com.amazonaws.sagemaker#DescribeAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeActionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeActionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes an action.
" - } - }, - "com.amazonaws.sagemaker#DescribeActionRequest": { - "type": "structure", - "members": { - "ActionName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the action to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeActionResponse": { - "type": "structure", - "members": { - "ActionName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", - "traits": { - "smithy.api#documentation": "The name of the action.
" - } - }, - "ActionArn": { - "target": "com.amazonaws.sagemaker#ActionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ActionSource", - "traits": { - "smithy.api#documentation": "The source of the action.
" - } - }, - "ActionType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The type of the action.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ExperimentDescription", - "traits": { - "smithy.api#documentation": "The description of the action.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#ActionStatus", - "traits": { - "smithy.api#documentation": "The status of the action.
" - } - }, - "Properties": { - "target": "com.amazonaws.sagemaker#LineageEntityParameters", - "traits": { - "smithy.api#documentation": "A list of the action's properties.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the action was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the action was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "LineageGroupArn": { - "target": "com.amazonaws.sagemaker#LineageGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeAlgorithm": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeAlgorithmInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeAlgorithmOutput" - }, - "traits": { - "smithy.api#documentation": "Returns a description of the specified algorithm that is in your account.
" - } - }, - "com.amazonaws.sagemaker#DescribeAlgorithmInput": { - "type": "structure", - "members": { - "AlgorithmName": { - "target": "com.amazonaws.sagemaker#ArnOrName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the algorithm to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeAlgorithmOutput": { - "type": "structure", - "members": { - "AlgorithmName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the algorithm being described.
", - "smithy.api#required": {} - } - }, - "AlgorithmArn": { - "target": "com.amazonaws.sagemaker#AlgorithmArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the algorithm.
", - "smithy.api#required": {} - } - }, - "AlgorithmDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A brief summary about the algorithm.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp specifying when the algorithm was created.
", - "smithy.api#required": {} - } - }, - "TrainingSpecification": { - "target": "com.amazonaws.sagemaker#TrainingSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Details about training jobs run by this algorithm.
", - "smithy.api#required": {} - } - }, - "InferenceSpecification": { - "target": "com.amazonaws.sagemaker#InferenceSpecification", - "traits": { - "smithy.api#documentation": "Details about inference jobs that the algorithm runs.
" - } - }, - "ValidationSpecification": { - "target": "com.amazonaws.sagemaker#AlgorithmValidationSpecification", - "traits": { - "smithy.api#documentation": "Details about configurations for one or more training jobs that SageMaker runs to test the\n algorithm.
" - } - }, - "AlgorithmStatus": { - "target": "com.amazonaws.sagemaker#AlgorithmStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the algorithm.
", - "smithy.api#required": {} - } - }, - "AlgorithmStatusDetails": { - "target": "com.amazonaws.sagemaker#AlgorithmStatusDetails", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Details about the current status of the algorithm.
", - "smithy.api#required": {} - } - }, - "ProductId": { - "target": "com.amazonaws.sagemaker#ProductId", - "traits": { - "smithy.api#documentation": "The product identifier of the algorithm.
" - } - }, - "CertifyForMarketplace": { - "target": "com.amazonaws.sagemaker#CertifyForMarketplace", - "traits": { - "smithy.api#documentation": "Whether the algorithm is certified to be listed in Amazon Web Services\n Marketplace.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeAppRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes the app.
" - } - }, - "com.amazonaws.sagemaker#DescribeAppImageConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeAppImageConfigRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeAppImageConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes an AppImageConfig.
" - } - }, - "com.amazonaws.sagemaker#DescribeAppImageConfigRequest": { - "type": "structure", - "members": { - "AppImageConfigName": { - "target": "com.amazonaws.sagemaker#AppImageConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the AppImageConfig to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeAppImageConfigResponse": { - "type": "structure", - "members": { - "AppImageConfigArn": { - "target": "com.amazonaws.sagemaker#AppImageConfigArn", - "traits": { - "smithy.api#documentation": "The ARN of the AppImageConfig.
" - } - }, - "AppImageConfigName": { - "target": "com.amazonaws.sagemaker#AppImageConfigName", - "traits": { - "smithy.api#documentation": "The name of the AppImageConfig.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the AppImageConfig was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the AppImageConfig was last modified.
" - } - }, - "KernelGatewayImageConfig": { - "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", - "traits": { - "smithy.api#documentation": "The configuration of a KernelGateway app.
" - } - }, - "JupyterLabAppImageConfig": { - "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", - "traits": { - "smithy.api#documentation": "The configuration of the JupyterLab app.
" - } - }, - "CodeEditorAppImageConfig": { - "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", - "traits": { - "smithy.api#documentation": "The configuration of the Code Editor app.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeAppRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The domain ID.
", - "smithy.api#required": {} - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be\n set.
The name of the space.
" - } - }, - "AppType": { - "target": "com.amazonaws.sagemaker#AppType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of app.
", - "smithy.api#required": {} - } - }, - "AppName": { - "target": "com.amazonaws.sagemaker#AppName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeAppResponse": { - "type": "structure", - "members": { - "AppArn": { - "target": "com.amazonaws.sagemaker#AppArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the app.
" - } - }, - "AppType": { - "target": "com.amazonaws.sagemaker#AppType", - "traits": { - "smithy.api#documentation": "The type of app.
" - } - }, - "AppName": { - "target": "com.amazonaws.sagemaker#AppName", - "traits": { - "smithy.api#documentation": "The name of the app.
" - } - }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "The domain ID.
" - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "The user profile name.
" - } - }, - "SpaceName": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#documentation": "The name of the space. If this value is not set, then UserProfileName must be\n set.
The status.
" - } - }, - "LastHealthCheckTimestamp": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of the last health check.
" - } - }, - "LastUserActivityTimestamp": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of the last user's activity. LastUserActivityTimestamp is also\n updated when SageMaker AI performs health checks without user activity. As a result, this\n value is set to the same value as LastHealthCheckTimestamp.
The creation time of the application.
\nAfter an application has been shut down for 24 hours, SageMaker AI deletes all\n metadata for the application. To be considered an update and retain application metadata,\n applications must be restarted within 24 hours after the previous application has been shut\n down. After this time window, creation of an application is considered a new application\n rather than an update of the previous application.
\nThe failure reason.
" - } - }, - "ResourceSpec": { - "target": "com.amazonaws.sagemaker#ResourceSpec", - "traits": { - "smithy.api#documentation": "The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image\n created on the instance.
" - } - }, - "BuiltInLifecycleConfigArn": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", - "traits": { - "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeArtifact": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeArtifactRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeArtifactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes an artifact.
" - } - }, - "com.amazonaws.sagemaker#DescribeArtifactRequest": { - "type": "structure", - "members": { - "ArtifactArn": { - "target": "com.amazonaws.sagemaker#ArtifactArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeArtifactResponse": { - "type": "structure", - "members": { - "ArtifactName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", - "traits": { - "smithy.api#documentation": "The name of the artifact.
" - } - }, - "ArtifactArn": { - "target": "com.amazonaws.sagemaker#ArtifactArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ArtifactSource", - "traits": { - "smithy.api#documentation": "The source of the artifact.
" - } - }, - "ArtifactType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The type of the artifact.
" - } - }, - "Properties": { - "target": "com.amazonaws.sagemaker#LineageEntityParameters", - "traits": { - "smithy.api#documentation": "A list of the artifact's properties.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the artifact was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the artifact was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "LineageGroupArn": { - "target": "com.amazonaws.sagemaker#LineageGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeAutoMLJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeAutoMLJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeAutoMLJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about an AutoML job created by calling CreateAutoMLJob.
\nAutoML jobs created by calling CreateAutoMLJobV2 cannot be described by\n DescribeAutoMLJob.
Requests information about an AutoML job using its unique name.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeAutoMLJobResponse": { - "type": "structure", - "members": { - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the name of the AutoML job.
", - "smithy.api#required": {} - } - }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the ARN of the AutoML job.
", - "smithy.api#required": {} - } - }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the input data configuration for the AutoML job.
", - "smithy.api#required": {} - } - }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the job's output data config.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the IAM role that has read permission to the input data\n location and write permission to the output data location in Amazon S3.
", - "smithy.api#required": {} - } - }, - "AutoMLJobObjective": { - "target": "com.amazonaws.sagemaker#AutoMLJobObjective", - "traits": { - "smithy.api#documentation": "Returns the job's objective.
" - } - }, - "ProblemType": { - "target": "com.amazonaws.sagemaker#ProblemType", - "traits": { - "smithy.api#documentation": "Returns the job's problem type.
" - } - }, - "AutoMLJobConfig": { - "target": "com.amazonaws.sagemaker#AutoMLJobConfig", - "traits": { - "smithy.api#documentation": "Returns the configuration for the AutoML job.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the creation time of the AutoML job.
", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Returns the end time of the AutoML job.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the job's last modified time.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#AutoMLFailureReason", - "traits": { - "smithy.api#documentation": "Returns the failure reason for an AutoML job, when applicable.
" - } - }, - "PartialFailureReasons": { - "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", - "traits": { - "smithy.api#documentation": "Returns a list of reasons for partial failures within an AutoML job.
" - } - }, - "BestCandidate": { - "target": "com.amazonaws.sagemaker#AutoMLCandidate", - "traits": { - "smithy.api#documentation": "The best model candidate selected by SageMaker AI Autopilot using both the best\n objective metric and lowest InferenceLatency for\n an experiment.
" - } - }, - "AutoMLJobStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the status of the AutoML job.
", - "smithy.api#required": {} - } - }, - "AutoMLJobSecondaryStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the secondary status of the AutoML job.
", - "smithy.api#required": {} - } - }, - "GenerateCandidateDefinitionsOnly": { - "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", - "traits": { - "smithy.api#documentation": "Indicates whether the output for an AutoML job generates candidate definitions\n only.
" - } - }, - "AutoMLJobArtifacts": { - "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts", - "traits": { - "smithy.api#documentation": "Returns information on the job's artifacts found in\n AutoMLJobArtifacts.
Contains ProblemType, AutoMLJobObjective, and\n CompletionCriteria. If you do not provide these values, they are\n inferred.
Indicates whether the model was deployed automatically to an endpoint and the name of\n that endpoint if deployed automatically.
" - } - }, - "ModelDeployResult": { - "target": "com.amazonaws.sagemaker#ModelDeployResult", - "traits": { - "smithy.api#documentation": "Provides information about endpoint for the model deployment.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeAutoMLJobV2": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeAutoMLJobV2Request" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeAutoMLJobV2Response" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about an AutoML job created by calling CreateAutoMLJobV2\n or CreateAutoMLJob.
" - } - }, - "com.amazonaws.sagemaker#DescribeAutoMLJobV2Request": { - "type": "structure", - "members": { - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Requests information about an AutoML job V2 using its unique name.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeAutoMLJobV2Response": { - "type": "structure", - "members": { - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the name of the AutoML job V2.
", - "smithy.api#required": {} - } - }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the Amazon Resource Name (ARN) of the AutoML job V2.
", - "smithy.api#required": {} - } - }, - "AutoMLJobInputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLJobInputDataConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns an array of channel objects describing the input data and their location.
", - "smithy.api#required": {} - } - }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the job's output data config.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the IAM role that has read permission to the input data\n location and write permission to the output data location in Amazon S3.
", - "smithy.api#required": {} - } - }, - "AutoMLJobObjective": { - "target": "com.amazonaws.sagemaker#AutoMLJobObjective", - "traits": { - "smithy.api#documentation": "Returns the job's objective.
" - } - }, - "AutoMLProblemTypeConfig": { - "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfig", - "traits": { - "smithy.api#documentation": "Returns the configuration settings of the problem type set for the AutoML job V2.
" - } - }, - "AutoMLProblemTypeConfigName": { - "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfigName", - "traits": { - "smithy.api#documentation": "Returns the name of the problem type configuration set for the AutoML job V2.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the creation time of the AutoML job V2.
", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Returns the end time of the AutoML job V2.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the job's last modified time.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#AutoMLFailureReason", - "traits": { - "smithy.api#documentation": "Returns the reason for the failure of the AutoML job V2, when applicable.
" - } - }, - "PartialFailureReasons": { - "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", - "traits": { - "smithy.api#documentation": "Returns a list of reasons for partial failures within an AutoML job V2.
" - } - }, - "BestCandidate": { - "target": "com.amazonaws.sagemaker#AutoMLCandidate", - "traits": { - "smithy.api#documentation": "Information about the candidate produced by an AutoML training job V2, including its\n status, steps, and other properties.
" - } - }, - "AutoMLJobStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the status of the AutoML job V2.
", - "smithy.api#required": {} - } - }, - "AutoMLJobSecondaryStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns the secondary status of the AutoML job V2.
", - "smithy.api#required": {} - } - }, - "AutoMLJobArtifacts": { - "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts" - }, - "ResolvedAttributes": { - "target": "com.amazonaws.sagemaker#AutoMLResolvedAttributes", - "traits": { - "smithy.api#documentation": "Returns the resolved attributes used by the AutoML job V2.
" - } - }, - "ModelDeployConfig": { - "target": "com.amazonaws.sagemaker#ModelDeployConfig", - "traits": { - "smithy.api#documentation": "Indicates whether the model was deployed automatically to an endpoint and the name of\n that endpoint if deployed automatically.
" - } - }, - "ModelDeployResult": { - "target": "com.amazonaws.sagemaker#ModelDeployResult", - "traits": { - "smithy.api#documentation": "Provides information about endpoint for the model deployment.
" - } - }, - "DataSplitConfig": { - "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", - "traits": { - "smithy.api#documentation": "Returns the configuration settings of how the data are split into train and validation\n datasets.
" - } - }, - "SecurityConfig": { - "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", - "traits": { - "smithy.api#documentation": "Returns the security configuration for traffic encryption or Amazon VPC\n settings.
" - } - }, - "AutoMLComputeConfig": { - "target": "com.amazonaws.sagemaker#AutoMLComputeConfig", - "traits": { - "smithy.api#documentation": "The compute configuration used for the AutoML job V2.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeClusterRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information of a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#DescribeClusterNode": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeClusterNodeRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeClusterNodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information of a node (also called a instance\n interchangeably) of a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#DescribeClusterNodeRequest": { - "type": "structure", - "members": { - "ClusterName": { - "target": "com.amazonaws.sagemaker#ClusterNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.
", - "smithy.api#required": {} - } - }, - "NodeId": { - "target": "com.amazonaws.sagemaker#ClusterNodeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the SageMaker HyperPod cluster node.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeClusterNodeResponse": { - "type": "structure", - "members": { - "NodeDetails": { - "target": "com.amazonaws.sagemaker#ClusterNodeDetails", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The details of the SageMaker HyperPod cluster node.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeClusterRequest": { - "type": "structure", - "members": { - "ClusterName": { - "target": "com.amazonaws.sagemaker#ClusterNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeClusterResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "ClusterName": { - "target": "com.amazonaws.sagemaker#ClusterName", - "traits": { - "smithy.api#documentation": "The name of the SageMaker HyperPod cluster.
" - } - }, - "ClusterStatus": { - "target": "com.amazonaws.sagemaker#ClusterStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the SageMaker Cluster is created.
" - } - }, - "FailureMessage": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The failure message of the SageMaker HyperPod cluster.
" - } - }, - "InstanceGroups": { - "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The instance groups of the SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig" - }, - "Orchestrator": { - "target": "com.amazonaws.sagemaker#ClusterOrchestrator", - "traits": { - "smithy.api#documentation": "The type of orchestrator used for the SageMaker HyperPod cluster.
" - } - }, - "NodeRecovery": { - "target": "com.amazonaws.sagemaker#ClusterNodeRecovery", - "traits": { - "smithy.api#documentation": "The node recovery mode configured for the SageMaker HyperPod cluster.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeClusterSchedulerConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Description of the cluster policy. This policy is used for task prioritization and\n fair-share allocation. This helps prioritize critical workloads and distributes\n idle compute across entities.
" - } - }, - "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigRequest": { - "type": "structure", - "members": { - "ClusterSchedulerConfigId": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the cluster policy.
", - "smithy.api#required": {} - } - }, - "ClusterSchedulerConfigVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "Version of the cluster policy.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigResponse": { - "type": "structure", - "members": { - "ClusterSchedulerConfigArn": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the cluster policy.
", - "smithy.api#required": {} - } - }, - "ClusterSchedulerConfigId": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the cluster policy.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the cluster policy.
", - "smithy.api#required": {} - } - }, - "ClusterSchedulerConfigVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Version of the cluster policy.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the cluster policy.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "Failure reason of the cluster policy.
" - } - }, - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#documentation": "ARN of the cluster where the cluster policy is applied.
" - } - }, - "SchedulerConfig": { - "target": "com.amazonaws.sagemaker#SchedulerConfig", - "traits": { - "smithy.api#documentation": "Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "Description of the cluster policy.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Creation time of the cluster policy.
", - "smithy.api#required": {} - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Last modified time of the cluster policy.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeCodeRepository": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeCodeRepositoryInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeCodeRepositoryOutput" - }, - "traits": { - "smithy.api#documentation": "Gets details about the specified Git repository.
" - } - }, - "com.amazonaws.sagemaker#DescribeCodeRepositoryInput": { - "type": "structure", - "members": { - "CodeRepositoryName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Git repository to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeCodeRepositoryOutput": { - "type": "structure", - "members": { - "CodeRepositoryName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Git repository.
", - "smithy.api#required": {} - } - }, - "CodeRepositoryArn": { - "target": "com.amazonaws.sagemaker#CodeRepositoryArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Git repository.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the repository was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the repository was last changed.
", - "smithy.api#required": {} - } - }, - "GitConfig": { - "target": "com.amazonaws.sagemaker#GitConfig", - "traits": { - "smithy.api#documentation": "Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the\n repository.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeCompilationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeCompilationJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeCompilationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about a model compilation job.
\nTo create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation\n jobs, use ListCompilationJobs.
" - } - }, - "com.amazonaws.sagemaker#DescribeCompilationJobRequest": { - "type": "structure", - "members": { - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model compilation job that you want information about.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeCompilationJobResponse": { - "type": "structure", - "members": { - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model compilation job.
", - "smithy.api#required": {} - } - }, - "CompilationJobArn": { - "target": "com.amazonaws.sagemaker#CompilationJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model compilation job.
", - "smithy.api#required": {} - } - }, - "CompilationJobStatus": { - "target": "com.amazonaws.sagemaker#CompilationJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the model compilation job.
", - "smithy.api#required": {} - } - }, - "CompilationStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the model compilation job started the CompilationJob\n instances.
You are billed for the time between this timestamp and the timestamp in the\n CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later\n than this time. That's because it takes time to download the compilation job, which\n depends on the size of the compilation job container.
The time when the model compilation job on a compilation job instance ended. For a\n successful or stopped job, this is when the job's model artifacts have finished\n uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed.
" - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model compilation job can run. When the job reaches\n the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training\n costs.
", - "smithy.api#required": {} - } - }, - "InferenceImage": { - "target": "com.amazonaws.sagemaker#InferenceImage", - "traits": { - "smithy.api#documentation": "The inference image to use when compiling a model. Specify an image only if the target\n device is a cloud instance.
" - } - }, - "ModelPackageVersionArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the versioned model package that was \n provided to SageMaker Neo when you initiated a compilation job.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time that the model compilation job was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time that the status\n of\n the model compilation job was last modified.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If a model compilation job failed, the reason it failed.
", - "smithy.api#required": {} - } - }, - "ModelArtifacts": { - "target": "com.amazonaws.sagemaker#ModelArtifacts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the location in Amazon S3 that has been configured for storing the model\n artifacts used in the compilation job.
", - "smithy.api#required": {} - } - }, - "ModelDigests": { - "target": "com.amazonaws.sagemaker#ModelDigests", - "traits": { - "smithy.api#documentation": "Provides a BLAKE2 hash value that identifies the compiled model artifacts in\n Amazon S3.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model\n compilation job.
", - "smithy.api#required": {} - } - }, - "InputConfig": { - "target": "com.amazonaws.sagemaker#InputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the location in Amazon S3 of the input model artifacts, the name and\n shape of the expected data inputs, and the framework in which the model was\n trained.
", - "smithy.api#required": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#OutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the output location for the compiled model and the target device\n that the model runs on.
", - "smithy.api#required": {} - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#NeoVpcConfig", - "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your compilation job\n to connect to. Control access to your models by configuring the VPC. For more\n information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
" - } - }, - "DerivedInformation": { - "target": "com.amazonaws.sagemaker#DerivedInformation", - "traits": { - "smithy.api#documentation": "Information that SageMaker Neo automatically derived about the model.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeComputeQuota": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeComputeQuotaRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeComputeQuotaResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Description of the compute allocation definition.
" - } - }, - "com.amazonaws.sagemaker#DescribeComputeQuotaRequest": { - "type": "structure", - "members": { - "ComputeQuotaId": { - "target": "com.amazonaws.sagemaker#ComputeQuotaId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "ComputeQuotaVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "Version of the compute allocation definition.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeComputeQuotaResponse": { - "type": "structure", - "members": { - "ComputeQuotaArn": { - "target": "com.amazonaws.sagemaker#ComputeQuotaArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "ComputeQuotaId": { - "target": "com.amazonaws.sagemaker#ComputeQuotaId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "Description of the compute allocation definition.
" - } - }, - "ComputeQuotaVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Version of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "Failure reason of the compute allocation definition.
" - } - }, - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#documentation": "ARN of the cluster.
" - } - }, - "ComputeQuotaConfig": { - "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", - "traits": { - "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" - } - }, - "ComputeQuotaTarget": { - "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The target entity to allocate compute resources to.
", - "smithy.api#required": {} - } - }, - "ActivationState": { - "target": "com.amazonaws.sagemaker#ActivationState", - "traits": { - "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Creation time of the compute allocation configuration.
", - "smithy.api#required": {} - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Last modified time of the compute allocation configuration.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeContext": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeContextRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeContextResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes a context.
" - } - }, - "com.amazonaws.sagemaker#DescribeContextRequest": { - "type": "structure", - "members": { - "ContextName": { - "target": "com.amazonaws.sagemaker#ContextNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the context to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeContextResponse": { - "type": "structure", - "members": { - "ContextName": { - "target": "com.amazonaws.sagemaker#ContextName", - "traits": { - "smithy.api#documentation": "The name of the context.
" - } - }, - "ContextArn": { - "target": "com.amazonaws.sagemaker#ContextArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ContextSource", - "traits": { - "smithy.api#documentation": "The source of the context.
" - } - }, - "ContextType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The type of the context.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ExperimentDescription", - "traits": { - "smithy.api#documentation": "The description of the context.
" - } - }, - "Properties": { - "target": "com.amazonaws.sagemaker#LineageEntityParameters", - "traits": { - "smithy.api#documentation": "A list of the context's properties.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the context was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the context was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LineageGroupArn": { - "target": "com.amazonaws.sagemaker#LineageGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeDataQualityJobDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Gets the details of a data quality monitoring job definition.
" - } - }, - "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the data quality monitoring job definition to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionResponse": { - "type": "structure", - "members": { - "JobDefinitionArn": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data quality monitoring job definition.
", - "smithy.api#required": {} - } - }, - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the data quality monitoring job definition.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time that the data quality monitoring job definition was created.
", - "smithy.api#required": {} - } - }, - "DataQualityBaselineConfig": { - "target": "com.amazonaws.sagemaker#DataQualityBaselineConfig", - "traits": { - "smithy.api#documentation": "The constraints and baselines for the data quality monitoring job definition.
" - } - }, - "DataQualityAppSpecification": { - "target": "com.amazonaws.sagemaker#DataQualityAppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the container that runs the data quality monitoring job.
", - "smithy.api#required": {} - } - }, - "DataQualityJobInput": { - "target": "com.amazonaws.sagemaker#DataQualityJobInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The list of inputs for the data quality monitoring job. Currently endpoints are\n supported.
", - "smithy.api#required": {} - } - }, - "DataQualityJobOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "JobResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", - "traits": { - "smithy.api#documentation": "The networking configuration for the data quality monitoring job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeDevice": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeDeviceRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeDeviceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes the device.
" - } - }, - "com.amazonaws.sagemaker#DescribeDeviceFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeDeviceFleetRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeDeviceFleetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "A description of the fleet the device belongs to.
" - } - }, - "com.amazonaws.sagemaker#DescribeDeviceFleetRequest": { - "type": "structure", - "members": { - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeDeviceFleetResponse": { - "type": "structure", - "members": { - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "DeviceFleetArn": { - "target": "com.amazonaws.sagemaker#DeviceFleetArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The The Amazon Resource Name (ARN) of the fleet.
", - "smithy.api#required": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#EdgeOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The output configuration for storing sampled data.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#DeviceFleetDescription", - "traits": { - "smithy.api#documentation": "A description of the fleet.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Timestamp of when the device fleet was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Timestamp of when the device fleet was last updated.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
" - } - }, - "IotRoleAlias": { - "target": "com.amazonaws.sagemaker#IotRoleAlias", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeDeviceRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "Next token of device description.
" - } - }, - "DeviceName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique ID of the device.
", - "smithy.api#required": {} - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet the devices belong to.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeDeviceResponse": { - "type": "structure", - "members": { - "DeviceArn": { - "target": "com.amazonaws.sagemaker#DeviceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the device.
" - } - }, - "DeviceName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique identifier of the device.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#DeviceDescription", - "traits": { - "smithy.api#documentation": "A description of the device.
" - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet the device belongs to.
", - "smithy.api#required": {} - } - }, - "IotThingName": { - "target": "com.amazonaws.sagemaker#ThingName", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.
" - } - }, - "RegistrationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The timestamp of the last registration or de-reregistration.
", - "smithy.api#required": {} - } - }, - "LatestHeartbeat": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The last heartbeat received from the device.
" - } - }, - "Models": { - "target": "com.amazonaws.sagemaker#EdgeModels", - "traits": { - "smithy.api#documentation": "Models on the device.
" - } - }, - "MaxModels": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of models.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" - } - }, - "AgentVersion": { - "target": "com.amazonaws.sagemaker#EdgeVersion", - "traits": { - "smithy.api#documentation": "Edge Manager agent version.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeDomainRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeDomainResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "The description of the domain.
" - } - }, - "com.amazonaws.sagemaker#DescribeDomainRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The domain ID.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeDomainResponse": { - "type": "structure", - "members": { - "DomainArn": { - "target": "com.amazonaws.sagemaker#DomainArn", - "traits": { - "smithy.api#documentation": "The domain's Amazon Resource Name (ARN).
" - } - }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "The domain ID.
" - } - }, - "DomainName": { - "target": "com.amazonaws.sagemaker#DomainName", - "traits": { - "smithy.api#documentation": "The domain name.
" - } - }, - "HomeEfsFileSystemId": { - "target": "com.amazonaws.sagemaker#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the Amazon Elastic File System managed by this Domain.
" - } - }, - "SingleSignOnManagedApplicationInstanceId": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The IAM Identity Center managed application instance ID.
" - } - }, - "SingleSignOnApplicationArn": { - "target": "com.amazonaws.sagemaker#SingleSignOnApplicationArn", - "traits": { - "smithy.api#documentation": "The ARN of the application managed by SageMaker AI in IAM Identity Center. This value\n is only returned for domains created after October 1, 2023.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#DomainStatus", - "traits": { - "smithy.api#documentation": "The status.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "The creation time.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "The last modified time.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The failure reason.
" - } - }, - "SecurityGroupIdForDomainBoundary": { - "target": "com.amazonaws.sagemaker#SecurityGroupId", - "traits": { - "smithy.api#documentation": "The ID of the security group that authorizes traffic between the\n RSessionGateway apps and the RStudioServerPro app.
The domain's authentication mode.
" - } - }, - "DefaultUserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", - "traits": { - "smithy.api#documentation": "Settings which are applied to UserProfiles in this domain if settings are not explicitly\n specified in a given UserProfile.
" - } - }, - "DomainSettings": { - "target": "com.amazonaws.sagemaker#DomainSettings", - "traits": { - "smithy.api#documentation": "A collection of Domain settings.
Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Use KmsKeyId.
The VPC subnets that the domain uses for communication.
" - } - }, - "Url": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The domain's URL.
" - } - }, - "VpcId": { - "target": "com.amazonaws.sagemaker#VpcId", - "traits": { - "smithy.api#documentation": "The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to\n the domain.
" - } - }, - "AppSecurityGroupManagement": { - "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", - "traits": { - "smithy.api#documentation": "The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided.
Indicates whether custom tag propagation is supported for the domain.
" - } - }, - "DefaultSpaceSettings": { - "target": "com.amazonaws.sagemaker#DefaultSpaceSettings", - "traits": { - "smithy.api#documentation": "The default settings for shared spaces that users create in the domain.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlan": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes an edge deployment plan with deployment status per stage.
" - } - }, - "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanRequest": { - "type": "structure", - "members": { - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the deployment plan to describe.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the edge deployment plan has enough stages to require tokening, then this is the\n response from the last list of stages returned.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#DeploymentStageMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to select (50 by default).
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanResponse": { - "type": "structure", - "members": { - "EdgeDeploymentPlanArn": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of edge deployment plan.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "ModelConfigs": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentModelConfigs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List of models associated with the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The device fleet used for this edge deployment plan.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentSuccess": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The number of edge devices with the successful deployment.
" - } - }, - "EdgeDeploymentPending": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The number of edge devices yet to pick up deployment, or in progress.
" - } - }, - "EdgeDeploymentFailed": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The number of edge devices that failed the deployment.
" - } - }, - "Stages": { - "target": "com.amazonaws.sagemaker#DeploymentStageStatusSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List of stages in the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "Token to use when calling the next set of stages in the edge deployment plan.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the edge deployment plan was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the edge deployment plan was last updated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeEdgePackagingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeEdgePackagingJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeEdgePackagingJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "A description of edge packaging jobs.
" - } - }, - "com.amazonaws.sagemaker#DescribeEdgePackagingJobRequest": { - "type": "structure", - "members": { - "EdgePackagingJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge packaging job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeEdgePackagingJobResponse": { - "type": "structure", - "members": { - "EdgePackagingJobArn": { - "target": "com.amazonaws.sagemaker#EdgePackagingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the edge packaging job.
", - "smithy.api#required": {} - } - }, - "EdgePackagingJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge packaging job.
", - "smithy.api#required": {} - } - }, - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.
" - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the model.
" - } - }, - "ModelVersion": { - "target": "com.amazonaws.sagemaker#EdgeVersion", - "traits": { - "smithy.api#documentation": "The version of the model.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
" - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#EdgeOutputConfig", - "traits": { - "smithy.api#documentation": "The output configuration for the edge packaging job.
" - } - }, - "ResourceKey": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.
" - } - }, - "EdgePackagingJobStatus": { - "target": "com.amazonaws.sagemaker#EdgePackagingJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the packaging job.
", - "smithy.api#required": {} - } - }, - "EdgePackagingJobStatusMessage": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "Returns a message describing the job status and error messages.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the packaging job was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the job was last updated.
" - } - }, - "ModelArtifact": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The Amazon Simple Storage (S3) URI where model artifacts ares stored.
" - } - }, - "ModelSignature": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The signature document of files in the model artifact.
" - } - }, - "PresetDeploymentOutput": { - "target": "com.amazonaws.sagemaker#EdgePresetDeploymentOutput", - "traits": { - "smithy.api#documentation": "The output of a SageMaker Edge Manager deployable resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeEndpointInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeEndpointOutput" - }, - "traits": { - "smithy.api#documentation": "Returns the description of an endpoint.
", - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "EndpointDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "errorType": "ValidationException" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "EndpointStatus", - "expected": "Failed", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 30 - }, - "EndpointInService": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "EndpointStatus", - "expected": "InService", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "EndpointStatus", - "expected": "Failed", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "ValidationException" - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.sagemaker#DescribeEndpointConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeEndpointConfigInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeEndpointConfigOutput" - }, - "traits": { - "smithy.api#documentation": "Returns the description of an endpoint configuration created using the\n CreateEndpointConfig API.
The name of the endpoint configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeEndpointConfigOutput": { - "type": "structure", - "members": { - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the SageMaker endpoint configuration.
", - "smithy.api#required": {} - } - }, - "EndpointConfigArn": { - "target": "com.amazonaws.sagemaker#EndpointConfigArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint configuration.
", - "smithy.api#required": {} - } - }, - "ProductionVariants": { - "target": "com.amazonaws.sagemaker#ProductionVariantList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of ProductionVariant objects, one for each model that you\n want to host at this endpoint.
Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML\n storage volume attached to the instance.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the endpoint configuration was created.
", - "smithy.api#required": {} - } - }, - "AsyncInferenceConfig": { - "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", - "traits": { - "smithy.api#documentation": "Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.
The configuration parameters for an explainer.
" - } - }, - "ShadowProductionVariants": { - "target": "com.amazonaws.sagemaker#ProductionVariantList", - "traits": { - "smithy.api#documentation": "An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants.
The Amazon Resource Name (ARN) of the IAM role that you assigned to the\n endpoint configuration.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig" - }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether all model containers deployed to the endpoint are isolated. If they\n are, no inbound or outbound network calls can be made to or from the model\n containers.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeEndpointInput": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeEndpointOutput": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the endpoint.
", - "smithy.api#required": {} - } - }, - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", - "smithy.api#required": {} - } - }, - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", - "traits": { - "smithy.api#documentation": "The name of the endpoint configuration associated with this endpoint.
" - } - }, - "ProductionVariants": { - "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", - "traits": { - "smithy.api#documentation": "An array of ProductionVariantSummary objects, one for each model hosted behind this\n endpoint.
" - } - }, - "DataCaptureConfig": { - "target": "com.amazonaws.sagemaker#DataCaptureConfigSummary" - }, - "EndpointStatus": { - "target": "com.amazonaws.sagemaker#EndpointStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
\n UpdateRollbackFailed: Both the rolling deployment and\n auto-rollback failed. Your endpoint is in service with a mix of the old and new\n endpoint configurations. For information about how to remedy this issue and\n restore the endpoint's status to InService, see Rolling\n Deployments.
If the status of the endpoint is Failed, the reason why it failed.\n
A timestamp that shows when the endpoint was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the endpoint was last modified.
", - "smithy.api#required": {} - } - }, - "LastDeploymentConfig": { - "target": "com.amazonaws.sagemaker#DeploymentConfig", - "traits": { - "smithy.api#documentation": "The most recent deployment configuration for the endpoint.
" - } - }, - "AsyncInferenceConfig": { - "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", - "traits": { - "smithy.api#documentation": "Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.
Returns the summary of an in-progress deployment. This field is only returned when the\n endpoint is creating or updating with a new endpoint configuration.
" - } - }, - "ExplainerConfig": { - "target": "com.amazonaws.sagemaker#ExplainerConfig", - "traits": { - "smithy.api#documentation": "The configuration parameters for an explainer.
" - } - }, - "ShadowProductionVariants": { - "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", - "traits": { - "smithy.api#documentation": "An array of ProductionVariantSummary objects, one for each model that you want to host\n at this endpoint in shadow mode with production traffic replicated from the model\n specified on ProductionVariants.
Provides a list of an experiment's properties.
" - } - }, - "com.amazonaws.sagemaker#DescribeExperimentRequest": { - "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the experiment to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeExperimentResponse": { - "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment.
" - } - }, - "ExperimentArn": { - "target": "com.amazonaws.sagemaker#ExperimentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.
The Amazon Resource Name (ARN) of the source and, optionally, the type.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ExperimentDescription", - "traits": { - "smithy.api#documentation": "The description of the experiment.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the experiment was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who created the experiment.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the experiment was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who last modified the experiment.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeFeatureGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeFeatureGroupRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeFeatureGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Use this operation to describe a FeatureGroup. The response includes\n information on the creation time, FeatureGroup name, the unique identifier for\n each FeatureGroup, and more.
The name or Amazon Resource Name (ARN) of the FeatureGroup you want\n described.
A token to resume pagination of the list of Features\n (FeatureDefinitions). 2,500 Features are returned by\n default.
The Amazon Resource Name (ARN) of the FeatureGroup.
he name of the FeatureGroup.
The name of the Feature used for RecordIdentifier, whose value\n uniquely identifies a record stored in the feature store.
The name of the feature that stores the EventTime of a Record in a\n FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds\n to the creation or update of a Record in a FeatureGroup. All\n Records in the FeatureGroup have a corresponding\n EventTime.
A list of the Features in the FeatureGroup. Each feature is\n defined by a FeatureName and FeatureType.
A timestamp indicating when SageMaker created the FeatureGroup.
A timestamp indicating when the feature group was last updated.
" - } - }, - "OnlineStoreConfig": { - "target": "com.amazonaws.sagemaker#OnlineStoreConfig", - "traits": { - "smithy.api#documentation": "The configuration for the OnlineStore.
The configuration of the offline store. It includes the following configurations:
\nAmazon S3 location of the offline store.
\nConfiguration of the Glue data catalog.
\nTable format of the offline store.
\nOption to disable the automatic creation of a Glue table for the offline\n store.
\nEncryption configuration.
\nThe Amazon Resource Name (ARN) of the IAM execution role used to persist data into the\n OfflineStore if an OfflineStoreConfig is provided.
" - } - }, - "FeatureGroupStatus": { - "target": "com.amazonaws.sagemaker#FeatureGroupStatus", - "traits": { - "smithy.api#documentation": "The status of the feature group.
" - } - }, - "OfflineStoreStatus": { - "target": "com.amazonaws.sagemaker#OfflineStoreStatus", - "traits": { - "smithy.api#documentation": "The status of the OfflineStore. Notifies you if replicating data into the\n OfflineStore has failed. Returns either: Active or\n Blocked\n
A value indicating whether the update made to the feature group was successful.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The reason that the FeatureGroup failed to be replicated in the\n OfflineStore. This is failure can occur because:
The FeatureGroup could not be created in the\n OfflineStore.
The FeatureGroup could not be deleted from the\n OfflineStore.
A free form description of the feature group.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A token to resume pagination of the list of Features\n (FeatureDefinitions).
The size of the OnlineStore in bytes.
Shows the metadata for a feature within a feature group.
" - } - }, - "com.amazonaws.sagemaker#DescribeFeatureMetadataRequest": { - "type": "structure", - "members": { - "FeatureGroupName": { - "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the feature group containing the\n feature.
", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.sagemaker#FeatureName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the feature.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeFeatureMetadataResponse": { - "type": "structure", - "members": { - "FeatureGroupArn": { - "target": "com.amazonaws.sagemaker#FeatureGroupArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the feature group that contains the feature.
", - "smithy.api#required": {} - } - }, - "FeatureGroupName": { - "target": "com.amazonaws.sagemaker#FeatureGroupName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the feature group that you've specified.
", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.sagemaker#FeatureName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the feature that you've specified.
", - "smithy.api#required": {} - } - }, - "FeatureType": { - "target": "com.amazonaws.sagemaker#FeatureType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The data type of the feature.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp indicating when the feature was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp indicating when the metadata for the feature group was modified. For\n example, if you add a parameter describing the feature, the timestamp changes to reflect\n the last time you
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#FeatureDescription", - "traits": { - "smithy.api#documentation": "The description you added to describe the feature.
" - } - }, - "Parameters": { - "target": "com.amazonaws.sagemaker#FeatureParameters", - "traits": { - "smithy.api#documentation": "The key-value pairs that you added to describe the feature.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeFlowDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeFlowDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeFlowDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about the specified flow definition.
" - } - }, - "com.amazonaws.sagemaker#DescribeFlowDefinitionRequest": { - "type": "structure", - "members": { - "FlowDefinitionName": { - "target": "com.amazonaws.sagemaker#FlowDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the flow definition.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeFlowDefinitionResponse": { - "type": "structure", - "members": { - "FlowDefinitionArn": { - "target": "com.amazonaws.sagemaker#FlowDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow defintion.
", - "smithy.api#required": {} - } - }, - "FlowDefinitionName": { - "target": "com.amazonaws.sagemaker#FlowDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow definition.
", - "smithy.api#required": {} - } - }, - "FlowDefinitionStatus": { - "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the flow definition. Valid values are listed below.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The timestamp when the flow definition was created.
", - "smithy.api#required": {} - } - }, - "HumanLoopRequestSource": { - "target": "com.amazonaws.sagemaker#HumanLoopRequestSource", - "traits": { - "smithy.api#documentation": "Container for configuring the source of human task requests. Used to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.
" - } - }, - "HumanLoopActivationConfig": { - "target": "com.amazonaws.sagemaker#HumanLoopActivationConfig", - "traits": { - "smithy.api#documentation": "An object containing information about what triggers a human review workflow.
" - } - }, - "HumanLoopConfig": { - "target": "com.amazonaws.sagemaker#HumanLoopConfig", - "traits": { - "smithy.api#documentation": "An object containing information about who works on the task, the workforce task price, and other task details.
" - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An object containing information about the output file.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The reason your flow definition failed.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeHub": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeHubRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeHubResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes a hub.
" - } - }, - "com.amazonaws.sagemaker#DescribeHubContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeHubContentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeHubContentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describe the content of a hub.
" - } - }, - "com.amazonaws.sagemaker#DescribeHubContentRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub that contains the content to describe.
", - "smithy.api#required": {} - } - }, - "HubContentType": { - "target": "com.amazonaws.sagemaker#HubContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of content in the hub.
", - "smithy.api#required": {} - } - }, - "HubContentName": { - "target": "com.amazonaws.sagemaker#HubContentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the content to describe.
", - "smithy.api#required": {} - } - }, - "HubContentVersion": { - "target": "com.amazonaws.sagemaker#HubContentVersion", - "traits": { - "smithy.api#documentation": "The version of the content to describe.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeHubContentResponse": { - "type": "structure", - "members": { - "HubContentName": { - "target": "com.amazonaws.sagemaker#HubContentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub content.
", - "smithy.api#required": {} - } - }, - "HubContentArn": { - "target": "com.amazonaws.sagemaker#HubContentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub content.
", - "smithy.api#required": {} - } - }, - "HubContentVersion": { - "target": "com.amazonaws.sagemaker#HubContentVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the hub content.
", - "smithy.api#required": {} - } - }, - "HubContentType": { - "target": "com.amazonaws.sagemaker#HubContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of hub content.
", - "smithy.api#required": {} - } - }, - "DocumentSchemaVersion": { - "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The document schema version for the hub content.
", - "smithy.api#required": {} - } - }, - "HubName": { - "target": "com.amazonaws.sagemaker#HubName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub that contains the content.
", - "smithy.api#required": {} - } - }, - "HubArn": { - "target": "com.amazonaws.sagemaker#HubArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub that contains the content.
", - "smithy.api#required": {} - } - }, - "HubContentDisplayName": { - "target": "com.amazonaws.sagemaker#HubContentDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the hub content.
" - } - }, - "HubContentDescription": { - "target": "com.amazonaws.sagemaker#HubContentDescription", - "traits": { - "smithy.api#documentation": "A description of the hub content.
" - } - }, - "HubContentMarkdown": { - "target": "com.amazonaws.sagemaker#HubContentMarkdown", - "traits": { - "smithy.api#documentation": "A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
" - } - }, - "HubContentDocument": { - "target": "com.amazonaws.sagemaker#HubContentDocument", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
", - "smithy.api#required": {} - } - }, - "SageMakerPublicHubContentArn": { - "target": "com.amazonaws.sagemaker#SageMakerPublicHubContentArn", - "traits": { - "smithy.api#documentation": "The ARN of the public hub content.
" - } - }, - "ReferenceMinVersion": { - "target": "com.amazonaws.sagemaker#ReferenceMinVersion", - "traits": { - "smithy.api#documentation": "The minimum version of the hub content.
" - } - }, - "SupportStatus": { - "target": "com.amazonaws.sagemaker#HubContentSupportStatus", - "traits": { - "smithy.api#documentation": "The support status of the hub content.
" - } - }, - "HubContentSearchKeywords": { - "target": "com.amazonaws.sagemaker#HubContentSearchKeywordList", - "traits": { - "smithy.api#documentation": "The searchable keywords for the hub content.
" - } - }, - "HubContentDependencies": { - "target": "com.amazonaws.sagemaker#HubContentDependencyList", - "traits": { - "smithy.api#documentation": "The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
" - } - }, - "HubContentStatus": { - "target": "com.amazonaws.sagemaker#HubContentStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the hub content.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The failure reason if importing hub content failed.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that hub content was created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeHubRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeHubResponse": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub.
", - "smithy.api#required": {} - } - }, - "HubArn": { - "target": "com.amazonaws.sagemaker#HubArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub.
", - "smithy.api#required": {} - } - }, - "HubDisplayName": { - "target": "com.amazonaws.sagemaker#HubDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the hub.
" - } - }, - "HubDescription": { - "target": "com.amazonaws.sagemaker#HubDescription", - "traits": { - "smithy.api#documentation": "A description of the hub.
" - } - }, - "HubSearchKeywords": { - "target": "com.amazonaws.sagemaker#HubSearchKeywordList", - "traits": { - "smithy.api#documentation": "The searchable keywords for the hub.
" - } - }, - "S3StorageConfig": { - "target": "com.amazonaws.sagemaker#HubS3StorageConfig", - "traits": { - "smithy.api#documentation": "The Amazon S3 storage configuration for the hub.
" - } - }, - "HubStatus": { - "target": "com.amazonaws.sagemaker#HubStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the hub.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The failure reason if importing hub content failed.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the hub was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the hub was last modified.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeHumanTaskUi": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeHumanTaskUiRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeHumanTaskUiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about the requested human task user interface (worker task template).
" - } - }, - "com.amazonaws.sagemaker#DescribeHumanTaskUiRequest": { - "type": "structure", - "members": { - "HumanTaskUiName": { - "target": "com.amazonaws.sagemaker#HumanTaskUiName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the human task user interface \n (worker task template) you want information about.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeHumanTaskUiResponse": { - "type": "structure", - "members": { - "HumanTaskUiArn": { - "target": "com.amazonaws.sagemaker#HumanTaskUiArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human task user interface (worker task template).
", - "smithy.api#required": {} - } - }, - "HumanTaskUiName": { - "target": "com.amazonaws.sagemaker#HumanTaskUiName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the human task user interface (worker task template).
", - "smithy.api#required": {} - } - }, - "HumanTaskUiStatus": { - "target": "com.amazonaws.sagemaker#HumanTaskUiStatus", - "traits": { - "smithy.api#documentation": "The status of the human task user interface (worker task template). Valid values are listed below.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The timestamp when the human task user interface was created.
", - "smithy.api#required": {} - } - }, - "UiTemplate": { - "target": "com.amazonaws.sagemaker#UiTemplateInfo", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeHyperParameterTuningJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns a description of a hyperparameter tuning job, depending on the fields\n selected. These fields can include the name, Amazon Resource Name (ARN), job status of\n your tuning job and more.
" - } - }, - "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobRequest": { - "type": "structure", - "members": { - "HyperParameterTuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the tuning job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobResponse": { - "type": "structure", - "members": { - "HyperParameterTuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hyperparameter tuning job.
", - "smithy.api#required": {} - } - }, - "HyperParameterTuningJobArn": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tuning job.
", - "smithy.api#required": {} - } - }, - "HyperParameterTuningJobConfig": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The HyperParameterTuningJobConfig object that specifies the configuration of\n the tuning job.
", - "smithy.api#required": {} - } - }, - "TrainingJobDefinition": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", - "traits": { - "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that specifies the definition of\n the training jobs that this tuning job launches.
" - } - }, - "TrainingJobDefinitions": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", - "traits": { - "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.
" - } - }, - "HyperParameterTuningJobStatus": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the tuning job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the tuning job started.
", - "smithy.api#required": {} - } - }, - "HyperParameterTuningEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the tuning job ended.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the status of the tuning job was modified.
" - } - }, - "TrainingJobStatusCounters": { - "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the number of training\n jobs, categorized by status, that this tuning job launched.
", - "smithy.api#required": {} - } - }, - "ObjectiveStatusCounters": { - "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the number of training jobs,\n categorized by the status of their final objective metric, that this tuning job\n launched.
", - "smithy.api#required": {} - } - }, - "BestTrainingJob": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", - "traits": { - "smithy.api#documentation": "A TrainingJobSummary object that describes the training job that completed\n with the best current HyperParameterTuningJobObjective.
" - } - }, - "OverallBestTrainingJob": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", - "traits": { - "smithy.api#documentation": "If the hyperparameter tuning job is an warm start tuning job with a\n WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the\n TrainingJobSummary for the training job with the best objective metric\n value of all training jobs launched by this tuning job and all parent jobs specified for\n the warm start tuning job.
The configuration for starting the hyperparameter parameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.
" - } - }, - "Autotune": { - "target": "com.amazonaws.sagemaker#Autotune", - "traits": { - "smithy.api#documentation": "A flag to indicate if autotune is enabled for the hyperparameter tuning job.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the tuning job failed, the reason it failed.
" - } - }, - "TuningJobCompletionDetails": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails", - "traits": { - "smithy.api#documentation": "Tuning job completion information returned as the response from a hyperparameter\n tuning job. This information tells if your tuning job has or has not converged. It also\n includes the number of training jobs that have not improved model performance as\n evaluated against the objective function.
" - } - }, - "ConsumedResources": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConsumedResources" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeImageRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeImageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes a SageMaker AI image.
", - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "ImageCreated": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ImageStatus", - "expected": "CREATED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ImageStatus", - "expected": "CREATE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "ValidationException" - } - } - ], - "minDelay": 60 - }, - "ImageDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundException" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ImageStatus", - "expected": "DELETE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "ValidationException" - } - } - ], - "minDelay": 60 - }, - "ImageUpdated": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ImageStatus", - "expected": "CREATED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ImageStatus", - "expected": "UPDATE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "ValidationException" - } - } - ], - "minDelay": 60 - } - } - } - }, - "com.amazonaws.sagemaker#DescribeImageRequest": { - "type": "structure", - "members": { - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeImageResponse": { - "type": "structure", - "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the image was created.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ImageDescription", - "traits": { - "smithy.api#documentation": "The description of the image.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ImageDisplayName", - "traits": { - "smithy.api#documentation": "The name of the image as displayed.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "When a create, update, or delete operation fails, the reason for the failure.
" - } - }, - "ImageArn": { - "target": "com.amazonaws.sagemaker#ImageArn", - "traits": { - "smithy.api#documentation": "The ARN of the image.
" - } - }, - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#documentation": "The name of the image.
" - } - }, - "ImageStatus": { - "target": "com.amazonaws.sagemaker#ImageStatus", - "traits": { - "smithy.api#documentation": "The status of the image.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the image was last modified.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The ARN of the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeImageVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeImageVersionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeImageVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes a version of a SageMaker AI image.
", - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "ImageVersionCreated": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ImageVersionStatus", - "expected": "CREATED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ImageVersionStatus", - "expected": "CREATE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "ValidationException" - } - } - ], - "minDelay": 60 - }, - "ImageVersionDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundException" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ImageVersionStatus", - "expected": "DELETE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "ValidationException" - } - } - ], - "minDelay": 60 - } - } - } - }, - "com.amazonaws.sagemaker#DescribeImageVersionRequest": { - "type": "structure", - "members": { - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image.
", - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.sagemaker#ImageVersionNumber", - "traits": { - "smithy.api#documentation": "The version of the image. If not specified, the latest version is described.
" - } - }, - "Alias": { - "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", - "traits": { - "smithy.api#documentation": "The alias of the image version.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeImageVersionResponse": { - "type": "structure", - "members": { - "BaseImage": { - "target": "com.amazonaws.sagemaker#ImageBaseImage", - "traits": { - "smithy.api#documentation": "The registry path of the container image on which this image version is based.
" - } - }, - "ContainerImage": { - "target": "com.amazonaws.sagemaker#ImageContainerImage", - "traits": { - "smithy.api#documentation": "The registry path of the container image that contains this image version.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the version was created.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "When a create or delete operation fails, the reason for the failure.
" - } - }, - "ImageArn": { - "target": "com.amazonaws.sagemaker#ImageArn", - "traits": { - "smithy.api#documentation": "The ARN of the image the version is based on.
" - } - }, - "ImageVersionArn": { - "target": "com.amazonaws.sagemaker#ImageVersionArn", - "traits": { - "smithy.api#documentation": "The ARN of the version.
" - } - }, - "ImageVersionStatus": { - "target": "com.amazonaws.sagemaker#ImageVersionStatus", - "traits": { - "smithy.api#documentation": "The status of the version.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the version was last modified.
" - } - }, - "Version": { - "target": "com.amazonaws.sagemaker#ImageVersionNumber", - "traits": { - "smithy.api#documentation": "The version number.
" - } - }, - "VendorGuidance": { - "target": "com.amazonaws.sagemaker#VendorGuidance", - "traits": { - "smithy.api#documentation": "The stability of the image version specified by the maintainer.
\n\n NOT_PROVIDED: The maintainers did not provide a status for image version stability.
\n STABLE: The image version is stable.
\n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
\n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
\n\n TRAINING: The image version is compatible with SageMaker AI training jobs.
\n INFERENCE: The image version is compatible with SageMaker AI inference jobs.
\n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
The machine learning framework vended in the image version.
" - } - }, - "ProgrammingLang": { - "target": "com.amazonaws.sagemaker#ProgrammingLang", - "traits": { - "smithy.api#documentation": "The supported programming language and its version.
" - } - }, - "Processor": { - "target": "com.amazonaws.sagemaker#Processor", - "traits": { - "smithy.api#documentation": "Indicates CPU or GPU compatibility.
\n\n CPU: The image version is compatible with CPU.
\n GPU: The image version is compatible with GPU.
Indicates Horovod compatibility.
" - } - }, - "ReleaseNotes": { - "target": "com.amazonaws.sagemaker#ReleaseNotes", - "traits": { - "smithy.api#documentation": "The maintainer description of the image version.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeInferenceComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeInferenceComponentInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeInferenceComponentOutput" - }, - "traits": { - "smithy.api#documentation": "Returns information about an inference component.
" - } - }, - "com.amazonaws.sagemaker#DescribeInferenceComponentInput": { - "type": "structure", - "members": { - "InferenceComponentName": { - "target": "com.amazonaws.sagemaker#InferenceComponentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference component.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeInferenceComponentOutput": { - "type": "structure", - "members": { - "InferenceComponentName": { - "target": "com.amazonaws.sagemaker#InferenceComponentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference component.
", - "smithy.api#required": {} - } - }, - "InferenceComponentArn": { - "target": "com.amazonaws.sagemaker#InferenceComponentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", - "smithy.api#required": {} - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint that hosts the inference component.
", - "smithy.api#required": {} - } - }, - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
", - "smithy.api#required": {} - } - }, - "VariantName": { - "target": "com.amazonaws.sagemaker#VariantName", - "traits": { - "smithy.api#documentation": "The name of the production variant that hosts the inference component.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the inference component status is Failed, the reason for the\n failure.
Details about the resources that are deployed with this inference component.
" - } - }, - "RuntimeConfig": { - "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary", - "traits": { - "smithy.api#documentation": "Details about the runtime settings for the model that is deployed with the inference\n component.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when the inference component was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when the inference component was last updated.
", - "smithy.api#required": {} - } - }, - "InferenceComponentStatus": { - "target": "com.amazonaws.sagemaker#InferenceComponentStatus", - "traits": { - "smithy.api#documentation": "The status of the inference component.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeInferenceExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeInferenceExperimentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeInferenceExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns details about an inference experiment.
" - } - }, - "com.amazonaws.sagemaker#DescribeInferenceExperimentRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#InferenceExperimentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference experiment to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeInferenceExperimentResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#InferenceExperimentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the inference experiment being described.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.sagemaker#InferenceExperimentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference experiment.
", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.sagemaker#InferenceExperimentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of the inference experiment.
", - "smithy.api#required": {} - } - }, - "Schedule": { - "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", - "traits": { - "smithy.api#documentation": "The duration for which the inference experiment ran or will run.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The status of the inference experiment. The following are the possible statuses for an inference\n experiment:\n
\n\n Creating - Amazon SageMaker is creating your experiment.\n
\n Created - Amazon SageMaker has finished the creation of your experiment and will begin the\n experiment at the scheduled time.\n
\n Updating - When you make changes to your experiment, your experiment shows as updating.\n
\n Starting - Amazon SageMaker is beginning your experiment.\n
\n Running - Your experiment is in progress.\n
\n Stopping - Amazon SageMaker is stopping your experiment.\n
\n Completed - Your experiment has completed.\n
\n Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows\n as cancelled.\n
\n The error message or client-specified Reason from the StopInferenceExperiment\n API, that explains the status of the inference experiment.\n
The description of the inference experiment.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which you created the inference experiment.
" - } - }, - "CompletionTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "\n The timestamp at which the inference experiment was completed.\n
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which you last modified the inference experiment.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n
" - } - }, - "EndpointMetadata": { - "target": "com.amazonaws.sagemaker#EndpointMetadata", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The metadata of the endpoint on which the inference experiment ran.
", - "smithy.api#required": {} - } - }, - "ModelVariants": { - "target": "com.amazonaws.sagemaker#ModelVariantConfigSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n An array of ModelVariantConfigSummary objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure\n configuration for deploying the corresponding variant.\n
The Amazon S3 location and configuration for storing inference request and response data.
" - } - }, - "ShadowModeConfig": { - "target": "com.amazonaws.sagemaker#ShadowModeConfig", - "traits": { - "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type, which shows the production variant\n that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.\n
\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see\n CreateInferenceExperiment.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Provides the results of the Inference Recommender job. \n One or more recommendation jobs are returned.
" - } - }, - "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobRequest": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.sagemaker#RecommendationJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobResponse": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.sagemaker#RecommendationJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "JobDescription": { - "target": "com.amazonaws.sagemaker#RecommendationJobDescription", - "traits": { - "smithy.api#documentation": "The job description that you provided when you initiated the job.
" - } - }, - "JobType": { - "target": "com.amazonaws.sagemaker#RecommendationJobType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The job type that you provided when you initiated the job.
", - "smithy.api#required": {} - } - }, - "JobArn": { - "target": "com.amazonaws.sagemaker#RecommendationJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services \n Identity and Access Management (IAM) role you provided when you initiated the job.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#RecommendationJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the job was created.
", - "smithy.api#required": {} - } - }, - "CompletionTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the job completed.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the job was last modified.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the job fails, provides information why the job failed.
" - } - }, - "InputConfig": { - "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations you provided when you initiated the job.
", - "smithy.api#required": {} - } - }, - "StoppingConditions": { - "target": "com.amazonaws.sagemaker#RecommendationJobStoppingConditions", - "traits": { - "smithy.api#documentation": "The stopping conditions that you provided when you initiated the job.
" - } - }, - "InferenceRecommendations": { - "target": "com.amazonaws.sagemaker#InferenceRecommendations", - "traits": { - "smithy.api#documentation": "The recommendations made by Inference Recommender.
" - } - }, - "EndpointPerformances": { - "target": "com.amazonaws.sagemaker#EndpointPerformances", - "traits": { - "smithy.api#documentation": "The performance results from running an Inference Recommender job on an existing endpoint.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeLabelingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeLabelingJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeLabelingJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a labeling job.
" - } - }, - "com.amazonaws.sagemaker#DescribeLabelingJobRequest": { - "type": "structure", - "members": { - "LabelingJobName": { - "target": "com.amazonaws.sagemaker#LabelingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the labeling job to return information for.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeLabelingJobResponse": { - "type": "structure", - "members": { - "LabelingJobStatus": { - "target": "com.amazonaws.sagemaker#LabelingJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The processing status of the labeling job.
", - "smithy.api#required": {} - } - }, - "LabelCounters": { - "target": "com.amazonaws.sagemaker#LabelCounters", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Provides a breakdown of the number of data objects labeled by humans, the number of\n objects labeled by machine, the number of objects than couldn't be labeled, and the\n total number of objects labeled.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the job failed, the reason that it failed.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the labeling job was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the labeling job was last updated.
", - "smithy.api#required": {} - } - }, - "JobReferenceCode": { - "target": "com.amazonaws.sagemaker#JobReferenceCode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique identifier for work done as part of a labeling job.
", - "smithy.api#required": {} - } - }, - "LabelingJobName": { - "target": "com.amazonaws.sagemaker#LabelingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name assigned to the labeling job when it was created.
", - "smithy.api#required": {} - } - }, - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the labeling job.
", - "smithy.api#required": {} - } - }, - "LabelAttributeName": { - "target": "com.amazonaws.sagemaker#LabelAttributeName", - "traits": { - "smithy.api#documentation": "The attribute used as the label in the output manifest file.
" - } - }, - "InputConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Input configuration information for the labeling job, such as the Amazon S3 location of the\n data objects and the location of the manifest file that describes the data\n objects.
", - "smithy.api#required": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location of the job's output data and the Amazon Web Services Key Management\n Service key ID for the key used to encrypt the output data, if any.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf\n during data labeling.
", - "smithy.api#required": {} - } - }, - "LabelCategoryConfigS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The S3 location of the JSON file that defines the categories used to label data\n objects. Please note the following label-category limits:
\nSemantic segmentation labeling jobs using automated labeling: 20 labels
\nBox bounding labeling jobs (all): 10 labels
\nThe file is a JSON structure in the following format:
\n\n {\n
\n \"document-version\": \"2018-11-28\"\n
\n \"labels\": [\n
\n {\n
\n \"label\": \"label 1\"\n
\n },\n
\n {\n
\n \"label\": \"label 2\"\n
\n },\n
\n ...\n
\n {\n
\n \"label\": \"label n\"\n
\n }\n
\n ]\n
\n }\n
A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped.
" - } - }, - "LabelingJobAlgorithmsConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig", - "traits": { - "smithy.api#documentation": "Configuration information for automated data labeling.
" - } - }, - "HumanTaskConfig": { - "target": "com.amazonaws.sagemaker#HumanTaskConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configuration information required for human workers to complete a labeling\n task.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - }, - "LabelingJobOutput": { - "target": "com.amazonaws.sagemaker#LabelingJobOutput", - "traits": { - "smithy.api#documentation": "The location of the output produced by the labeling job.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeLineageGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeLineageGroupRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeLineageGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Provides a list of properties for the requested lineage group. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
" - } - }, - "com.amazonaws.sagemaker#DescribeLineageGroupRequest": { - "type": "structure", - "members": { - "LineageGroupName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the lineage group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeLineageGroupResponse": { - "type": "structure", - "members": { - "LineageGroupName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the lineage group.
" - } - }, - "LineageGroupArn": { - "target": "com.amazonaws.sagemaker#LineageGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The display name of the lineage group.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ExperimentDescription", - "traits": { - "smithy.api#documentation": "The description of the lineage group.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of lineage group.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The last modified time of the lineage group.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeMlflowTrackingServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeMlflowTrackingServerRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeMlflowTrackingServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about an MLflow Tracking Server.
" - } - }, - "com.amazonaws.sagemaker#DescribeMlflowTrackingServerRequest": { - "type": "structure", - "members": { - "TrackingServerName": { - "target": "com.amazonaws.sagemaker#TrackingServerName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the MLflow Tracking Server to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeMlflowTrackingServerResponse": { - "type": "structure", - "members": { - "TrackingServerArn": { - "target": "com.amazonaws.sagemaker#TrackingServerArn", - "traits": { - "smithy.api#documentation": "The ARN of the described tracking server.
" - } - }, - "TrackingServerName": { - "target": "com.amazonaws.sagemaker#TrackingServerName", - "traits": { - "smithy.api#documentation": "The name of the described tracking server.
" - } - }, - "ArtifactStoreUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The S3 URI of the general purpose bucket used as the MLflow Tracking Server\n artifact store.
" - } - }, - "TrackingServerSize": { - "target": "com.amazonaws.sagemaker#TrackingServerSize", - "traits": { - "smithy.api#documentation": "The size of the described tracking server.
" - } - }, - "MlflowVersion": { - "target": "com.amazonaws.sagemaker#MlflowVersion", - "traits": { - "smithy.api#documentation": "The MLflow version used for the described tracking server.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server\n uses to access the artifact store in Amazon S3.
" - } - }, - "TrackingServerStatus": { - "target": "com.amazonaws.sagemaker#TrackingServerStatus", - "traits": { - "smithy.api#documentation": "The current creation status of the described MLflow Tracking Server.
" - } - }, - "IsActive": { - "target": "com.amazonaws.sagemaker#IsTrackingServerActive", - "traits": { - "smithy.api#documentation": "Whether the described MLflow Tracking Server is currently active.
" - } - }, - "TrackingServerUrl": { - "target": "com.amazonaws.sagemaker#TrackingServerUrl", - "traits": { - "smithy.api#documentation": "The URL to connect to the MLflow user interface for the described tracking server.
" - } - }, - "WeeklyMaintenanceWindowStart": { - "target": "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart", - "traits": { - "smithy.api#documentation": "The day and time of the week when weekly maintenance occurs on the described tracking server.
" - } - }, - "AutomaticModelRegistration": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the described MLflow Tracking Server was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the described MLflow Tracking Server was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeModelInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeModelOutput" - }, - "traits": { - "smithy.api#documentation": "Describes a model that you created using the CreateModel\n API.
Returns a description of a model bias job definition.
" - } - }, - "com.amazonaws.sagemaker#DescribeModelBiasJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelBiasJobDefinitionResponse": { - "type": "structure", - "members": { - "JobDefinitionArn": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model bias job.
", - "smithy.api#required": {} - } - }, - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time at which the model bias job was created.
", - "smithy.api#required": {} - } - }, - "ModelBiasBaselineConfig": { - "target": "com.amazonaws.sagemaker#ModelBiasBaselineConfig", - "traits": { - "smithy.api#documentation": "The baseline configuration for a model bias job.
" - } - }, - "ModelBiasAppSpecification": { - "target": "com.amazonaws.sagemaker#ModelBiasAppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configures the model bias job to run a specified Docker container image.
", - "smithy.api#required": {} - } - }, - "ModelBiasJobInput": { - "target": "com.amazonaws.sagemaker#ModelBiasJobInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Inputs for the model bias job.
", - "smithy.api#required": {} - } - }, - "ModelBiasJobOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "JobResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", - "traits": { - "smithy.api#documentation": "Networking options for a model bias job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelCard": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeModelCardRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeModelCardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
" - } - }, - "com.amazonaws.sagemaker#DescribeModelCardExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeModelCardExportJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeModelCardExportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes an Amazon SageMaker Model Card export job.
" - } - }, - "com.amazonaws.sagemaker#DescribeModelCardExportJobRequest": { - "type": "structure", - "members": { - "ModelCardExportJobArn": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card export job to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelCardExportJobResponse": { - "type": "structure", - "members": { - "ModelCardExportJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model card export job to describe.
", - "smithy.api#required": {} - } - }, - "ModelCardExportJobArn": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card export job.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The completion status of the model card export job.
\n\n InProgress: The model card export job is in progress.
\n Completed: The model card export job is complete.
\n Failed: The model card export job failed. To see the reason for the failure, see\n the FailureReason field in the response to a\n DescribeModelCardExportJob call.
The name or Amazon Resource Name (ARN) of the model card that the model export job exports.
", - "smithy.api#required": {} - } - }, - "ModelCardVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the model card that the model export job exports.
", - "smithy.api#required": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#ModelCardExportOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The export output details for the model card.
", - "smithy.api#required": {} - } - }, - "CreatedAt": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the model export job was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedAt": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the model export job was last modified.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The failure reason if the model export job fails.
" - } - }, - "ExportArtifacts": { - "target": "com.amazonaws.sagemaker#ModelCardExportArtifacts", - "traits": { - "smithy.api#documentation": "The exported model card artifacts.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelCardRequest": { - "type": "structure", - "members": { - "ModelCardName": { - "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model card to describe.
", - "smithy.api#required": {} - } - }, - "ModelCardVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelCardResponse": { - "type": "structure", - "members": { - "ModelCardArn": { - "target": "com.amazonaws.sagemaker#ModelCardArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card.
", - "smithy.api#required": {} - } - }, - "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model card.
", - "smithy.api#required": {} - } - }, - "ModelCardVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the model card.
", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.sagemaker#ModelCardContent", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The content of the model card.
", - "smithy.api#required": {} - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The security configuration used to protect model card content.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time the model card was created.
", - "smithy.api#required": {} - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time the model card was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "ModelCardProcessingStatus": { - "target": "com.amazonaws.sagemaker#ModelCardProcessingStatus", - "traits": { - "smithy.api#documentation": "The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
\n DeletePending: Model card deletion request received.
\n DeleteInProgress: Model card deletion is in progress.
\n ContentDeleted: Deleted model card content.
\n ExportJobsDeleted: Deleted all export jobs associated with the model card.
\n DeleteCompleted: Successfully deleted the model card.
\n DeleteFailed: The model card failed to delete.
Returns a description of a model explainability job definition.
" - } - }, - "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinitionResponse": { - "type": "structure", - "members": { - "JobDefinitionArn": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model explainability job.
", - "smithy.api#required": {} - } - }, - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time at which the model explainability job was created.
", - "smithy.api#required": {} - } - }, - "ModelExplainabilityBaselineConfig": { - "target": "com.amazonaws.sagemaker#ModelExplainabilityBaselineConfig", - "traits": { - "smithy.api#documentation": "The baseline configuration for a model explainability job.
" - } - }, - "ModelExplainabilityAppSpecification": { - "target": "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configures the model explainability job to run a specified Docker container image.
", - "smithy.api#required": {} - } - }, - "ModelExplainabilityJobInput": { - "target": "com.amazonaws.sagemaker#ModelExplainabilityJobInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Inputs for the model explainability job.
", - "smithy.api#required": {} - } - }, - "ModelExplainabilityJobOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "JobResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", - "traits": { - "smithy.api#documentation": "Networking options for a model explainability job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelInput": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelOutput": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the SageMaker model.
", - "smithy.api#required": {} - } - }, - "PrimaryContainer": { - "target": "com.amazonaws.sagemaker#ContainerDefinition", - "traits": { - "smithy.api#documentation": "The location of the primary inference code, associated artifacts, and custom\n environment map that the inference code uses when it is deployed in production.\n
" - } - }, - "Containers": { - "target": "com.amazonaws.sagemaker#ContainerDefinitionList", - "traits": { - "smithy.api#documentation": "The containers in the inference pipeline.
" - } - }, - "InferenceExecutionConfig": { - "target": "com.amazonaws.sagemaker#InferenceExecutionConfig", - "traits": { - "smithy.api#documentation": "Specifies details of how containers in a multi-container endpoint are called.
" - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", - "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this model has access to. For\n more information, see Protect Endpoints by Using an Amazon Virtual\n Private Cloud\n
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the model was created.
", - "smithy.api#required": {} - } - }, - "ModelArn": { - "target": "com.amazonaws.sagemaker#ModelArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model.
", - "smithy.api#required": {} - } - }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "If True, no inbound or outbound network calls can be made to or from the\n model container.
A set of recommended deployment configurations for the model.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeModelPackageInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeModelPackageOutput" - }, - "traits": { - "smithy.api#documentation": "Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.
\nIf you provided a KMS Key ID when you created your model package,\n you will see the KMS\n Decrypt API call in your CloudTrail logs when you use this API.
\nTo create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace.
" - } - }, - "com.amazonaws.sagemaker#DescribeModelPackageGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeModelPackageGroupInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeModelPackageGroupOutput" - }, - "traits": { - "smithy.api#documentation": "Gets a description for the specified model group.
" - } - }, - "com.amazonaws.sagemaker#DescribeModelPackageGroupInput": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#ArnOrName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model group to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelPackageGroupOutput": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model group.
", - "smithy.api#required": {} - } - }, - "ModelPackageGroupArn": { - "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model group.
", - "smithy.api#required": {} - } - }, - "ModelPackageGroupDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A description of the model group.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time that the model group was created.
", - "smithy.api#required": {} - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "ModelPackageGroupStatus": { - "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the model group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelPackageInput": { - "type": "structure", - "members": { - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#VersionedArnOrName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to describe.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelPackageOutput": { - "type": "structure", - "members": { - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model package being described.
", - "smithy.api#required": {} - } - }, - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "If the model is a versioned model, the name of the model group that the versioned\n model belongs to.
" - } - }, - "ModelPackageVersion": { - "target": "com.amazonaws.sagemaker#ModelPackageVersion", - "traits": { - "smithy.api#documentation": "The version of the model package.
" - } - }, - "ModelPackageArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
", - "smithy.api#required": {} - } - }, - "ModelPackageDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A brief summary of the model package.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp specifying when the model package was created.
", - "smithy.api#required": {} - } - }, - "InferenceSpecification": { - "target": "com.amazonaws.sagemaker#InferenceSpecification", - "traits": { - "smithy.api#documentation": "Details about inference jobs that you can run with models based on this model\n package.
" - } - }, - "SourceAlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", - "traits": { - "smithy.api#documentation": "Details about the algorithm that was used to create the model package.
" - } - }, - "ValidationSpecification": { - "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", - "traits": { - "smithy.api#documentation": "Configurations for one or more transform jobs that SageMaker runs to test the model\n package.
" - } - }, - "ModelPackageStatus": { - "target": "com.amazonaws.sagemaker#ModelPackageStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the model package.
", - "smithy.api#required": {} - } - }, - "ModelPackageStatusDetails": { - "target": "com.amazonaws.sagemaker#ModelPackageStatusDetails", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Details about the current status of the model package.
", - "smithy.api#required": {} - } - }, - "CertifyForMarketplace": { - "target": "com.amazonaws.sagemaker#CertifyForMarketplace", - "traits": { - "smithy.api#documentation": "Whether the model package is certified for listing on Amazon Web Services Marketplace.
" - } - }, - "ModelApprovalStatus": { - "target": "com.amazonaws.sagemaker#ModelApprovalStatus", - "traits": { - "smithy.api#documentation": "The approval status of the model package.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "ModelMetrics": { - "target": "com.amazonaws.sagemaker#ModelMetrics", - "traits": { - "smithy.api#documentation": "Metrics for the model.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the model package was modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "ApprovalDescription": { - "target": "com.amazonaws.sagemaker#ApprovalDescription", - "traits": { - "smithy.api#documentation": "A description provided for the model approval.
" - } - }, - "Domain": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The machine learning domain of the model package you specified. Common machine\n learning domains include computer vision and natural language processing.
" - } - }, - "Task": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The machine learning task you specified that your model package accomplishes.\n Common machine learning tasks include object detection and image classification.
" - } - }, - "SamplePayloadUrl": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single\n gzip compressed tar archive (.tar.gz suffix).
" - } - }, - "CustomerMetadataProperties": { - "target": "com.amazonaws.sagemaker#CustomerMetadataMap", - "traits": { - "smithy.api#documentation": "The metadata properties associated with the model package versions.
" - } - }, - "DriftCheckBaselines": { - "target": "com.amazonaws.sagemaker#DriftCheckBaselines", - "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package. \n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n
" - } - }, - "AdditionalInferenceSpecifications": { - "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", - "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
" - } - }, - "SkipModelValidation": { - "target": "com.amazonaws.sagemaker#SkipModelValidation", - "traits": { - "smithy.api#documentation": "Indicates if you want to skip model validation.
" - } - }, - "SourceUri": { - "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", - "traits": { - "smithy.api#documentation": "The URI of the source for the model package.
" - } - }, - "SecurityConfig": { - "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", - "traits": { - "smithy.api#documentation": "The KMS Key ID (KMSKeyId) used for encryption of model package information.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
\n A structure describing the current state of the model in its life cycle.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelQualityJobDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns a description of a model quality job definition.
" - } - }, - "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionRequest": { - "type": "structure", - "members": { - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model quality job. The name must be unique within an Amazon Web Services\n Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionResponse": { - "type": "structure", - "members": { - "JobDefinitionArn": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model quality job.
", - "smithy.api#required": {} - } - }, - "JobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time at which the model quality job was created.
", - "smithy.api#required": {} - } - }, - "ModelQualityBaselineConfig": { - "target": "com.amazonaws.sagemaker#ModelQualityBaselineConfig", - "traits": { - "smithy.api#documentation": "The baseline configuration for a model quality job.
" - } - }, - "ModelQualityAppSpecification": { - "target": "com.amazonaws.sagemaker#ModelQualityAppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configures the model quality job to run a specified Docker container image.
", - "smithy.api#required": {} - } - }, - "ModelQualityJobInput": { - "target": "com.amazonaws.sagemaker#ModelQualityJobInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Inputs for the model quality job.
", - "smithy.api#required": {} - } - }, - "ModelQualityJobOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "JobResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", - "traits": { - "smithy.api#documentation": "Networking options for a model quality job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeMonitoringSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeMonitoringScheduleRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeMonitoringScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes the schedule for a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#DescribeMonitoringScheduleRequest": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of a previously created monitoring schedule.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeMonitoringScheduleResponse": { - "type": "structure", - "members": { - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", - "smithy.api#required": {} - } - }, - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the monitoring schedule.
", - "smithy.api#required": {} - } - }, - "MonitoringScheduleStatus": { - "target": "com.amazonaws.sagemaker#ScheduleStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of an monitoring job.
", - "smithy.api#required": {} - } - }, - "MonitoringType": { - "target": "com.amazonaws.sagemaker#MonitoringType", - "traits": { - "smithy.api#documentation": "The type of the monitoring job that this schedule runs. This is one of the following\n values.
\n\n DATA_QUALITY - The schedule is for a data quality monitoring\n job.
\n MODEL_QUALITY - The schedule is for a model quality monitoring\n job.
\n MODEL_BIAS - The schedule is for a bias monitoring job.
\n MODEL_EXPLAINABILITY - The schedule is for an explainability\n monitoring job.
A string, up to one KB in size, that contains the reason a monitoring job failed, if it\n failed.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time at which the monitoring job was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time at which the monitoring job was last modified.
", - "smithy.api#required": {} - } - }, - "MonitoringScheduleConfig": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", - "smithy.api#required": {} - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "The name of the endpoint for the monitoring job.
" - } - }, - "LastMonitoringExecutionSummary": { - "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary", - "traits": { - "smithy.api#documentation": "Describes metadata on the last execution to run, if there was one.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeNotebookInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceOutput" - }, - "traits": { - "smithy.api#documentation": "Returns information about a notebook instance.
", - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "NotebookInstanceDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "errorType": "ValidationException" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "NotebookInstanceStatus", - "expected": "Failed", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 30 - }, - "NotebookInstanceInService": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "NotebookInstanceStatus", - "expected": "InService", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "NotebookInstanceStatus", - "expected": "Failed", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 30 - }, - "NotebookInstanceStopped": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "NotebookInstanceStatus", - "expected": "Stopped", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "NotebookInstanceStatus", - "expected": "Failed", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.sagemaker#DescribeNotebookInstanceInput": { - "type": "structure", - "members": { - "NotebookInstanceName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the notebook instance that you want information about.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigOutput" - }, - "traits": { - "smithy.api#documentation": "Returns a description of a notebook instance lifecycle configuration.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" - } - }, - "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigInput": { - "type": "structure", - "members": { - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the lifecycle configuration to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigOutput": { - "type": "structure", - "members": { - "NotebookInstanceLifecycleConfigArn": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle configuration.
" - } - }, - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#documentation": "The name of the lifecycle configuration.
" - } - }, - "OnCreate": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", - "traits": { - "smithy.api#documentation": "The shell script that runs only once, when you create a notebook instance.
" - } - }, - "OnStart": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", - "traits": { - "smithy.api#documentation": "The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A timestamp that tells when the lifecycle configuration was last modified.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A timestamp that tells when the lifecycle configuration was created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeNotebookInstanceOutput": { - "type": "structure", - "members": { - "NotebookInstanceArn": { - "target": "com.amazonaws.sagemaker#NotebookInstanceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the notebook instance.
" - } - }, - "NotebookInstanceName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceName", - "traits": { - "smithy.api#documentation": "The name of the SageMaker AI notebook instance.
" - } - }, - "NotebookInstanceStatus": { - "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", - "traits": { - "smithy.api#documentation": "The status of the notebook instance.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If status is Failed, the reason it failed.
The URL that you use to connect to the Jupyter notebook that is running in your\n notebook instance.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#InstanceType", - "traits": { - "smithy.api#documentation": "The type of ML compute instance running on the notebook instance.
" - } - }, - "SubnetId": { - "target": "com.amazonaws.sagemaker#SubnetId", - "traits": { - "smithy.api#documentation": "The ID of the VPC subnet.
" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.sagemaker#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "The IDs of the VPC security groups.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the instance.\n
" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when\n storing it on the ML storage volume attached to the instance.
" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.sagemaker#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "The network interface IDs that SageMaker AI created at the time of creating\n the instance.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A timestamp. Use this parameter to retrieve the time when the notebook instance was\n last modified.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A timestamp. Use this parameter to return the time when the notebook instance was\n created
" - } - }, - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#documentation": "Returns the name of a notebook instance lifecycle configuration.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance\n
" - } - }, - "DirectInternetAccess": { - "target": "com.amazonaws.sagemaker#DirectInternetAccess", - "traits": { - "smithy.api#documentation": "Describes whether SageMaker AI provides internet access to the notebook instance.\n If this value is set to Disabled, the notebook instance does not\n have internet access, and cannot connect to SageMaker AI training and endpoint\n services.
\nFor more information, see Notebook Instances Are Internet-Enabled by Default.
" - } - }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", - "traits": { - "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to the notebook instance.
" - } - }, - "AcceleratorTypes": { - "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", - "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of the EI instance types associated with\n this notebook instance.
" - } - }, - "DefaultCodeRepository": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", - "traits": { - "smithy.api#documentation": "The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" - } - }, - "AdditionalCodeRepositories": { - "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", - "traits": { - "smithy.api#documentation": "An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" - } - }, - "RootAccess": { - "target": "com.amazonaws.sagemaker#RootAccess", - "traits": { - "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance.
\nLifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.
\nThe platform identifier of the notebook instance runtime environment.
" - } - }, - "InstanceMetadataServiceConfiguration": { - "target": "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration", - "traits": { - "smithy.api#documentation": "Information on the IMDS configuration of the notebook instance
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeOptimizationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeOptimizationJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeOptimizationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Provides the properties of the specified optimization job.
" - } - }, - "com.amazonaws.sagemaker#DescribeOptimizationJobRequest": { - "type": "structure", - "members": { - "OptimizationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name that you assigned to the optimization job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeOptimizationJobResponse": { - "type": "structure", - "members": { - "OptimizationJobArn": { - "target": "com.amazonaws.sagemaker#OptimizationJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationJobStatus": { - "target": "com.amazonaws.sagemaker#OptimizationJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the optimization job started.
" - } - }, - "OptimizationEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the optimization job finished processing.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when you created the optimization job.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when the optimization job was last updated.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the optimization job status is FAILED, the reason for the\n failure.
The name that you assigned to the optimization job.
", - "smithy.api#required": {} - } - }, - "ModelSource": { - "target": "com.amazonaws.sagemaker#OptimizationJobModelSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location of the source model to optimize with an optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationEnvironment": { - "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", - "traits": { - "smithy.api#documentation": "The environment variables to set in the model container.
" - } - }, - "DeploymentInstanceType": { - "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of instance that hosts the optimized model that you create with the optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationConfigs": { - "target": "com.amazonaws.sagemaker#OptimizationConfigs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Settings for each of the optimization techniques that the job applies.
", - "smithy.api#required": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#OptimizationJobOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Details for where to store the optimized model that you create with the optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationOutput": { - "target": "com.amazonaws.sagemaker#OptimizationOutput", - "traits": { - "smithy.api#documentation": "Output values produced by an optimization job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the IAM role that you assigned to the optimization job.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#OptimizationVpcConfig", - "traits": { - "smithy.api#documentation": "A VPC in Amazon VPC that your optimized model has access to.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribePartnerApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribePartnerAppRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribePartnerAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a SageMaker Partner AI App.
" - } - }, - "com.amazonaws.sagemaker#DescribePartnerAppRequest": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#PartnerAppArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribePartnerAppResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#PartnerAppArn", - "traits": { - "smithy.api#documentation": "The ARN of the SageMaker Partner AI App that was described.
" - } - }, - "Name": { - "target": "com.amazonaws.sagemaker#PartnerAppName", - "traits": { - "smithy.api#documentation": "The name of the SageMaker Partner AI App.
" - } - }, - "Type": { - "target": "com.amazonaws.sagemaker#PartnerAppType", - "traits": { - "smithy.api#documentation": "The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The status of the SageMaker Partner AI App.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the SageMaker Partner AI App was created.
" - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The ARN of the IAM role associated with the SageMaker Partner AI App.
" - } - }, - "BaseUrl": { - "target": "com.amazonaws.sagemaker#String2048", - "traits": { - "smithy.api#documentation": "The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
" - } - }, - "MaintenanceConfig": { - "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", - "traits": { - "smithy.api#documentation": "Maintenance configuration settings for the SageMaker Partner AI App.
" - } - }, - "Tier": { - "target": "com.amazonaws.sagemaker#NonEmptyString64", - "traits": { - "smithy.api#documentation": "The instance type and size of the cluster attached to the SageMaker Partner AI App.
" - } - }, - "Version": { - "target": "com.amazonaws.sagemaker#NonEmptyString64", - "traits": { - "smithy.api#documentation": "The version of the SageMaker Partner AI App.
" - } - }, - "ApplicationConfig": { - "target": "com.amazonaws.sagemaker#PartnerAppConfig", - "traits": { - "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" - } - }, - "AuthType": { - "target": "com.amazonaws.sagemaker#PartnerAppAuthType", - "traits": { - "smithy.api#documentation": "The authorization type that users use to access the SageMaker Partner AI App.
" - } - }, - "EnableIamSessionBasedIdentity": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
This is an error field object that contains the error code and the reason for an operation failure.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribePipeline": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribePipelineRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribePipelineResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes the details of a pipeline.
" - } - }, - "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes the details of an execution's pipeline definition.
" - } - }, - "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionRequest": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionResponse": { - "type": "structure", - "members": { - "PipelineDefinition": { - "target": "com.amazonaws.sagemaker#PipelineDefinition", - "traits": { - "smithy.api#documentation": "The JSON pipeline definition.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the pipeline was created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribePipelineExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribePipelineExecutionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribePipelineExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes the details of a pipeline execution.
" - } - }, - "com.amazonaws.sagemaker#DescribePipelineExecutionRequest": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribePipelineExecutionResponse": { - "type": "structure", - "members": { - "PipelineArn": { - "target": "com.amazonaws.sagemaker#PipelineArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" - } - }, - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" - } - }, - "PipelineExecutionDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineExecutionName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline execution.
" - } - }, - "PipelineExecutionStatus": { - "target": "com.amazonaws.sagemaker#PipelineExecutionStatus", - "traits": { - "smithy.api#documentation": "The status of the pipeline execution.
" - } - }, - "PipelineExecutionDescription": { - "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", - "traits": { - "smithy.api#documentation": "The description of the pipeline execution.
" - } - }, - "PipelineExperimentConfig": { - "target": "com.amazonaws.sagemaker#PipelineExperimentConfig" - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#PipelineExecutionFailureReason", - "traits": { - "smithy.api#documentation": "If the execution failed, a message describing why.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the pipeline execution was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the pipeline execution was modified last.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "ParallelismConfiguration": { - "target": "com.amazonaws.sagemaker#ParallelismConfiguration", - "traits": { - "smithy.api#documentation": "The parallelism configuration applied to the pipeline.
" - } - }, - "SelectiveExecutionConfig": { - "target": "com.amazonaws.sagemaker#SelectiveExecutionConfig", - "traits": { - "smithy.api#documentation": "The selective execution configuration applied to the pipeline run.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribePipelineRequest": { - "type": "structure", - "members": { - "PipelineName": { - "target": "com.amazonaws.sagemaker#PipelineNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the pipeline to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribePipelineResponse": { - "type": "structure", - "members": { - "PipelineArn": { - "target": "com.amazonaws.sagemaker#PipelineArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" - } - }, - "PipelineName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#documentation": "The name of the pipeline.
" - } - }, - "PipelineDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline.
" - } - }, - "PipelineDefinition": { - "target": "com.amazonaws.sagemaker#PipelineDefinition", - "traits": { - "smithy.api#documentation": "The JSON pipeline definition.
" - } - }, - "PipelineDescription": { - "target": "com.amazonaws.sagemaker#PipelineDescription", - "traits": { - "smithy.api#documentation": "The description of the pipeline.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that the pipeline uses to execute.
" - } - }, - "PipelineStatus": { - "target": "com.amazonaws.sagemaker#PipelineStatus", - "traits": { - "smithy.api#documentation": "The status of the pipeline execution.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the pipeline was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the pipeline was last modified.
" - } - }, - "LastRunTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the pipeline was last run.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "ParallelismConfiguration": { - "target": "com.amazonaws.sagemaker#ParallelismConfiguration", - "traits": { - "smithy.api#documentation": "Lists the parallelism configuration applied to the pipeline.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeProcessingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeProcessingJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeProcessingJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns a description of a processing job.
", - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "ProcessingJobCompletedOrStopped": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ProcessingJobStatus", - "expected": "Completed", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "output": { - "path": "ProcessingJobStatus", - "expected": "Stopped", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ProcessingJobStatus", - "expected": "Failed", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "ValidationException" - } - } - ], - "minDelay": 60 - } - } - } - }, - "com.amazonaws.sagemaker#DescribeProcessingJobRequest": { - "type": "structure", - "members": { - "ProcessingJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeProcessingJobResponse": { - "type": "structure", - "members": { - "ProcessingInputs": { - "target": "com.amazonaws.sagemaker#ProcessingInputs", - "traits": { - "smithy.api#documentation": "The inputs for a processing job.
" - } - }, - "ProcessingOutputConfig": { - "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", - "traits": { - "smithy.api#documentation": "Output configuration for the processing job.
" - } - }, - "ProcessingJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "ProcessingResources": { - "target": "com.amazonaws.sagemaker#ProcessingResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", - "traits": { - "smithy.api#documentation": "The time limit for how long the processing job is allowed to run.
" - } - }, - "AppSpecification": { - "target": "com.amazonaws.sagemaker#AppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configures the processing job to run a specified container image.
", - "smithy.api#required": {} - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables set in the Docker container.
" - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#NetworkConfig", - "traits": { - "smithy.api#documentation": "Networking options for a processing job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.
" - } - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig", - "traits": { - "smithy.api#documentation": "The configuration information used to create an experiment.
" - } - }, - "ProcessingJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job.
", - "smithy.api#required": {} - } - }, - "ProcessingJobStatus": { - "target": "com.amazonaws.sagemaker#ProcessingJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Provides the status of a processing job.
", - "smithy.api#required": {} - } - }, - "ExitMessage": { - "target": "com.amazonaws.sagemaker#ExitMessage", - "traits": { - "smithy.api#documentation": "An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.
" - } - }, - "ProcessingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the processing job completed.
" - } - }, - "ProcessingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the processing job started.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the processing job was last modified.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time at which the processing job was created.
", - "smithy.api#required": {} - } - }, - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#documentation": "The ARN of a monitoring schedule for an endpoint associated with this processing\n job.
" - } - }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#documentation": "The ARN of an AutoML job associated with this processing job.
" - } - }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", - "traits": { - "smithy.api#documentation": "The ARN of a training job associated with this processing job.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeProjectInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeProjectOutput" - }, - "traits": { - "smithy.api#documentation": "Describes the details of a project.
" - } - }, - "com.amazonaws.sagemaker#DescribeProjectInput": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.sagemaker#ProjectEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the project to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeProjectOutput": { - "type": "structure", - "members": { - "ProjectArn": { - "target": "com.amazonaws.sagemaker#ProjectArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
", - "smithy.api#required": {} - } - }, - "ProjectName": { - "target": "com.amazonaws.sagemaker#ProjectEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the project.
", - "smithy.api#required": {} - } - }, - "ProjectId": { - "target": "com.amazonaws.sagemaker#ProjectId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the project.
", - "smithy.api#required": {} - } - }, - "ProjectDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "The description of the project.
" - } - }, - "ServiceCatalogProvisioningDetails": { - "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information used to provision a service catalog product. For information, see What is Amazon Web Services Service\n Catalog.
", - "smithy.api#required": {} - } - }, - "ServiceCatalogProvisionedProductDetails": { - "target": "com.amazonaws.sagemaker#ServiceCatalogProvisionedProductDetails", - "traits": { - "smithy.api#documentation": "Information about a provisioned service catalog product.
" - } - }, - "ProjectStatus": { - "target": "com.amazonaws.sagemaker#ProjectStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the project.
", - "smithy.api#required": {} - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when the project was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp when project was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeSpace": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeSpaceRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeSpaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes the space.
" - } - }, - "com.amazonaws.sagemaker#DescribeSpaceRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the associated domain.
", - "smithy.api#required": {} - } - }, - "SpaceName": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the space.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeSpaceResponse": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "The ID of the associated domain.
" - } - }, - "SpaceArn": { - "target": "com.amazonaws.sagemaker#SpaceArn", - "traits": { - "smithy.api#documentation": "The space's Amazon Resource Name (ARN).
" - } - }, - "SpaceName": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#documentation": "The name of the space.
" - } - }, - "HomeEfsFileSystemUid": { - "target": "com.amazonaws.sagemaker#EfsUid", - "traits": { - "smithy.api#documentation": "The ID of the space's profile in the Amazon EFS volume.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#SpaceStatus", - "traits": { - "smithy.api#documentation": "The status.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "The last modified time.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "The creation time.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The failure reason.
" - } - }, - "SpaceSettings": { - "target": "com.amazonaws.sagemaker#SpaceSettings", - "traits": { - "smithy.api#documentation": "A collection of space settings.
" - } - }, - "OwnershipSettings": { - "target": "com.amazonaws.sagemaker#OwnershipSettings", - "traits": { - "smithy.api#documentation": "The collection of ownership settings for a space.
" - } - }, - "SpaceSharingSettings": { - "target": "com.amazonaws.sagemaker#SpaceSharingSettings", - "traits": { - "smithy.api#documentation": "The collection of space sharing settings for a space.
" - } - }, - "SpaceDisplayName": { - "target": "com.amazonaws.sagemaker#NonEmptyString64", - "traits": { - "smithy.api#documentation": "The name of the space that appears in the Amazon SageMaker Studio UI.
" - } - }, - "Url": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity\n Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to\n the URL after appending the respective redirect parameter for the application type to be\n federated through Amazon Web Services IAM Identity Center.
\nThe following application types are supported:
\nStudio Classic: &redirect=JupyterServer\n
JupyterLab: &redirect=JupyterLab\n
Code Editor, based on Code-OSS, Visual Studio Code - Open Source:\n &redirect=CodeEditor\n
Describes the Amazon SageMaker AI Studio Lifecycle Configuration.
" - } - }, - "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigRequest": { - "type": "structure", - "members": { - "StudioLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigResponse": { - "type": "structure", - "members": { - "StudioLifecycleConfigArn": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", - "traits": { - "smithy.api#documentation": "The ARN of the Lifecycle Configuration to describe.
" - } - }, - "StudioLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", - "traits": { - "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is\n described.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle\n Configurations are immutable.
" - } - }, - "StudioLifecycleConfigContent": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", - "traits": { - "smithy.api#documentation": "The content of your Amazon SageMaker AI Studio Lifecycle Configuration script.
" - } - }, - "StudioLifecycleConfigAppType": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", - "traits": { - "smithy.api#documentation": "The App type that the Lifecycle Configuration is attached to.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeSubscribedWorkteam": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeSubscribedWorkteamRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeSubscribedWorkteamResponse" - }, - "traits": { - "smithy.api#documentation": "Gets information about a work team provided by a vendor. It returns details about the\n subscription with a vendor in the Amazon Web Services Marketplace.
" - } - }, - "com.amazonaws.sagemaker#DescribeSubscribedWorkteamRequest": { - "type": "structure", - "members": { - "WorkteamArn": { - "target": "com.amazonaws.sagemaker#WorkteamArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the subscribed work team to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeSubscribedWorkteamResponse": { - "type": "structure", - "members": { - "SubscribedWorkteam": { - "target": "com.amazonaws.sagemaker#SubscribedWorkteam", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A Workteam instance that contains information about the work team.
Returns information about a training job.
\nSome of the attributes below only appear if the training job successfully starts.\n If the training job fails, TrainingJobStatus is Failed and,\n depending on the FailureReason, attributes like\n TrainingStartTime, TrainingTimeInSeconds,\n TrainingEndTime, and BillableTimeInSeconds may not be\n present in the response.
The name of the training job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeTrainingJobResponse": { - "type": "structure", - "members": { - "TrainingJobName": { - "target": "com.amazonaws.sagemaker#TrainingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the model training job.
", - "smithy.api#required": {} - } - }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
", - "smithy.api#required": {} - } - }, - "TuningJobArn": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.
" - } - }, - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the\n transform or training job.
" - } - }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an AutoML job.
" - } - }, - "ModelArtifacts": { - "target": "com.amazonaws.sagemaker#ModelArtifacts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the Amazon S3 location that is configured for storing model artifacts.\n
", - "smithy.api#required": {} - } - }, - "TrainingJobStatus": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the training job.
\nSageMaker provides the following training job statuses:
\n\n InProgress - The training is in progress.
\n Completed - The training job has completed.
\n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.
\n Stopping - The training job is stopping.
\n Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus.
Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of\n them:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Interrupted - The job stopped because the managed\n spot training instances were interrupted.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n MaxWaitTimeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTraining\n
\n DownloadingTrainingImage\n
If the training job failed, the reason it failed.
" - } - }, - "HyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", - "traits": { - "smithy.api#documentation": "Algorithm-specific parameters.
" - } - }, - "AlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#AlgorithmSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the algorithm used for training, and algorithm metadata.\n
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Identity and Access Management (IAM) role configured for\n the training job.
" - } - }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#InputDataConfig", - "traits": { - "smithy.api#documentation": "An array of Channel objects that describes each data input channel.\n
The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.
" - } - }, - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Resources, including ML compute instances and ML storage volumes, that are\n configured for model training.
", - "smithy.api#required": {} - } - }, - "WarmPoolStatus": { - "target": "com.amazonaws.sagemaker#WarmPoolStatus", - "traits": { - "smithy.api#documentation": "The status of the warm pool associated with the training job.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", - "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.
A timestamp that indicates when the training job was created.
", - "smithy.api#required": {} - } - }, - "TrainingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time when the training job starts on training instances. You are\n billed for the time interval between this time and the value of\n TrainingEndTime. The start time in CloudWatch Logs might be later than this time.\n The difference is due to the time it takes to download the training data and to the size\n of the training container.
Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
A timestamp that indicates when the status of the training job was last\n modified.
" - } - }, - "SecondaryStatusTransitions": { - "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", - "traits": { - "smithy.api#documentation": "A history of all of the secondary statuses that the training job has transitioned\n through.
" - } - }, - "FinalMetricDataList": { - "target": "com.amazonaws.sagemaker#FinalMetricDataList", - "traits": { - "smithy.api#documentation": "A collection of MetricData objects that specify the names, values, and\n dates and times that the training algorithm emitted to Amazon CloudWatch.
If you want to allow inbound or outbound network calls, except for calls between peers\n within a training cluster for distributed training, choose True. If you\n enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithms in\n distributed training.
A Boolean indicating whether managed spot training is enabled (True) or\n not (False).
The training time in seconds.
" - } - }, - "BillableTimeInSeconds": { - "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", - "traits": { - "smithy.api#documentation": "The billable time in seconds. Billable time refers to the absolute wall-clock\n time.
\nMultiply BillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run distributed training. The formula is as follows:\n BillableTimeInSeconds * InstanceCount .
You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.
Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
" - } - }, - "TensorBoardOutputConfig": { - "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" - }, - "DebugRuleEvaluationStatuses": { - "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", - "traits": { - "smithy.api#documentation": "Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.
" - } - }, - "ProfilerConfig": { - "target": "com.amazonaws.sagemaker#ProfilerConfig" - }, - "ProfilerRuleConfigurations": { - "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", - "traits": { - "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.
" - } - }, - "ProfilerRuleEvaluationStatuses": { - "target": "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatuses", - "traits": { - "smithy.api#documentation": "Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.
" - } - }, - "ProfilingStatus": { - "target": "com.amazonaws.sagemaker#ProfilingStatus", - "traits": { - "smithy.api#documentation": "Profiling status of a training job.
" - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container.
" - } - }, - "RetryStrategy": { - "target": "com.amazonaws.sagemaker#RetryStrategy", - "traits": { - "smithy.api#documentation": "The number of times to retry the job when the job fails due to an\n InternalServerError.
Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" - } - }, - "InfraCheckConfig": { - "target": "com.amazonaws.sagemaker#InfraCheckConfig", - "traits": { - "smithy.api#documentation": "Contains information about the infrastructure health check configuration for the training job.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeTrainingPlan": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeTrainingPlanRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeTrainingPlanResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves detailed information about a specific training plan.
" - } - }, - "com.amazonaws.sagemaker#DescribeTrainingPlanRequest": { - "type": "structure", - "members": { - "TrainingPlanName": { - "target": "com.amazonaws.sagemaker#TrainingPlanName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the training plan to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeTrainingPlanResponse": { - "type": "structure", - "members": { - "TrainingPlanArn": { - "target": "com.amazonaws.sagemaker#TrainingPlanArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan.
", - "smithy.api#required": {} - } - }, - "TrainingPlanName": { - "target": "com.amazonaws.sagemaker#TrainingPlanName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the training plan.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#TrainingPlanStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.
A message providing additional information about the current status of the training\n plan.
" - } - }, - "DurationHours": { - "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", - "traits": { - "smithy.api#documentation": "The number of whole hours in the total duration for this training plan.
" - } - }, - "DurationMinutes": { - "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", - "traits": { - "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training\n plan.
" - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The start time of the training plan.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The end time of the training plan.
" - } - }, - "UpfrontFee": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The upfront fee for the training plan.
" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.sagemaker#CurrencyCode", - "traits": { - "smithy.api#documentation": "The currency code for the upfront fee (e.g., USD).
" - } - }, - "TotalInstanceCount": { - "target": "com.amazonaws.sagemaker#TotalInstanceCount", - "traits": { - "smithy.api#documentation": "The total number of instances reserved in this training plan.
" - } - }, - "AvailableInstanceCount": { - "target": "com.amazonaws.sagemaker#AvailableInstanceCount", - "traits": { - "smithy.api#documentation": "The number of instances currently available for use in this training plan.
" - } - }, - "InUseInstanceCount": { - "target": "com.amazonaws.sagemaker#InUseInstanceCount", - "traits": { - "smithy.api#documentation": "The number of instances currently in use from this training plan.
" - } - }, - "TargetResources": { - "target": "com.amazonaws.sagemaker#SageMakerResourceNames", - "traits": { - "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training\n plan.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe list of Reserved Capacity providing the underlying compute resources of the plan.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeTransformJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeTransformJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeTransformJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about a transform job.
", - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "TransformJobCompletedOrStopped": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "TransformJobStatus", - "expected": "Completed", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "output": { - "path": "TransformJobStatus", - "expected": "Stopped", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "TransformJobStatus", - "expected": "Failed", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "ValidationException" - } - } - ], - "minDelay": 60 - } - } - } - }, - "com.amazonaws.sagemaker#DescribeTransformJobRequest": { - "type": "structure", - "members": { - "TransformJobName": { - "target": "com.amazonaws.sagemaker#TransformJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the transform job that you want to view details of.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeTransformJobResponse": { - "type": "structure", - "members": { - "TransformJobName": { - "target": "com.amazonaws.sagemaker#TransformJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the transform job.
", - "smithy.api#required": {} - } - }, - "TransformJobArn": { - "target": "com.amazonaws.sagemaker#TransformJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job.
", - "smithy.api#required": {} - } - }, - "TransformJobStatus": { - "target": "com.amazonaws.sagemaker#TransformJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The\n status of the transform job. If the transform job failed, the reason\n is returned in the FailureReason field.
If the transform job failed, FailureReason describes\n why\n it failed. A transform job creates a log file, which includes error\n messages, and stores it\n as\n an Amazon S3 object. For more information, see Log Amazon SageMaker Events with\n Amazon CloudWatch.
The name of the model used in the transform job.
", - "smithy.api#required": {} - } - }, - "MaxConcurrentTransforms": { - "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", - "traits": { - "smithy.api#documentation": "The\n maximum number\n of\n parallel requests on each instance node\n that can be launched in a transform job. The default value is 1.
" - } - }, - "ModelClientConfig": { - "target": "com.amazonaws.sagemaker#ModelClientConfig", - "traits": { - "smithy.api#documentation": "The timeout and maximum number of retries for processing a transform job\n invocation.
" - } - }, - "MaxPayloadInMB": { - "target": "com.amazonaws.sagemaker#MaxPayloadInMB", - "traits": { - "smithy.api#documentation": "The\n maximum\n payload size, in MB, used in the\n transform job.
" - } - }, - "BatchStrategy": { - "target": "com.amazonaws.sagemaker#BatchStrategy", - "traits": { - "smithy.api#documentation": "Specifies the number of records to include in a mini-batch for an HTTP inference\n request.\n A record\n is a single unit of input data that inference\n can be made on. For example, a single line in a CSV file is a record.
\nTo enable the batch strategy, you must set SplitType\n to\n Line, RecordIO, or\n TFRecord.
The\n environment variables to set in the Docker container. We support up to 16 key and values\n entries in the map.
" - } - }, - "TransformInput": { - "target": "com.amazonaws.sagemaker#TransformInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the dataset to be transformed and the Amazon S3 location where it is\n stored.
", - "smithy.api#required": {} - } - }, - "TransformOutput": { - "target": "com.amazonaws.sagemaker#TransformOutput", - "traits": { - "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.
" - } - }, - "DataCaptureConfig": { - "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig", - "traits": { - "smithy.api#documentation": "Configuration to control how SageMaker captures inference data.
" - } - }, - "TransformResources": { - "target": "com.amazonaws.sagemaker#TransformResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes\n the resources, including ML instance types and ML instance count, to\n use for the transform job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the transform Job was created.
", - "smithy.api#required": {} - } - }, - "TransformStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates when the transform job starts\n on\n ML instances. You are billed for the time interval between this time\n and the value of TransformEndTime.
Indicates when the transform job has been\n \n completed, or has stopped or failed. You are billed for the time\n interval between this time and the value of TransformStartTime.
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the\n transform or training job.
" - } - }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML transform job.
" - } - }, - "DataProcessing": { - "target": "com.amazonaws.sagemaker#DataProcessing" - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeTrial": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeTrialRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeTrialResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Provides a list of a trial's properties.
" - } - }, - "com.amazonaws.sagemaker#DescribeTrialComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeTrialComponentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeTrialComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Provides a list of a trials component's properties.
" - } - }, - "com.amazonaws.sagemaker#DescribeTrialComponentRequest": { - "type": "structure", - "members": { - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the trial component to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeTrialComponentResponse": { - "type": "structure", - "members": { - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial component.
" - } - }, - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#TrialComponentStatus", - "traits": { - "smithy.api#documentation": "The status of the component. States include:
\nInProgress
\nCompleted
\nFailed
\nWhen the component started.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component ended.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who created the trial component.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who last modified the component.
" - } - }, - "Parameters": { - "target": "com.amazonaws.sagemaker#TrialComponentParameters", - "traits": { - "smithy.api#documentation": "The hyperparameters of the component.
" - } - }, - "InputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", - "traits": { - "smithy.api#documentation": "The input artifacts of the component.
" - } - }, - "OutputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", - "traits": { - "smithy.api#documentation": "The output artifacts of the component.
" - } - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "Metrics": { - "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", - "traits": { - "smithy.api#documentation": "The metrics for the component.
" - } - }, - "LineageGroupArn": { - "target": "com.amazonaws.sagemaker#LineageGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" - } - }, - "Sources": { - "target": "com.amazonaws.sagemaker#TrialComponentSources", - "traits": { - "smithy.api#documentation": "A list of ARNs and, if applicable, job types for multiple sources of an experiment\n run.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeTrialRequest": { - "type": "structure", - "members": { - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the trial to describe.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeTrialResponse": { - "type": "structure", - "members": { - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial.
" - } - }, - "TrialArn": { - "target": "com.amazonaws.sagemaker#TrialArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.
The name of the experiment the trial is part of.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#TrialSource", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source and, optionally, the job type.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the trial was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who created the trial.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the trial was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who last modified the trial.
" - } - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeUserProfileRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeUserProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Describes a user profile. For more information, see CreateUserProfile.
The domain ID.
", - "smithy.api#required": {} - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The user profile name. This value is not case sensitive.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeUserProfileResponse": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "The ID of the domain that contains the profile.
" - } - }, - "UserProfileArn": { - "target": "com.amazonaws.sagemaker#UserProfileArn", - "traits": { - "smithy.api#documentation": "The user profile Amazon Resource Name (ARN).
" - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "The user profile name.
" - } - }, - "HomeEfsFileSystemUid": { - "target": "com.amazonaws.sagemaker#EfsUid", - "traits": { - "smithy.api#documentation": "The ID of the user's profile in the Amazon Elastic File System volume.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#UserProfileStatus", - "traits": { - "smithy.api#documentation": "The status.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "The last modified time.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "The creation time.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The failure reason.
" - } - }, - "SingleSignOnUserIdentifier": { - "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", - "traits": { - "smithy.api#documentation": "The IAM Identity Center user identifier.
" - } - }, - "SingleSignOnUserValue": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The IAM Identity Center user value.
" - } - }, - "UserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", - "traits": { - "smithy.api#documentation": "A collection of settings.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeWorkforce": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeWorkforceRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeWorkforceResponse" - }, - "traits": { - "smithy.api#documentation": "Lists private workforce information, including workforce name, Amazon Resource Name\n (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address\n ranges are the IP addresses that workers can use to access tasks.
\nThis operation applies only to private workforces.
\nThe name of the private workforce whose access you want to restrict.\n WorkforceName is automatically set to default when a\n workforce is created and cannot be modified.
A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DescribeWorkteam": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DescribeWorkteamRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DescribeWorkteamResponse" - }, - "traits": { - "smithy.api#documentation": "Gets information about a specific work team. You can see information such as the\n creation date, the last updated date, membership information, and the work team's Amazon\n Resource Name (ARN).
" - } - }, - "com.amazonaws.sagemaker#DescribeWorkteamRequest": { - "type": "structure", - "members": { - "WorkteamName": { - "target": "com.amazonaws.sagemaker#WorkteamName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the work team to return a description of.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DescribeWorkteamResponse": { - "type": "structure", - "members": { - "Workteam": { - "target": "com.amazonaws.sagemaker#Workteam", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A Workteam instance that contains information about the work team.\n
The name of the variant to update.
", - "smithy.api#required": {} - } - }, - "DesiredWeight": { - "target": "com.amazonaws.sagemaker#VariantWeight", - "traits": { - "smithy.api#documentation": "The variant's weight.
" - } - }, - "DesiredInstanceCount": { - "target": "com.amazonaws.sagemaker#TaskCount", - "traits": { - "smithy.api#documentation": "The variant's capacity.
" - } - }, - "ServerlessUpdateConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantServerlessUpdateConfig", - "traits": { - "smithy.api#documentation": "Specifies the serverless update concurrency configuration for an endpoint variant.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies weight and capacity values for a production variant.
" - } - }, - "com.amazonaws.sagemaker#DesiredWeightAndCapacityList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#DesiredWeightAndCapacity" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#DestinationS3Uri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^(https|s3)://([^/])/?(.*)$" - } - }, - "com.amazonaws.sagemaker#DetailedAlgorithmStatus": { - "type": "enum", - "members": { - "NOT_STARTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotStarted" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.sagemaker#DetailedModelPackageStatus": { - "type": "enum", - "members": { - "NOT_STARTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotStarted" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.sagemaker#Device": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.sagemaker#DeviceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the device.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#DeviceDescription", - "traits": { - "smithy.api#documentation": "Description of the device.
" - } - }, - "IotThingName": { - "target": "com.amazonaws.sagemaker#ThingName", - "traits": { - "smithy.api#documentation": "Amazon Web Services Internet of Things (IoT) object name.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information of a particular device.
" - } - }, - "com.amazonaws.sagemaker#DeviceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.sagemaker#DeviceDeploymentStatus": { - "type": "enum", - "members": { - "ReadyToDeploy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READYTODEPLOY" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INPROGRESS" - } - }, - "Deployed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEPLOYED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "Stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.sagemaker#DeviceDeploymentSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#DeviceDeploymentSummary" - } - }, - "com.amazonaws.sagemaker#DeviceDeploymentSummary": { - "type": "structure", - "members": { - "EdgeDeploymentPlanArn": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "StageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stage in the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "DeployedStageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the deployed stage.
" - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the fleet to which the device belongs to.
" - } - }, - "DeviceName": { - "target": "com.amazonaws.sagemaker#DeviceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the device.
", - "smithy.api#required": {} - } - }, - "DeviceArn": { - "target": "com.amazonaws.sagemaker#DeviceArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the device.
", - "smithy.api#required": {} - } - }, - "DeviceDeploymentStatus": { - "target": "com.amazonaws.sagemaker#DeviceDeploymentStatus", - "traits": { - "smithy.api#documentation": "The deployment status of the device.
" - } - }, - "DeviceDeploymentStatusMessage": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The detailed error message for the deployoment status result.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#DeviceDescription", - "traits": { - "smithy.api#documentation": "The description of the device.
" - } - }, - "DeploymentStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the deployment on the device started.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information summarizing device details and deployment status.
" - } - }, - "com.amazonaws.sagemaker#DeviceDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 40 - }, - "smithy.api#pattern": "^[-a-zA-Z0-9_.,;:! ]*$" - } - }, - "com.amazonaws.sagemaker#DeviceFleetArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.sagemaker#DeviceFleetDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 800 - }, - "smithy.api#pattern": "^[-a-zA-Z0-9_.,;:! ]*$" - } - }, - "com.amazonaws.sagemaker#DeviceFleetSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#DeviceFleetSummary" - } - }, - "com.amazonaws.sagemaker#DeviceFleetSummary": { - "type": "structure", - "members": { - "DeviceFleetArn": { - "target": "com.amazonaws.sagemaker#DeviceFleetArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Amazon Resource Name (ARN) of the device fleet.
", - "smithy.api#required": {} - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the device fleet.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Timestamp of when the device fleet was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Timestamp of when the device fleet was last updated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summary of the device fleet.
" - } - }, - "com.amazonaws.sagemaker#DeviceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#DeviceNames": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#DeviceName" - } - }, - "com.amazonaws.sagemaker#DeviceSelectionConfig": { - "type": "structure", - "members": { - "DeviceSubsetType": { - "target": "com.amazonaws.sagemaker#DeviceSubsetType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of device subsets to deploy to the current stage.
", - "smithy.api#required": {} - } - }, - "Percentage": { - "target": "com.amazonaws.sagemaker#Percentage", - "traits": { - "smithy.api#documentation": "Percentage of devices in the fleet to deploy to the current stage.
" - } - }, - "DeviceNames": { - "target": "com.amazonaws.sagemaker#DeviceNames", - "traits": { - "smithy.api#documentation": "List of devices chosen to deploy.
" - } - }, - "DeviceNameContains": { - "target": "com.amazonaws.sagemaker#DeviceName", - "traits": { - "smithy.api#documentation": "A filter to select devices with names containing this name.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the configurations of selected devices.
" - } - }, - "com.amazonaws.sagemaker#DeviceStats": { - "type": "structure", - "members": { - "ConnectedDeviceCount": { - "target": "com.amazonaws.sagemaker#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of devices connected with a heartbeat.
", - "smithy.api#required": {} - } - }, - "RegisteredDeviceCount": { - "target": "com.amazonaws.sagemaker#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of registered devices.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Status of devices.
" - } - }, - "com.amazonaws.sagemaker#DeviceSubsetType": { - "type": "enum", - "members": { - "Percentage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTAGE" - } - }, - "Selection": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELECTION" - } - }, - "NameContains": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAMECONTAINS" - } - } - } - }, - "com.amazonaws.sagemaker#DeviceSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#DeviceSummary" - } - }, - "com.amazonaws.sagemaker#DeviceSummary": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique identifier of the device.
", - "smithy.api#required": {} - } - }, - "DeviceArn": { - "target": "com.amazonaws.sagemaker#DeviceArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Amazon Resource Name (ARN) of the device.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#DeviceDescription", - "traits": { - "smithy.api#documentation": "A description of the device.
" - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the fleet the device belongs to.
" - } - }, - "IotThingName": { - "target": "com.amazonaws.sagemaker#ThingName", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
" - } - }, - "RegistrationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of the last registration or de-reregistration.
" - } - }, - "LatestHeartbeat": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The last heartbeat received from the device.
" - } - }, - "Models": { - "target": "com.amazonaws.sagemaker#EdgeModelSummaries", - "traits": { - "smithy.api#documentation": "Models on the device.
" - } - }, - "AgentVersion": { - "target": "com.amazonaws.sagemaker#EdgeVersion", - "traits": { - "smithy.api#documentation": "Edge Manager agent version.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summary of the device.
" - } - }, - "com.amazonaws.sagemaker#Devices": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Device" - } - }, - "com.amazonaws.sagemaker#Dimension": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 8192 - } - } - }, - "com.amazonaws.sagemaker#DirectDeploySettings": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#FeatureStatus", - "traits": { - "smithy.api#documentation": "Describes whether model deployment permissions are enabled or disabled in the Canvas application.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The model deployment settings for the SageMaker Canvas application.
\nIn order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM\n execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also\n turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.
Disables using Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.
" - } - }, - "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolioInput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolioOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#DisassociateNotebookInstanceLifecycleConfig": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#DisassociateTrialComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#DisassociateTrialComponentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#DisassociateTrialComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates a trial component from a trial. This doesn't effect other trials the\n component is associated with. Before you can delete a component, you must disassociate the\n component from all trials it is associated with. To associate a trial component with a trial,\n call the AssociateTrialComponent API.
\nTo get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter.\n The list appears in the response under Results.TrialComponent.Parents.
The name of the component to disassociate from the trial.
", - "smithy.api#required": {} - } - }, - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the trial to disassociate from.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#DisassociateTrialComponentResponse": { - "type": "structure", - "members": { - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" - } - }, - "TrialArn": { - "target": "com.amazonaws.sagemaker#TrialArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#DockerSettings": { - "type": "structure", - "members": { - "EnableDockerAccess": { - "target": "com.amazonaws.sagemaker#FeatureStatus", - "traits": { - "smithy.api#documentation": "Indicates whether the domain can access Docker.
" - } - }, - "VpcOnlyTrustedAccounts": { - "target": "com.amazonaws.sagemaker#VpcOnlyTrustedAccounts", - "traits": { - "smithy.api#documentation": "The list of Amazon Web Services accounts that are trusted when the domain is created in\n VPC-only mode.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of settings that configure the domain's Docker interaction.
" - } - }, - "com.amazonaws.sagemaker#DocumentSchemaVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 14 - }, - "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" - } - }, - "com.amazonaws.sagemaker#Dollars": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.sagemaker#DomainArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/" - } - }, - "com.amazonaws.sagemaker#DomainDetails": { - "type": "structure", - "members": { - "DomainArn": { - "target": "com.amazonaws.sagemaker#DomainArn", - "traits": { - "smithy.api#documentation": "The domain's Amazon Resource Name (ARN).
" - } - }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "The domain ID.
" - } - }, - "DomainName": { - "target": "com.amazonaws.sagemaker#DomainName", - "traits": { - "smithy.api#documentation": "The domain name.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#DomainStatus", - "traits": { - "smithy.api#documentation": "The status.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "The creation time.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "The last modified time.
" - } - }, - "Url": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The domain's URL.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The domain's details.
" - } - }, - "com.amazonaws.sagemaker#DomainId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^d-(-*[a-z0-9]){1,61}$" - } - }, - "com.amazonaws.sagemaker#DomainList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#DomainDetails" - } - }, - "com.amazonaws.sagemaker#DomainName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#DomainSecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#SecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.sagemaker#DomainSettings": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#DomainSecurityGroupIds", - "traits": { - "smithy.api#documentation": "The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.
A collection of settings that configure the RStudioServerPro Domain-level\n app.
The configuration for attaching a SageMaker AI user profile name to the execution\n role as a sts:SourceIdentity key.
" - } - }, - "DockerSettings": { - "target": "com.amazonaws.sagemaker#DockerSettings", - "traits": { - "smithy.api#documentation": "A collection of settings that configure the domain's Docker interaction.
" - } - }, - "AmazonQSettings": { - "target": "com.amazonaws.sagemaker#AmazonQSettings", - "traits": { - "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain. The\n AuthMode that you use to create the domain must be SSO.
A collection of settings that apply to the SageMaker Domain. These settings\n are specified through the CreateDomain API call.
A collection of RStudioServerPro Domain-level app settings to update. A\n single RStudioServerPro application is created for a domain.
The configuration for attaching a SageMaker AI user profile name to the execution\n role as a sts:SourceIdentity key. This configuration can only be modified if there are no\n apps in the InService or Pending state.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.
A collection of settings that configure the domain's Docker interaction.
" - } - }, - "AmazonQSettings": { - "target": "com.amazonaws.sagemaker#AmazonQSettings", - "traits": { - "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of Domain configuration settings to update.
Represents the drift check bias baselines that can be used when the model monitor is set using the model \n package.
" - } - }, - "Explainability": { - "target": "com.amazonaws.sagemaker#DriftCheckExplainability", - "traits": { - "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set using \n the model package.
" - } - }, - "ModelQuality": { - "target": "com.amazonaws.sagemaker#DriftCheckModelQuality", - "traits": { - "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.
" - } - }, - "ModelDataQuality": { - "target": "com.amazonaws.sagemaker#DriftCheckModelDataQuality", - "traits": { - "smithy.api#documentation": "Represents the drift check model data quality baselines that can be used when the model monitor is set \n using the model package.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model \n package.
" - } - }, - "com.amazonaws.sagemaker#DriftCheckBias": { - "type": "structure", - "members": { - "ConfigFile": { - "target": "com.amazonaws.sagemaker#FileSource", - "traits": { - "smithy.api#documentation": "The bias config file for a model.
" - } - }, - "PreTrainingConstraints": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The pre-training constraints.
" - } - }, - "PostTrainingConstraints": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The post-training constraints.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is set using the \n model package.
" - } - }, - "com.amazonaws.sagemaker#DriftCheckExplainability": { - "type": "structure", - "members": { - "Constraints": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The drift check explainability constraints.
" - } - }, - "ConfigFile": { - "target": "com.amazonaws.sagemaker#FileSource", - "traits": { - "smithy.api#documentation": "The explainability config file for the model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set \n using the model package.
" - } - }, - "com.amazonaws.sagemaker#DriftCheckModelDataQuality": { - "type": "structure", - "members": { - "Statistics": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The drift check model data quality statistics.
" - } - }, - "Constraints": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The drift check model data quality constraints.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the drift check data quality baselines that can be used when the model monitor is set using \n the model package.
" - } - }, - "com.amazonaws.sagemaker#DriftCheckModelQuality": { - "type": "structure", - "members": { - "Statistics": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The drift check model quality statistics.
" - } - }, - "Constraints": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "The drift check model quality constraints.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.
" - } - }, - "com.amazonaws.sagemaker#DynamicScalingConfiguration": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The recommended minimum capacity to specify for your autoscaling policy.
" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The recommended maximum capacity to specify for your autoscaling policy.
" - } - }, - "ScaleInCooldown": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The recommended scale in cooldown time for your autoscaling policy.
" - } - }, - "ScaleOutCooldown": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The recommended scale out cooldown time for your autoscaling policy.
" - } - }, - "ScalingPolicies": { - "target": "com.amazonaws.sagemaker#ScalingPolicies", - "traits": { - "smithy.api#documentation": "An object of the scaling policies for each metric.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object with the recommended values for you to specify when creating an autoscaling policy.
" - } - }, - "com.amazonaws.sagemaker#EFSFileSystem": { - "type": "structure", - "members": { - "FileSystemId": { - "target": "com.amazonaws.sagemaker#FileSystemId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of your Amazon EFS file system.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A file system, created by you in Amazon EFS, that you assign to a user profile or\n space for an Amazon SageMaker AI Domain. Permitted users can access this file system in\n Amazon SageMaker AI Studio.
" - } - }, - "com.amazonaws.sagemaker#EFSFileSystemConfig": { - "type": "structure", - "members": { - "FileSystemId": { - "target": "com.amazonaws.sagemaker#FileSystemId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of your Amazon EFS file system.
", - "smithy.api#required": {} - } - }, - "FileSystemPath": { - "target": "com.amazonaws.sagemaker#FileSystemPath", - "traits": { - "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker AI Studio.\n Permitted users can access only this directory and below.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The settings for assigning a custom Amazon EFS file system to a user profile or\n space for an Amazon SageMaker AI Domain.
" - } - }, - "com.amazonaws.sagemaker#EMRStepMetadata": { - "type": "structure", - "members": { - "ClusterId": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The identifier of the EMR cluster.
" - } - }, - "StepId": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The identifier of the EMR cluster step.
" - } - }, - "StepName": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The name of the EMR cluster step.
" - } - }, - "LogFilePath": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The path to the log file where the cluster step's failure root cause \n is recorded.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configurations and outcomes of an Amazon EMR step execution.
" - } - }, - "com.amazonaws.sagemaker#EbsStorageSettings": { - "type": "structure", - "members": { - "EbsVolumeSizeInGb": { - "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size of an EBS storage volume for a space.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of EBS storage settings that apply to both private and shared spaces.
" - } - }, - "com.amazonaws.sagemaker#Edge": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.
" - } - }, - "DestinationArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.
" - } - }, - "AssociationType": { - "target": "com.amazonaws.sagemaker#AssociationEdgeType", - "traits": { - "smithy.api#documentation": "The type of the Association(Edge) between the source and destination. For example ContributedTo, \n Produced, or DerivedFrom.
A directed edge connecting two lineage entities.
" - } - }, - "com.amazonaws.sagemaker#EdgeDeploymentConfig": { - "type": "structure", - "members": { - "FailureHandlingPolicy": { - "target": "com.amazonaws.sagemaker#FailureHandlingPolicy", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Toggle that determines whether to rollback to previous configuration if the current\n deployment fails. By default this is turned on. You may turn this off if you want to\n investigate the errors yourself.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the configuration of a deployment.
" - } - }, - "com.amazonaws.sagemaker#EdgeDeploymentModelConfig": { - "type": "structure", - "members": { - "ModelHandle": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name the device application uses to reference this model.
", - "smithy.api#required": {} - } - }, - "EdgePackagingJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The edge packaging job associated with this deployment.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the configuration of a model in a deployment.
" - } - }, - "com.amazonaws.sagemaker#EdgeDeploymentModelConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentModelConfig" - } - }, - "com.amazonaws.sagemaker#EdgeDeploymentPlanArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.sagemaker#EdgeDeploymentPlanSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanSummary" - } - }, - "com.amazonaws.sagemaker#EdgeDeploymentPlanSummary": { - "type": "structure", - "members": { - "EdgeDeploymentPlanArn": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the device fleet used for the deployment.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentSuccess": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of edge devices with the successful deployment.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentPending": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of edge devices yet to pick up the deployment, or in progress.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentFailed": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of edge devices that failed the deployment.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the edge deployment plan was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the edge deployment plan was last updated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information summarizing an edge deployment plan.
" - } - }, - "com.amazonaws.sagemaker#EdgeDeploymentStatus": { - "type": "structure", - "members": { - "StageStatus": { - "target": "com.amazonaws.sagemaker#StageStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The general status of the current stage.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentSuccessInStage": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of edge devices with the successful deployment in the current stage.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentPendingInStage": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of edge devices yet to pick up the deployment in current stage, or in\n progress.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentFailedInStage": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of edge devices that failed the deployment in current stage.
", - "smithy.api#required": {} - } - }, - "EdgeDeploymentStatusMessage": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "A detailed message about deployment status in current stage.
" - } - }, - "EdgeDeploymentStageStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the deployment API started.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information summarizing the deployment stage results.
" - } - }, - "com.amazonaws.sagemaker#EdgeModel": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model.
", - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.sagemaker#EdgeVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The model version.
", - "smithy.api#required": {} - } - }, - "LatestSampleTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of the last data sample taken.
" - } - }, - "LatestInference": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of the last inference that was made.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The model on the edge device.
" - } - }, - "com.amazonaws.sagemaker#EdgeModelStat": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model.
", - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.sagemaker#EdgeVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The model version.
", - "smithy.api#required": {} - } - }, - "OfflineDeviceCount": { - "target": "com.amazonaws.sagemaker#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of devices that have this model version and do not have a heart beat.
", - "smithy.api#required": {} - } - }, - "ConnectedDeviceCount": { - "target": "com.amazonaws.sagemaker#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of devices that have this model version and have a heart beat.
", - "smithy.api#required": {} - } - }, - "ActiveDeviceCount": { - "target": "com.amazonaws.sagemaker#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of devices that have this model version, a heart beat, and are currently running.
", - "smithy.api#required": {} - } - }, - "SamplingDeviceCount": { - "target": "com.amazonaws.sagemaker#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of devices with this model version and are producing sample data.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Status of edge devices with this model.
" - } - }, - "com.amazonaws.sagemaker#EdgeModelStats": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EdgeModelStat" - } - }, - "com.amazonaws.sagemaker#EdgeModelSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EdgeModelSummary" - } - }, - "com.amazonaws.sagemaker#EdgeModelSummary": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model.
", - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.sagemaker#EdgeVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Summary of model on edge device.
" - } - }, - "com.amazonaws.sagemaker#EdgeModels": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EdgeModel" - } - }, - "com.amazonaws.sagemaker#EdgeOutputConfig": { - "type": "structure", - "members": { - "S3OutputLocation": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Simple Storage (S3) bucker URI.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. \n If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.
" - } - }, - "PresetDeploymentType": { - "target": "com.amazonaws.sagemaker#EdgePresetDeploymentType", - "traits": { - "smithy.api#documentation": "The deployment type SageMaker Edge Manager will create. \n Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
" - } - }, - "PresetDeploymentConfig": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The configuration used to create deployment artifacts. \n Specify configuration options with a JSON string. The available configuration options for each type are:
\n\n ComponentName (optional) - Name of the GreenGrass V2 component. If not specified,\n the default name generated consists of \"SagemakerEdgeManager\" and the name of your SageMaker Edge Manager\n packaging job.
\n ComponentDescription (optional) - Description of the component.
\n ComponentVersion (optional) - The version of the component.
Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a\n major.minor.patch number system. For example, version 1.0.0 represents the first\n major release for a component. For more information, see the semantic version specification.
\n\n PlatformOS (optional) - The name of the operating system for the platform.\n Supported platforms include Windows and Linux.
\n PlatformArchitecture (optional) - The processor architecture for the platform.
Supported architectures Windows include: Windows32_x86, Windows64_x64.
\nSupported architectures for Linux include: Linux x86_64, Linux ARMV8.
\nThe output configuration.
" - } - }, - "com.amazonaws.sagemaker#EdgePackagingJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.sagemaker#EdgePackagingJobStatus": { - "type": "enum", - "members": { - "Starting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INPROGRESS" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "Stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.sagemaker#EdgePackagingJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EdgePackagingJobSummary" - } - }, - "com.amazonaws.sagemaker#EdgePackagingJobSummary": { - "type": "structure", - "members": { - "EdgePackagingJobArn": { - "target": "com.amazonaws.sagemaker#EdgePackagingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the edge packaging job.
", - "smithy.api#required": {} - } - }, - "EdgePackagingJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge packaging job.
", - "smithy.api#required": {} - } - }, - "EdgePackagingJobStatus": { - "target": "com.amazonaws.sagemaker#EdgePackagingJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the edge packaging job.
", - "smithy.api#required": {} - } - }, - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the SageMaker Neo compilation job.
" - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the model.
" - } - }, - "ModelVersion": { - "target": "com.amazonaws.sagemaker#EdgeVersion", - "traits": { - "smithy.api#documentation": "The version of the model.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the job was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the edge packaging job was last updated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summary of edge packaging job.
" - } - }, - "com.amazonaws.sagemaker#EdgePresetDeploymentArtifact": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.sagemaker#EdgePresetDeploymentOutput": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.sagemaker#EdgePresetDeploymentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The deployment type created by SageMaker Edge Manager. Currently only \n supports Amazon Web Services IoT Greengrass Version 2 components.
", - "smithy.api#required": {} - } - }, - "Artifact": { - "target": "com.amazonaws.sagemaker#EdgePresetDeploymentArtifact", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the generated deployable resource.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#EdgePresetDeploymentStatus", - "traits": { - "smithy.api#documentation": "The status of the deployable resource.
" - } - }, - "StatusMessage": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "Returns a message describing the status of the deployed resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output of a SageMaker Edge Manager deployable resource.
" - } - }, - "com.amazonaws.sagemaker#EdgePresetDeploymentStatus": { - "type": "enum", - "members": { - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.sagemaker#EdgePresetDeploymentType": { - "type": "enum", - "members": { - "GreengrassV2Component": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreengrassV2Component" - } - } - } - }, - "com.amazonaws.sagemaker#EdgeVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\ \\_\\.]+$" - } - }, - "com.amazonaws.sagemaker#Edges": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Edge" - } - }, - "com.amazonaws.sagemaker#EfsUid": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - }, - "smithy.api#pattern": "^\\d+$" - } - }, - "com.amazonaws.sagemaker#EksClusterArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:eks:[a-z0-9\\-]*:[0-9]{12}:cluster\\/[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}$" - } - }, - "com.amazonaws.sagemaker#EmrServerlessComputeConfig": { - "type": "structure", - "members": { - "ExecutionRoleARN": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the IAM role granting the AutoML job V2 the necessary\n permissions access policies to list, connect to, or manage EMR Serverless jobs. For\n detailed information about the required permissions of this role, see \"How to configure\n AutoML to initiate a remote job on EMR Serverless for large datasets\" in Create a regression or classification job for tabular data using the AutoML API\n or Create an AutoML job for time-series forecasting using the API.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in\n other contexts at the moment.
\nSpecifies the compute configuration for the EMR Serverless job.
" - } - }, - "com.amazonaws.sagemaker#EmrServerlessSettings": { - "type": "structure", - "members": { - "ExecutionRoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services IAM role that is assumed for\n running Amazon EMR Serverless jobs in SageMaker Canvas. This role should have the necessary\n permissions to read and write data attached and a trust relationship with\n EMR Serverless.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#FeatureStatus", - "traits": { - "smithy.api#documentation": "Describes whether Amazon EMR Serverless job capabilities are enabled or disabled in the SageMaker\n Canvas application.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The settings for running Amazon EMR Serverless jobs in SageMaker Canvas.
" - } - }, - "com.amazonaws.sagemaker#EmrSettings": { - "type": "structure", - "members": { - "AssumableRoleArns": { - "target": "com.amazonaws.sagemaker#AssumableRoleArns", - "traits": { - "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of\n SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR\n Serverless applications. These roles define the permissions and access policies required\n when performing Amazon EMR-related operations, such as listing, connecting to, or terminating\n Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in\n cross-account access scenarios, where the Amazon EMR resources (clusters or serverless\n applications) are located in a different Amazon Web Services account than the SageMaker\n domain.
" - } - }, - "ExecutionRoleArns": { - "target": "com.amazonaws.sagemaker#ExecutionRoleArns", - "traits": { - "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances\n or job execution environments to access other Amazon Web Services services and resources needed during the \n runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other\n Amazon Web Services services based on the particular workload requirements.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.
" - } - }, - "com.amazonaws.sagemaker#EnableCapture": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#EnableInfraCheck": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#EnableIotRoleAlias": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#EnableRemoteDebug": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolio": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioOutput" - }, - "traits": { - "smithy.api#documentation": "Enables using Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.
" - } - }, - "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioInput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#EnableSessionTagChaining": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#EnabledOrDisabled": { - "type": "enum", - "members": { - "Enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Enabled" - } - }, - "Disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - } - } - }, - "com.amazonaws.sagemaker#Endpoint": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint.
", - "smithy.api#required": {} - } - }, - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", - "smithy.api#required": {} - } - }, - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The endpoint configuration associated with the endpoint.
", - "smithy.api#required": {} - } - }, - "ProductionVariants": { - "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", - "traits": { - "smithy.api#documentation": "A list of the production variants hosted on the endpoint. Each production variant is a\n model.
" - } - }, - "DataCaptureConfig": { - "target": "com.amazonaws.sagemaker#DataCaptureConfigSummary" - }, - "EndpointStatus": { - "target": "com.amazonaws.sagemaker#EndpointStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the endpoint.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the endpoint failed, the reason it failed.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time that the endpoint was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The last time the endpoint was modified.
", - "smithy.api#required": {} - } - }, - "MonitoringSchedules": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleList", - "traits": { - "smithy.api#documentation": "A list of monitoring schedules for the endpoint. For information about model\n monitoring, see Amazon SageMaker Model Monitor.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" - } - }, - "ShadowProductionVariants": { - "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", - "traits": { - "smithy.api#documentation": "A list of the shadow variants hosted on the endpoint. Each shadow variant is a model\n in shadow mode with production traffic replicated from the production variant.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A hosted endpoint for real-time inference.
" - } - }, - "com.amazonaws.sagemaker#EndpointArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/" - } - }, - "com.amazonaws.sagemaker#EndpointConfigArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/" - } - }, - "com.amazonaws.sagemaker#EndpointConfigName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#EndpointConfigNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.sagemaker#EndpointConfigSortKey": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#EndpointConfigStepMetadata": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#EndpointConfigArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint configuration used in the step.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for an endpoint configuration step.
" - } - }, - "com.amazonaws.sagemaker#EndpointConfigSummary": { - "type": "structure", - "members": { - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint configuration.
", - "smithy.api#required": {} - } - }, - "EndpointConfigArn": { - "target": "com.amazonaws.sagemaker#EndpointConfigArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint configuration.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the endpoint configuration was created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Provides summary information for an endpoint configuration.
" - } - }, - "com.amazonaws.sagemaker#EndpointConfigSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EndpointConfigSummary" - } - }, - "com.amazonaws.sagemaker#EndpointInfo": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "The name of a customer's endpoint.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about a customer endpoint that was compared in an Inference Recommender job.
" - } - }, - "com.amazonaws.sagemaker#EndpointInput": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An endpoint in customer's account which has enabled DataCaptureConfig\n enabled.
Path to the filesystem where the endpoint data is available to the container.
", - "smithy.api#required": {} - } - }, - "S3InputMode": { - "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", - "traits": { - "smithy.api#documentation": "Whether the Pipe or File is used as the input mode for\n transferring data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an\n Amazon S3 key. Defaults to FullyReplicated\n
The attributes of the input data that are the input features.
" - } - }, - "InferenceAttribute": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The attribute of the input data that represents the ground truth label.
" - } - }, - "ProbabilityAttribute": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "In a classification problem, the attribute that represents the class probability.
" - } - }, - "ProbabilityThresholdAttribute": { - "target": "com.amazonaws.sagemaker#ProbabilityThresholdAttribute", - "traits": { - "smithy.api#documentation": "The threshold for the class probability to be evaluated as a positive result.
" - } - }, - "StartTimeOffset": { - "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", - "traits": { - "smithy.api#documentation": "If specified, monitoring jobs substract this time from the start time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" - } - }, - "EndTimeOffset": { - "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", - "traits": { - "smithy.api#documentation": "If specified, monitoring jobs substract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" - } - }, - "ExcludeFeaturesAttribute": { - "target": "com.amazonaws.sagemaker#ExcludeFeaturesAttribute", - "traits": { - "smithy.api#documentation": "The attributes of the input data to exclude from the analysis.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Input object for the endpoint
" - } - }, - "com.amazonaws.sagemaker#EndpointInputConfiguration": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", - "traits": { - "smithy.api#documentation": "The instance types to use for the load test.
" - } - }, - "ServerlessConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig" - }, - "InferenceSpecificationName": { - "target": "com.amazonaws.sagemaker#InferenceSpecificationName", - "traits": { - "smithy.api#documentation": "The inference specification name in the model package version.
" - } - }, - "EnvironmentParameterRanges": { - "target": "com.amazonaws.sagemaker#EnvironmentParameterRanges", - "traits": { - "smithy.api#documentation": "The parameter you want to benchmark against.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The endpoint configuration for the load test.
" - } - }, - "com.amazonaws.sagemaker#EndpointInputConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EndpointInputConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#EndpointMetadata": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint.
", - "smithy.api#required": {} - } - }, - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", - "traits": { - "smithy.api#documentation": "The name of the endpoint configuration.
" - } - }, - "EndpointStatus": { - "target": "com.amazonaws.sagemaker#EndpointStatus", - "traits": { - "smithy.api#documentation": "\n The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.\n
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "\n If the status of the endpoint is Failed, or the status is InService but update\n operation fails, this provides the reason why it failed.\n
The metadata of the endpoint.
" - } - }, - "com.amazonaws.sagemaker#EndpointName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#EndpointNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.sagemaker#EndpointOutputConfiguration": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint made during a recommendation job.
", - "smithy.api#required": {} - } - }, - "VariantName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the production variant (deployed model) made during a recommendation job.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", - "traits": { - "smithy.api#documentation": "The instance type recommended by Amazon SageMaker Inference Recommender.
" - } - }, - "InitialInstanceCount": { - "target": "com.amazonaws.sagemaker#InitialInstanceCount", - "traits": { - "smithy.api#documentation": "The number of instances recommended to launch initially.
" - } - }, - "ServerlessConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig" - } - }, - "traits": { - "smithy.api#documentation": "The endpoint configuration made by Inference Recommender during a recommendation job.
" - } - }, - "com.amazonaws.sagemaker#EndpointPerformance": { - "type": "structure", - "members": { - "Metrics": { - "target": "com.amazonaws.sagemaker#InferenceMetrics", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The metrics for an existing endpoint.
", - "smithy.api#required": {} - } - }, - "EndpointInfo": { - "target": "com.amazonaws.sagemaker#EndpointInfo", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The performance results from running an Inference Recommender job on an existing endpoint.
" - } - }, - "com.amazonaws.sagemaker#EndpointPerformances": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EndpointPerformance" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#EndpointSortKey": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "Status": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - } - } - }, - "com.amazonaws.sagemaker#EndpointStatus": { - "type": "enum", - "members": { - "OUT_OF_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OutOfService" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "SYSTEM_UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SystemUpdating" - } - }, - "ROLLING_BACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RollingBack" - } - }, - "IN_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "UPDATE_ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateRollbackFailed" - } - } - } - }, - "com.amazonaws.sagemaker#EndpointStepMetadata": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint in the step.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for an endpoint step.
" - } - }, - "com.amazonaws.sagemaker#EndpointSummary": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint.
", - "smithy.api#required": {} - } - }, - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the endpoint was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the endpoint was last modified.
", - "smithy.api#required": {} - } - }, - "EndpointStatus": { - "target": "com.amazonaws.sagemaker#EndpointStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about the\n failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
To get a list of endpoints with a specified status, use the StatusEquals\n filter with a call to ListEndpoints.
Provides summary information for an endpoint.
" - } - }, - "com.amazonaws.sagemaker#EndpointSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EndpointSummary" - } - }, - "com.amazonaws.sagemaker#Endpoints": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EndpointInfo" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#EntityDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" - } - }, - "com.amazonaws.sagemaker#EntityName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#EnvironmentKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" - } - }, - "com.amazonaws.sagemaker#EnvironmentMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#EnvironmentKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#EnvironmentValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#EnvironmentParameter": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The environment key suggested by the Amazon SageMaker Inference Recommender.
", - "smithy.api#required": {} - } - }, - "ValueType": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The value type suggested by the Amazon SageMaker Inference Recommender.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The value suggested by the Amazon SageMaker Inference Recommender.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.
" - } - }, - "com.amazonaws.sagemaker#EnvironmentParameterRanges": { - "type": "structure", - "members": { - "CategoricalParameterRanges": { - "target": "com.amazonaws.sagemaker#CategoricalParameters", - "traits": { - "smithy.api#documentation": "Specified a list of parameters for each category.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the range of environment parameters
" - } - }, - "com.amazonaws.sagemaker#EnvironmentParameters": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#EnvironmentParameter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#EnvironmentValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[\\S\\s]*$" - } - }, - "com.amazonaws.sagemaker#ErrorInfo": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.sagemaker#NonEmptyString64", - "traits": { - "smithy.api#documentation": "The error code for an invalid or failed operation.
" - } - }, - "Reason": { - "target": "com.amazonaws.sagemaker#NonEmptyString256", - "traits": { - "smithy.api#documentation": "The failure reason for the operation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This is an error field object that contains the error code and the reason for an operation failure.
" - } - }, - "com.amazonaws.sagemaker#ExcludeFeaturesAttribute": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#ExecutionRoleArns": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#RoleArn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#ExecutionRoleIdentityConfig": { - "type": "enum", - "members": { - "USER_PROFILE_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER_PROFILE_NAME" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.sagemaker#ExecutionStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "COMPLETED_WITH_VIOLATIONS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CompletedWithViolations" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#ExitMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[\\S\\s]*$" - } - }, - "com.amazonaws.sagemaker#Experiment": { - "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment.
" - } - }, - "ExperimentArn": { - "target": "com.amazonaws.sagemaker#ExperimentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.
The description of the experiment.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the experiment was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who created the experiment.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the experiment was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "The list of tags that are associated with the experiment. You can use Search API to search on the tags.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The properties of an experiment as returned by the Search API.
" - } - }, - "com.amazonaws.sagemaker#ExperimentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/" - } - }, - "com.amazonaws.sagemaker#ExperimentConfig": { - "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of an existing experiment to associate with the trial component.
" - } - }, - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of an existing trial to associate the trial component with. If not specified, a\n new trial is created.
" - } - }, - "TrialComponentDisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The display name for the trial component. If this key isn't specified, the display name is\n the trial component name.
" - } - }, - "RunName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment run to associate with the trial component.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Associates a SageMaker job as a trial component with an experiment and trial. Specified when\n you call the following APIs:
\n\n CreateProcessingJob\n
\n\n CreateTrainingJob\n
\n\n CreateTransformJob\n
\nThe Amazon Resource Name (ARN) of the source.
", - "smithy.api#required": {} - } - }, - "SourceType": { - "target": "com.amazonaws.sagemaker#SourceType", - "traits": { - "smithy.api#documentation": "The source type.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The source of the experiment.
" - } - }, - "com.amazonaws.sagemaker#ExperimentSourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:" - } - }, - "com.amazonaws.sagemaker#ExperimentSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ExperimentSummary" - } - }, - "com.amazonaws.sagemaker#ExperimentSummary": { - "type": "structure", - "members": { - "ExperimentArn": { - "target": "com.amazonaws.sagemaker#ExperimentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" - } - }, - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.
When the experiment was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the experiment was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of the properties of an experiment. To get the complete set of properties, call\n the DescribeExperiment API and provide the\n ExperimentName.
The explainability report for a model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains explainability metrics for a model.
" - } - }, - "com.amazonaws.sagemaker#ExplainabilityLocation": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#ExplainerConfig": { - "type": "structure", - "members": { - "ClarifyExplainerConfig": { - "target": "com.amazonaws.sagemaker#ClarifyExplainerConfig", - "traits": { - "smithy.api#documentation": "A member of ExplainerConfig that contains configuration parameters for\n the SageMaker Clarify explainer.
A parameter to activate explainers.
" - } - }, - "com.amazonaws.sagemaker#FSxLustreFileSystem": { - "type": "structure", - "members": { - "FileSystemId": { - "target": "com.amazonaws.sagemaker#FileSystemId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Amazon FSx for Lustre file system ID.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A custom file system in Amazon FSx for Lustre.
" - } - }, - "com.amazonaws.sagemaker#FSxLustreFileSystemConfig": { - "type": "structure", - "members": { - "FileSystemId": { - "target": "com.amazonaws.sagemaker#FileSystemId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.
", - "smithy.api#required": {} - } - }, - "FileSystemPath": { - "target": "com.amazonaws.sagemaker#FileSystemPath", - "traits": { - "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted\n users can access only this directory and below.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an\n Amazon SageMaker Domain.
" - } - }, - "com.amazonaws.sagemaker#FailStepMetadata": { - "type": "structure", - "members": { - "ErrorMessage": { - "target": "com.amazonaws.sagemaker#String3072", - "traits": { - "smithy.api#documentation": "A message that you define and then is processed and rendered by \n the Fail step when the error occurs.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The container for the metadata for Fail step.
" - } - }, - "com.amazonaws.sagemaker#FailureHandlingPolicy": { - "type": "enum", - "members": { - "RollbackOnFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_ON_FAILURE" - } - }, - "DoNothing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO_NOTHING" - } - } - } - }, - "com.amazonaws.sagemaker#FailureReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.sagemaker#FairShare": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - } - } - }, - "com.amazonaws.sagemaker#FairShareWeight": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#FeatureAdditions": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#FeatureDefinition" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#FeatureDefinition": { - "type": "structure", - "members": { - "FeatureName": { - "target": "com.amazonaws.sagemaker#FeatureName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a feature. The type must be a string. FeatureName cannot be any\n of the following: is_deleted, write_time,\n api_invocation_time.
The name:
\nMust start with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe value type of a feature. Valid values are Integral, Fractional, or String.
", - "smithy.api#required": {} - } - }, - "CollectionType": { - "target": "com.amazonaws.sagemaker#CollectionType", - "traits": { - "smithy.api#documentation": "A grouping of elements where each element within the collection must have the same\n feature type (String, Integral, or\n Fractional).
\n List: An ordered collection of elements.
\n Set: An unordered collection of unique elements.
\n Vector: A specialized list that represents a fixed-size array of\n elements. The vector dimension is determined by you. Must have elements with\n fractional feature types.
Configuration for your collection.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A list of features. You must include FeatureName and\n FeatureType. Valid feature FeatureTypes are\n Integral, Fractional and String.
The Amazon Resource Name (ARN) of a FeatureGroup.
The name of the FeatureGroup.
The name of the Feature whose value uniquely identifies a\n Record defined in the FeatureGroup\n FeatureDefinitions.
The name of the feature that stores the EventTime of a Record in a\n FeatureGroup.
A EventTime is point in time when a new event occurs that corresponds to\n the creation or update of a Record in FeatureGroup. All\n Records in the FeatureGroup must have a corresponding\n EventTime.
A list of Features. Each Feature must include a\n FeatureName and a FeatureType.
Valid FeatureTypes are Integral, Fractional and\n String.
\n FeatureNames cannot be any of the following: is_deleted,\n write_time, api_invocation_time.
You can create up to 2,500 FeatureDefinitions per\n FeatureGroup.
The time a FeatureGroup was created.
A timestamp indicating the last time you updated the feature group.
" - } - }, - "OnlineStoreConfig": { - "target": "com.amazonaws.sagemaker#OnlineStoreConfig" - }, - "OfflineStoreConfig": { - "target": "com.amazonaws.sagemaker#OfflineStoreConfig" - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to create the feature\n group.
" - } - }, - "FeatureGroupStatus": { - "target": "com.amazonaws.sagemaker#FeatureGroupStatus", - "traits": { - "smithy.api#documentation": "A FeatureGroup status.
A value that indicates whether the feature group was updated successfully.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The reason that the FeatureGroup failed to be replicated in the\n OfflineStore. This is failure may be due to a failure to create a\n FeatureGroup in or delete a FeatureGroup from the\n OfflineStore.
A free form description of a FeatureGroup.
Tags used to define a FeatureGroup.
Amazon SageMaker Feature Store stores features in a collection called Feature Group. A\n Feature Group can be visualized as a table which has rows, with a unique identifier for\n each row where each column in the table is a feature. In principle, a Feature Group is\n composed of features and values per features.
" - } - }, - "com.amazonaws.sagemaker#FeatureGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/" - } - }, - "com.amazonaws.sagemaker#FeatureGroupMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#FeatureGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}$" - } - }, - "com.amazonaws.sagemaker#FeatureGroupNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.sagemaker#FeatureGroupNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})$" - } - }, - "com.amazonaws.sagemaker#FeatureGroupSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "FEATURE_GROUP_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FeatureGroupStatus" - } - }, - "OFFLINE_STORE_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OfflineStoreStatus" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#FeatureGroupSortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.sagemaker#FeatureGroupStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Created" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateFailed" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteFailed" - } - } - } - }, - "com.amazonaws.sagemaker#FeatureGroupSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#FeatureGroupSummary" - } - }, - "com.amazonaws.sagemaker#FeatureGroupSummary": { - "type": "structure", - "members": { - "FeatureGroupName": { - "target": "com.amazonaws.sagemaker#FeatureGroupName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of FeatureGroup.
Unique identifier for the FeatureGroup.
A timestamp indicating the time of creation time of the\n FeatureGroup.
The status of a FeatureGroup. The status can be any of the following:\n Creating, Created, CreateFail,\n Deleting or DetailFail.
Notifies you if replicating data into the OfflineStore has failed. Returns\n either: Active or Blocked.
The name, ARN, CreationTime, FeatureGroup values,\n LastUpdatedTime and EnableOnlineStorage status of a\n FeatureGroup.
The Amazon Resource Number (ARN) of the feature group.
" - } - }, - "FeatureGroupName": { - "target": "com.amazonaws.sagemaker#FeatureGroupName", - "traits": { - "smithy.api#documentation": "The name of the feature group containing the feature.
" - } - }, - "FeatureName": { - "target": "com.amazonaws.sagemaker#FeatureName", - "traits": { - "smithy.api#documentation": "The name of feature.
" - } - }, - "FeatureType": { - "target": "com.amazonaws.sagemaker#FeatureType", - "traits": { - "smithy.api#documentation": "The data type of the feature.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A timestamp indicating when the feature was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A timestamp indicating when the feature was last modified.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#FeatureDescription", - "traits": { - "smithy.api#documentation": "An optional description that you specify to better describe the feature.
" - } - }, - "Parameters": { - "target": "com.amazonaws.sagemaker#FeatureParameters", - "traits": { - "smithy.api#documentation": "Optional key-value pairs that you specify to better describe the feature.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The metadata for a feature. It can either be metadata that you specify, or metadata that\n is updated automatically.
" - } - }, - "com.amazonaws.sagemaker#FeatureName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}$" - } - }, - "com.amazonaws.sagemaker#FeatureParameter": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.sagemaker#FeatureParameterKey", - "traits": { - "smithy.api#documentation": "A key that must contain a value to describe the feature.
" - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#FeatureParameterValue", - "traits": { - "smithy.api#documentation": "The value that belongs to a key.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A key-value pair that you specify to describe the feature.
" - } - }, - "com.amazonaws.sagemaker#FeatureParameterAdditions": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#FeatureParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.sagemaker#FeatureParameterKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$" - } - }, - "com.amazonaws.sagemaker#FeatureParameterRemovals": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#FeatureParameterKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.sagemaker#FeatureParameterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$" - } - }, - "com.amazonaws.sagemaker#FeatureParameters": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#FeatureParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.sagemaker#FeatureStatus": { - "type": "enum", - "members": { - "Enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "Disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.sagemaker#FeatureType": { - "type": "enum", - "members": { - "INTEGRAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Integral" - } - }, - "FRACTIONAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Fractional" - } - }, - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "String" - } - } - } - }, - "com.amazonaws.sagemaker#FileSource": { - "type": "structure", - "members": { - "ContentType": { - "target": "com.amazonaws.sagemaker#ContentType", - "traits": { - "smithy.api#documentation": "The type of content stored in the file source.
" - } - }, - "ContentDigest": { - "target": "com.amazonaws.sagemaker#ContentDigest", - "traits": { - "smithy.api#documentation": "The digest of the file source.
" - } - }, - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 URI for the file source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details regarding the file source.
" - } - }, - "com.amazonaws.sagemaker#FileSystemAccessMode": { - "type": "enum", - "members": { - "RW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rw" - } - }, - "RO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ro" - } - } - } - }, - "com.amazonaws.sagemaker#FileSystemConfig": { - "type": "structure", - "members": { - "MountPath": { - "target": "com.amazonaws.sagemaker#MountPath", - "traits": { - "smithy.api#documentation": "The path within the image to mount the user's EFS home directory. The directory\n should be empty. If not specified, defaults to /home/sagemaker-user.
" - } - }, - "DefaultUid": { - "target": "com.amazonaws.sagemaker#DefaultUid", - "traits": { - "smithy.api#documentation": "The default POSIX user ID (UID). If not specified, defaults to 1000.
The default POSIX group ID (GID). If not specified, defaults to 100.
The Amazon Elastic File System storage configuration for a SageMaker AI image.
" - } - }, - "com.amazonaws.sagemaker#FileSystemDataSource": { - "type": "structure", - "members": { - "FileSystemId": { - "target": "com.amazonaws.sagemaker#FileSystemId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The file system id.
", - "smithy.api#required": {} - } - }, - "FileSystemAccessMode": { - "target": "com.amazonaws.sagemaker#FileSystemAccessMode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The access mode of the mount of the directory associated with the channel. A directory\n can be mounted either in ro (read-only) or rw (read-write)\n mode.
The file system type.
", - "smithy.api#required": {} - } - }, - "DirectoryPath": { - "target": "com.amazonaws.sagemaker#DirectoryPath", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The full path to the directory to associate with the channel.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a file system data source for a channel.
" - } - }, - "com.amazonaws.sagemaker#FileSystemId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 11, - "max": 21 - }, - "smithy.api#pattern": "^(fs-[0-9a-f]{8,})$" - } - }, - "com.amazonaws.sagemaker#FileSystemPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^\\/\\S*$" - } - }, - "com.amazonaws.sagemaker#FileSystemType": { - "type": "enum", - "members": { - "EFS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EFS" - } - }, - "FSXLUSTRE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FSxLustre" - } - } - } - }, - "com.amazonaws.sagemaker#FillingTransformationMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#FillingType" - }, - "value": { - "target": "com.amazonaws.sagemaker#FillingTransformationValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6 - } - } - }, - "com.amazonaws.sagemaker#FillingTransformationValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-]+$" - } - }, - "com.amazonaws.sagemaker#FillingTransformations": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#TransformationAttributeName" - }, - "value": { - "target": "com.amazonaws.sagemaker#FillingTransformationMap" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#FillingType": { - "type": "enum", - "members": { - "Frontfill": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "frontfill" - } - }, - "Middlefill": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "middlefill" - } - }, - "Backfill": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "backfill" - } - }, - "Futurefill": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "futurefill" - } - }, - "FrontfillValue": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "frontfill_value" - } - }, - "MiddlefillValue": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "middlefill_value" - } - }, - "BackfillValue": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "backfill_value" - } - }, - "FuturefillValue": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "futurefill_value" - } - } - } - }, - "com.amazonaws.sagemaker#Filter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#ResourcePropertyName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A resource property name. For example, TrainingJobName. For\n valid property names, see SearchRecord.\n You must specify a valid property for the resource.
A Boolean binary operator that is used to evaluate the filter. The operator field\n contains one of the following values:
\nThe value of Name equals Value.
The value of Name doesn't equal Value.
The Name property exists.
The Name property does not exist.
The value of Name is greater than Value.\n Not supported for text properties.
The value of Name is greater than or equal to Value.\n Not supported for text properties.
The value of Name is less than Value.\n Not supported for text properties.
The value of Name is less than or equal to Value.\n Not supported for text properties.
The value of Name is one of the comma delimited strings in\n Value. Only supported for text properties.
The value of Name contains the string Value.\n Only supported for text properties.
A SearchExpression can include the Contains operator\n multiple times when the value of Name is one of the following:
\n Experiment.DisplayName\n
\n Experiment.ExperimentName\n
\n Experiment.Tags\n
\n Trial.DisplayName\n
\n Trial.TrialName\n
\n Trial.Tags\n
\n TrialComponent.DisplayName\n
\n TrialComponent.TrialComponentName\n
\n TrialComponent.Tags\n
\n TrialComponent.InputArtifacts\n
\n TrialComponent.OutputArtifacts\n
A SearchExpression can include only one Contains operator\n for all other values of Name. In these cases, if you include multiple\n Contains operators in the SearchExpression, the result is\n the following error message: \"'CONTAINS' operator usage limit of 1\n exceeded.\"
A value used with Name and Operator to determine which\n resources satisfy the filter's condition. For numerical properties, Value\n must be an integer or floating-point decimal. For timestamp properties,\n Value must be an ISO 8601 date-time string of the following format:\n YYYY-mm-dd'T'HH:MM:SS.
A conditional statement for a search expression that includes a resource property, a\n Boolean operator, and a value. Resources that match the statement are returned in the\n results from the Search API.
\nIf you specify a Value, but not an Operator, SageMaker uses the\n equals operator.
In search, there are several property types:
\nTo define a metric filter, enter a value using the form\n \"Metrics., where \"accuracy\" metric greater than\n \"0.9\":
\n {\n
\n \"Name\": \"Metrics.accuracy\",\n
\n \"Operator\": \"GreaterThan\",\n
\n \"Value\": \"0.9\"\n
\n }\n
To define a hyperparameter filter, enter a value with the form\n \"HyperParameters.. Decimal hyperparameter\n values are treated as a decimal in a comparison if the specified\n Value is also a decimal value. If the specified\n Value is an integer, the decimal hyperparameter values are\n treated as integers. For example, the following filter is satisfied by\n training jobs with a \"learning_rate\" hyperparameter that is\n less than \"0.5\":
\n {\n
\n \"Name\": \"HyperParameters.learning_rate\",\n
\n \"Operator\": \"LessThan\",\n
\n \"Value\": \"0.5\"\n
\n }\n
To define a tag filter, enter a value with the form\n Tags..
The type of metric with the best result.
" - } - }, - "MetricName": { - "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the metric with the best result. For a description of the possible objective\n metrics, see AutoMLJobObjective$MetricName.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#MetricValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The value of the metric with the best result.
", - "smithy.api#required": {} - } - }, - "StandardMetricName": { - "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", - "traits": { - "smithy.api#documentation": "The name of the standard metric. For a description of the standard metrics, see Autopilot\n candidate metrics.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The best candidate result from an AutoML training job.
" - } - }, - "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", - "traits": { - "smithy.api#documentation": "Select if you want to minimize or maximize the objective metric during hyperparameter\n tuning.
" - } - }, - "MetricName": { - "target": "com.amazonaws.sagemaker#MetricName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the objective metric. For SageMaker built-in algorithms, metrics are defined\n per algorithm. See the metrics for XGBoost as an\n example. You can also use a custom algorithm for training and define your own metrics.\n For more information, see Define metrics and environment variables.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#MetricValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The value of the objective metric.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Shows the latest objective metric emitted by a training job that was launched by a\n hyperparameter tuning job. You define the objective metric in the\n HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
The Amazon S3 path where the object containing human output will be made available.
\nTo learn more about the format of Amazon A2I output data, see Amazon A2I\n Output Data.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Key Management Service (KMS) key ID for server-side encryption.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about where human output will be stored.
" - } - }, - "com.amazonaws.sagemaker#FlowDefinitionStatus": { - "type": "enum", - "members": { - "INITIALIZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Initializing" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.sagemaker#FlowDefinitionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#FlowDefinitionSummary" - } - }, - "com.amazonaws.sagemaker#FlowDefinitionSummary": { - "type": "structure", - "members": { - "FlowDefinitionName": { - "target": "com.amazonaws.sagemaker#FlowDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the flow definition.
", - "smithy.api#required": {} - } - }, - "FlowDefinitionArn": { - "target": "com.amazonaws.sagemaker#FlowDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow definition.
", - "smithy.api#required": {} - } - }, - "FlowDefinitionStatus": { - "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the flow definition. Valid values:
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The timestamp when SageMaker created the flow definition.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
Contains summary information about the flow definition.
" - } - }, - "com.amazonaws.sagemaker#FlowDefinitionTaskAvailabilityLifetimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#FlowDefinitionTaskCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 3 - } - } - }, - "com.amazonaws.sagemaker#FlowDefinitionTaskDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.sagemaker#FlowDefinitionTaskKeyword": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - }, - "smithy.api#pattern": "^[A-Za-z0-9]+( [A-Za-z0-9]+)*$" - } - }, - "com.amazonaws.sagemaker#FlowDefinitionTaskKeywords": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#FlowDefinitionTaskKeyword" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#FlowDefinitionTaskTimeLimitInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 30 - } - } - }, - "com.amazonaws.sagemaker#FlowDefinitionTaskTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$" - } - }, - "com.amazonaws.sagemaker#ForecastFrequency": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - }, - "smithy.api#pattern": "^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$" - } - }, - "com.amazonaws.sagemaker#ForecastHorizon": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#ForecastQuantile": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 4 - }, - "smithy.api#pattern": "^(^p[1-9]\\d?$)$" - } - }, - "com.amazonaws.sagemaker#ForecastQuantiles": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ForecastQuantile" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#Framework": { - "type": "enum", - "members": { - "TENSORFLOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TENSORFLOW" - } - }, - "KERAS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KERAS" - } - }, - "MXNET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MXNET" - } - }, - "ONNX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONNX" - } - }, - "PYTORCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PYTORCH" - } - }, - "XGBOOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "XGBOOST" - } - }, - "TFLITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TFLITE" - } - }, - "DARKNET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DARKNET" - } - }, - "SKLEARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKLEARN" - } - } - } - }, - "com.amazonaws.sagemaker#FrameworkVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 10 - }, - "smithy.api#pattern": "^[0-9]\\.[A-Za-z0-9.]+$" - } - }, - "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#GenerativeAiSettings": { - "type": "structure", - "members": { - "AmazonBedrockRoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in\n Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that\n establishes bedrock.amazonaws.com as a service principal.
The generative AI settings for the SageMaker Canvas application.
\nConfigure these settings for Canvas users starting chats with generative AI foundation models.\n For more information, see \n Use generative AI with foundation models.
" - } - }, - "com.amazonaws.sagemaker#GetDeviceFleetReport": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#GetDeviceFleetReportRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#GetDeviceFleetReportResponse" - }, - "traits": { - "smithy.api#documentation": "Describes a fleet.
" - } - }, - "com.amazonaws.sagemaker#GetDeviceFleetReportRequest": { - "type": "structure", - "members": { - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#GetDeviceFleetReportResponse": { - "type": "structure", - "members": { - "DeviceFleetArn": { - "target": "com.amazonaws.sagemaker#DeviceFleetArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the device.
", - "smithy.api#required": {} - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#EdgeOutputConfig", - "traits": { - "smithy.api#documentation": "The output configuration for storing sample data collected by the fleet.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#DeviceFleetDescription", - "traits": { - "smithy.api#documentation": "Description of the fleet.
" - } - }, - "ReportGenerated": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Timestamp of when the report was generated.
" - } - }, - "DeviceStats": { - "target": "com.amazonaws.sagemaker#DeviceStats", - "traits": { - "smithy.api#documentation": "Status of devices.
" - } - }, - "AgentVersions": { - "target": "com.amazonaws.sagemaker#AgentVersions", - "traits": { - "smithy.api#documentation": "The versions of Edge Manager agent deployed on the fleet.
" - } - }, - "ModelStats": { - "target": "com.amazonaws.sagemaker#EdgeModelStats", - "traits": { - "smithy.api#documentation": "Status of model on device.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#GetLineageGroupPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#GetLineageGroupPolicyRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#GetLineageGroupPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "The resource policy for the lineage group.
" - } - }, - "com.amazonaws.sagemaker#GetLineageGroupPolicyRequest": { - "type": "structure", - "members": { - "LineageGroupName": { - "target": "com.amazonaws.sagemaker#LineageGroupNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the lineage group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#GetLineageGroupPolicyResponse": { - "type": "structure", - "members": { - "LineageGroupArn": { - "target": "com.amazonaws.sagemaker#LineageGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" - } - }, - "ResourcePolicy": { - "target": "com.amazonaws.sagemaker#ResourcePolicyString", - "traits": { - "smithy.api#documentation": "The resource policy that gives access to the lineage group in another account.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#GetModelPackageGroupPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicyInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicyOutput" - }, - "traits": { - "smithy.api#documentation": "Gets a resource policy that manages access for a model group. For information about\n resource policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and\n Access Management User Guide..
" - } - }, - "com.amazonaws.sagemaker#GetModelPackageGroupPolicyInput": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model group for which to get the resource policy.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#GetModelPackageGroupPolicyOutput": { - "type": "structure", - "members": { - "ResourcePolicy": { - "target": "com.amazonaws.sagemaker#PolicyString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The resource policy for the model group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusOutput" - }, - "traits": { - "smithy.api#documentation": "Gets the status of Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.
" - } - }, - "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusInput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusOutput": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#SagemakerServicecatalogStatus", - "traits": { - "smithy.api#documentation": "Whether Service Catalog is enabled or disabled in SageMaker.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#GetScalingConfigurationRecommendation": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies\n that you can apply to your SageMaker endpoint.
" - } - }, - "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationRequest": { - "type": "structure", - "members": { - "InferenceRecommendationsJobName": { - "target": "com.amazonaws.sagemaker#RecommendationJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a previously completed Inference Recommender job.
", - "smithy.api#required": {} - } - }, - "RecommendationId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The recommendation ID of a previously completed inference recommendation. This ID should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the EndpointName field.
The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the RecommendationId field.
The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.
" - } - }, - "ScalingPolicyObjective": { - "target": "com.amazonaws.sagemaker#ScalingPolicyObjective", - "traits": { - "smithy.api#documentation": "An object where you specify the anticipated traffic pattern for an endpoint.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationResponse": { - "type": "structure", - "members": { - "InferenceRecommendationsJobName": { - "target": "com.amazonaws.sagemaker#RecommendationJobName", - "traits": { - "smithy.api#documentation": "The name of a previously completed Inference Recommender job.
" - } - }, - "RecommendationId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The recommendation ID of a previously completed inference recommendation.
" - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "The name of an endpoint benchmarked during a previously completed Inference Recommender job.
" - } - }, - "TargetCpuUtilizationPerCore": { - "target": "com.amazonaws.sagemaker#UtilizationPercentagePerCore", - "traits": { - "smithy.api#documentation": "The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.
" - } - }, - "ScalingPolicyObjective": { - "target": "com.amazonaws.sagemaker#ScalingPolicyObjective", - "traits": { - "smithy.api#documentation": "An object representing the anticipated traffic pattern for an endpoint that you specified in the request.
" - } - }, - "Metric": { - "target": "com.amazonaws.sagemaker#ScalingPolicyMetric", - "traits": { - "smithy.api#documentation": "An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.
" - } - }, - "DynamicScalingConfiguration": { - "target": "com.amazonaws.sagemaker#DynamicScalingConfiguration", - "traits": { - "smithy.api#documentation": "An object with the recommended values for you to specify when creating an autoscaling policy.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#GetSearchSuggestions": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#GetSearchSuggestionsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#GetSearchSuggestionsResponse" - }, - "traits": { - "smithy.api#documentation": "An auto-complete API for the search functionality in the SageMaker console. It returns\n suggestions of possible matches for the property name to use in Search\n queries. Provides suggestions for HyperParameters, Tags, and\n Metrics.
The name of the SageMaker resource to search for.
", - "smithy.api#required": {} - } - }, - "SuggestionQuery": { - "target": "com.amazonaws.sagemaker#SuggestionQuery", - "traits": { - "smithy.api#documentation": "Limits the property names that are included in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#GetSearchSuggestionsResponse": { - "type": "structure", - "members": { - "PropertyNameSuggestions": { - "target": "com.amazonaws.sagemaker#PropertyNameSuggestionList", - "traits": { - "smithy.api#documentation": "A list of property names for a Resource that match a\n SuggestionQuery.
The URL where the Git repository is located.
", - "smithy.api#required": {} - } - }, - "Branch": { - "target": "com.amazonaws.sagemaker#Branch", - "traits": { - "smithy.api#documentation": "The default branch for the Git repository.
" - } - }, - "SecretArn": { - "target": "com.amazonaws.sagemaker#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:
\n {\"username\": UserName, \"password\":\n Password}\n
Specifies configuration details for a Git repository in your Amazon Web Services\n account.
" - } - }, - "com.amazonaws.sagemaker#GitConfigForUpdate": { - "type": "structure", - "members": { - "SecretArn": { - "target": "com.amazonaws.sagemaker#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:
\n {\"username\": UserName, \"password\":\n Password}\n
Specifies configuration details for a Git repository when the repository is\n updated.
" - } - }, - "com.amazonaws.sagemaker#GitConfigUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 11, - "max": 1024 - }, - "smithy.api#pattern": "^https://([^/]+)/?.{3,1016}$" - } - }, - "com.amazonaws.sagemaker#Group": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" - } - }, - "com.amazonaws.sagemaker#GroupingAttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#GroupingAttributeNames": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#GroupingAttributeName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#Groups": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Group" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#HiddenAppTypesList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AppType" - } - }, - "com.amazonaws.sagemaker#HiddenInstanceTypesList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AppInstanceType" - } - }, - "com.amazonaws.sagemaker#HiddenMlToolsList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MlTools" - } - }, - "com.amazonaws.sagemaker#HiddenSageMakerImage": { - "type": "structure", - "members": { - "SageMakerImageName": { - "target": "com.amazonaws.sagemaker#SageMakerImageName", - "traits": { - "smithy.api#documentation": "The SageMaker image name that you are hiding from the Studio user interface.
" - } - }, - "VersionAliases": { - "target": "com.amazonaws.sagemaker#VersionAliasesList", - "traits": { - "smithy.api#documentation": "The version aliases you are hiding from the Studio user interface.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker\n image name and version aliases.
" - } - }, - "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HiddenSageMakerImage" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#HolidayConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HolidayConfigAttributes" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#HolidayConfigAttributes": { - "type": "structure", - "members": { - "CountryCode": { - "target": "com.amazonaws.sagemaker#CountryCode", - "traits": { - "smithy.api#documentation": "The country code for the holiday calendar.
\nFor the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your\n choice.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Stores the holiday featurization attributes applicable to each item of time-series\n datasets during the training of a forecasting model. This allows the model to identify\n patterns associated with specific holidays.
" - } - }, - "com.amazonaws.sagemaker#HookParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#ConfigKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#ConfigValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#Horovod": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#HubArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#HubContentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#HubContentDependency": { - "type": "structure", - "members": { - "DependencyOriginPath": { - "target": "com.amazonaws.sagemaker#DependencyOriginPath", - "traits": { - "smithy.api#documentation": "The hub content dependency origin path.
" - } - }, - "DependencyCopyPath": { - "target": "com.amazonaws.sagemaker#DependencyCopyPath", - "traits": { - "smithy.api#documentation": "The hub content dependency copy path.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.
" - } - }, - "com.amazonaws.sagemaker#HubContentDependencyList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HubContentDependency" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#HubContentDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1023 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#HubContentDisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#HubContentDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 65535 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#HubContentInfo": { - "type": "structure", - "members": { - "HubContentName": { - "target": "com.amazonaws.sagemaker#HubContentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub content.
", - "smithy.api#required": {} - } - }, - "HubContentArn": { - "target": "com.amazonaws.sagemaker#HubContentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub content.
", - "smithy.api#required": {} - } - }, - "SageMakerPublicHubContentArn": { - "target": "com.amazonaws.sagemaker#SageMakerPublicHubContentArn", - "traits": { - "smithy.api#documentation": "The ARN of the public hub content.
" - } - }, - "HubContentVersion": { - "target": "com.amazonaws.sagemaker#HubContentVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the hub content.
", - "smithy.api#required": {} - } - }, - "HubContentType": { - "target": "com.amazonaws.sagemaker#HubContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of hub content.
", - "smithy.api#required": {} - } - }, - "DocumentSchemaVersion": { - "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the hub content document schema.
", - "smithy.api#required": {} - } - }, - "HubContentDisplayName": { - "target": "com.amazonaws.sagemaker#HubContentDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the hub content.
" - } - }, - "HubContentDescription": { - "target": "com.amazonaws.sagemaker#HubContentDescription", - "traits": { - "smithy.api#documentation": "A description of the hub content.
" - } - }, - "SupportStatus": { - "target": "com.amazonaws.sagemaker#HubContentSupportStatus", - "traits": { - "smithy.api#documentation": "The support status of the hub content.
" - } - }, - "HubContentSearchKeywords": { - "target": "com.amazonaws.sagemaker#HubContentSearchKeywordList", - "traits": { - "smithy.api#documentation": "The searchable keywords for the hub content.
" - } - }, - "HubContentStatus": { - "target": "com.amazonaws.sagemaker#HubContentStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the hub content.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the hub content was created.
", - "smithy.api#required": {} - } - }, - "OriginalCreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time when the hub content was originally created, before any updates or revisions.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about hub content.
" - } - }, - "com.amazonaws.sagemaker#HubContentInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HubContentInfo" - } - }, - "com.amazonaws.sagemaker#HubContentMarkdown": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.sagemaker#HubContentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#HubContentSearchKeywordList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HubSearchKeyword" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#HubContentSortBy": { - "type": "enum", - "members": { - "HUB_CONTENT_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HubContentName" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "HUB_CONTENT_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HubContentStatus" - } - } - } - }, - "com.amazonaws.sagemaker#HubContentStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Available" - } - }, - "IMPORTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Importing" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "IMPORT_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ImportFailed" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteFailed" - } - } - } - }, - "com.amazonaws.sagemaker#HubContentSupportStatus": { - "type": "enum", - "members": { - "SUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Supported" - } - }, - "DEPRECATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deprecated" - } - } - } - }, - "com.amazonaws.sagemaker#HubContentType": { - "type": "enum", - "members": { - "MODEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Model" - } - }, - "NOTEBOOK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Notebook" - } - }, - "MODEL_REFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelReference" - } - } - } - }, - "com.amazonaws.sagemaker#HubContentVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 14 - }, - "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" - } - }, - "com.amazonaws.sagemaker#HubDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1023 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#HubDisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#HubInfo": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub.
", - "smithy.api#required": {} - } - }, - "HubArn": { - "target": "com.amazonaws.sagemaker#HubArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub.
", - "smithy.api#required": {} - } - }, - "HubDisplayName": { - "target": "com.amazonaws.sagemaker#HubDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the hub.
" - } - }, - "HubDescription": { - "target": "com.amazonaws.sagemaker#HubDescription", - "traits": { - "smithy.api#documentation": "A description of the hub.
" - } - }, - "HubSearchKeywords": { - "target": "com.amazonaws.sagemaker#HubSearchKeywordList", - "traits": { - "smithy.api#documentation": "The searchable keywords for the hub.
" - } - }, - "HubStatus": { - "target": "com.amazonaws.sagemaker#HubStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the hub.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the hub was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the hub was last modified.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Information about a hub.
" - } - }, - "com.amazonaws.sagemaker#HubInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HubInfo" - } - }, - "com.amazonaws.sagemaker#HubName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#HubNameOrArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:(\\d{12}|aws):hub\\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#HubS3StorageConfig": { - "type": "structure", - "members": { - "S3OutputPath": { - "target": "com.amazonaws.sagemaker#S3OutputPath", - "traits": { - "smithy.api#documentation": "The Amazon S3 bucket prefix for hosting hub content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon S3 storage configuration of a hub.
" - } - }, - "com.amazonaws.sagemaker#HubSearchKeyword": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[^A-Z]*$" - } - }, - "com.amazonaws.sagemaker#HubSearchKeywordList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HubSearchKeyword" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#HubSortBy": { - "type": "enum", - "members": { - "HUB_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HubName" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "HUB_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HubStatus" - } - }, - "ACCOUNT_ID_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccountIdOwner" - } - } - } - }, - "com.amazonaws.sagemaker#HubStatus": { - "type": "enum", - "members": { - "IN_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateFailed" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateFailed" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteFailed" - } - } - } - }, - "com.amazonaws.sagemaker#HumanLoopActivationConditionsConfig": { - "type": "structure", - "members": { - "HumanLoopActivationConditions": { - "target": "com.amazonaws.sagemaker#SynthesizedJsonHumanLoopActivationConditions", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. \n The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see \n JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI \n in the Amazon SageMaker Developer Guide.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required\n format of activation conditions.
" - } - }, - "com.amazonaws.sagemaker#HumanLoopActivationConfig": { - "type": "structure", - "members": { - "HumanLoopActivationConditionsConfig": { - "target": "com.amazonaws.sagemaker#HumanLoopActivationConditionsConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Container structure for defining under what conditions SageMaker creates a human\n loop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.
Amazon Resource Name (ARN) of a team of workers. To learn more about the types of\n workforces and work teams you can create and use with Amazon A2I, see Create\n and Manage Workforces.
", - "smithy.api#required": {} - } - }, - "HumanTaskUiArn": { - "target": "com.amazonaws.sagemaker#HumanTaskUiArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human task user interface.
\nYou can use standard HTML and Crowd HTML Elements to create a custom worker task\n template. You use this template to create a human task UI.
\nTo learn how to create a custom HTML template, see Create Custom Worker\n Task Template.
\nTo learn how to create a human task UI, which is a worker task template that can be used\n in a flow definition, see Create and Delete a Worker Task Templates.
", - "smithy.api#required": {} - } - }, - "TaskTitle": { - "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTitle", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A title for the human worker task.
", - "smithy.api#required": {} - } - }, - "TaskDescription": { - "target": "com.amazonaws.sagemaker#FlowDefinitionTaskDescription", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A description for the human worker task.
", - "smithy.api#required": {} - } - }, - "TaskCount": { - "target": "com.amazonaws.sagemaker#FlowDefinitionTaskCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of distinct workers who will perform the same task on each object.\n For example, if TaskCount is set to 3 for an image classification \n labeling job, three workers will classify each input image. \n Increasing TaskCount can improve label accuracy.
The length of time that a task remains available for review by human workers.
" - } - }, - "TaskTimeLimitInSeconds": { - "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTimeLimitInSeconds", - "traits": { - "smithy.api#documentation": "The amount of time that a worker has to complete a task. The default value is 3,600\n seconds (1 hour).
" - } - }, - "TaskKeywords": { - "target": "com.amazonaws.sagemaker#FlowDefinitionTaskKeywords", - "traits": { - "smithy.api#documentation": "Keywords used to describe the task so that workers can discover the task.
" - } - }, - "PublicWorkforceTaskPrice": { - "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice" - } - }, - "traits": { - "smithy.api#documentation": "Describes the work to be performed by human workers.
" - } - }, - "com.amazonaws.sagemaker#HumanLoopRequestSource": { - "type": "structure", - "members": { - "AwsManagedHumanLoopRequestSource": { - "target": "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. \n The default field settings and JSON parsing rules are different based on the integration source. Valid values:
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Container for configuring the source of human task requests.
" - } - }, - "com.amazonaws.sagemaker#HumanTaskConfig": { - "type": "structure", - "members": { - "WorkteamArn": { - "target": "com.amazonaws.sagemaker#WorkteamArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.
", - "smithy.api#required": {} - } - }, - "UiConfig": { - "target": "com.amazonaws.sagemaker#UiConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the user interface that workers use to complete the labeling\n task.
", - "smithy.api#required": {} - } - }, - "PreHumanTaskLambdaArn": { - "target": "com.amazonaws.sagemaker#LambdaFunctionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.
\nFor built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.
\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n
\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n
\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n
\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n
\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n
\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n
\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n
\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n
\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n
\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n
\n 3D Point Cloud Modalities\n
\nUse the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.
\n\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n
\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n
\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n
\n Use the following ARNs for Label Verification and Adjustment Jobs\n
\nUse label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .
\n\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox\n
\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n
\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n
\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n
\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n
\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n
\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
Keywords used to describe the task so that workers on Amazon Mechanical Turk can\n discover the task.
" - } - }, - "TaskTitle": { - "target": "com.amazonaws.sagemaker#TaskTitle", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A title for the task for your human workers.
", - "smithy.api#required": {} - } - }, - "TaskDescription": { - "target": "com.amazonaws.sagemaker#TaskDescription", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A description of the task for your human workers.
", - "smithy.api#required": {} - } - }, - "NumberOfHumanWorkersPerDataObject": { - "target": "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of human workers that will label an object.
", - "smithy.api#required": {} - } - }, - "TaskTimeLimitInSeconds": { - "target": "com.amazonaws.sagemaker#TaskTimeLimitInSeconds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The amount of time that a worker has to complete a task.
\nIf you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).
\nIf you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:
\nFor image and \n text labeling jobs,\n the maximum is 8 hours (28,800 seconds).
\nFor 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
\nThe length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.
\nIf you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds).\n The default is 6 hours (21,600 seconds).
\nIf you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
\nDefines the maximum number of data objects that can be labeled by human workers at the\n same time. Also referred to as batch size. Each object may have more than one worker at one time.\n The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.
" - } - }, - "AnnotationConsolidationConfig": { - "target": "com.amazonaws.sagemaker#AnnotationConsolidationConfig", - "traits": { - "smithy.api#documentation": "Configures how labels are consolidated across human workers.
" - } - }, - "PublicWorkforceTaskPrice": { - "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice", - "traits": { - "smithy.api#documentation": "The price that you pay for each task performed by an Amazon Mechanical Turk worker.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information required for human workers to complete a labeling task.
" - } - }, - "com.amazonaws.sagemaker#HumanTaskUiArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:human-task-ui/" - } - }, - "com.amazonaws.sagemaker#HumanTaskUiName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9])*$" - } - }, - "com.amazonaws.sagemaker#HumanTaskUiStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.sagemaker#HumanTaskUiSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HumanTaskUiSummary" - } - }, - "com.amazonaws.sagemaker#HumanTaskUiSummary": { - "type": "structure", - "members": { - "HumanTaskUiName": { - "target": "com.amazonaws.sagemaker#HumanTaskUiName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the human task user interface.
", - "smithy.api#required": {} - } - }, - "HumanTaskUiArn": { - "target": "com.amazonaws.sagemaker#HumanTaskUiArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human task user interface.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp when SageMaker created the human task user interface.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Container for human task user interface information.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification": { - "type": "structure", - "members": { - "TrainingImage": { - "target": "com.amazonaws.sagemaker#AlgorithmImage", - "traits": { - "smithy.api#documentation": " The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.
The name of the resource algorithm to use for the hyperparameter tuning job. If you\n specify a value for this parameter, do not specify a value for\n TrainingImage.
An array of MetricDefinition objects that specify the\n metrics\n that the algorithm emits.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies\n which\n training algorithm to use for training jobs that a hyperparameter\n tuning job launches and the metrics to monitor.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#HyperParameterScalingType": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Auto" - } - }, - "LINEAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Linear" - } - }, - "LOGARITHMIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Logarithmic" - } - }, - "REVERSE_LOGARITHMIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ReverseLogarithmic" - } - } - } - }, - "com.amazonaws.sagemaker#HyperParameterSpecification": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#ParameterName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of this hyperparameter. The name must be unique.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A brief description of the hyperparameter.
" - } - }, - "Type": { - "target": "com.amazonaws.sagemaker#ParameterType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of this hyperparameter. The valid types are Integer,\n Continuous, Categorical, and FreeText.
The allowed range for this hyperparameter.
" - } - }, - "IsTunable": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether this hyperparameter is tunable in a hyperparameter tuning\n job.
" - } - }, - "IsRequired": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether this hyperparameter is required.
" - } - }, - "DefaultValue": { - "target": "com.amazonaws.sagemaker#HyperParameterValue", - "traits": { - "smithy.api#documentation": "The default value for this hyperparameter. If a default value is specified, a\n hyperparameter cannot be required.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines a hyperparameter to be used by an algorithm.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterSpecifications": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HyperParameterSpecification" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition": { - "type": "structure", - "members": { - "DefinitionName": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", - "traits": { - "smithy.api#documentation": "The job definition name.
" - } - }, - "TuningObjective": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective" - }, - "HyperParameterRanges": { - "target": "com.amazonaws.sagemaker#ParameterRanges" - }, - "StaticHyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", - "traits": { - "smithy.api#documentation": "Specifies the values of hyperparameters\n that\n do not change for the tuning job.
" - } - }, - "AlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The HyperParameterAlgorithmSpecification object that\n specifies\n the resource algorithm to use for the training jobs that the tuning\n job launches.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the\n IAM\n role associated with the training jobs that the tuning job\n launches.
", - "smithy.api#required": {} - } - }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#InputDataConfig", - "traits": { - "smithy.api#documentation": "An array of Channel objects that\n specify\n the\n input for the training jobs that the tuning job launches.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", - "traits": { - "smithy.api#documentation": "The VpcConfig object that specifies the VPC that you want the training jobs\n that this hyperparameter tuning job launches to connect to. Control access to and from\n your training container by configuring the VPC. For more information, see Protect Training Jobs\n by Using an Amazon Virtual Private Cloud.
" - } - }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#OutputDataConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the path to the Amazon S3 bucket where you\n store\n model artifacts from the training jobs that the tuning job\n launches.
", - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfig", - "traits": { - "smithy.api#documentation": "The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.
\nStorage volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want SageMaker to use the storage volume to store the\n training data, choose File as the TrainingInputMode in the\n algorithm specification. For distributed training algorithms, specify an instance count\n greater than 1.
If you want to use hyperparameter optimization with instance type flexibility, use\n HyperParameterTuningResourceConfig instead.
The configuration for the hyperparameter tuning resources, including the compute\n instances and storage volumes, used for training jobs launched by the tuning job. By\n default, storage volumes hold model artifacts and incremental states. Choose\n File for TrainingInputMode in the\n AlgorithmSpecification parameter to additionally store training data in\n the storage volume (optional).
Specifies a limit to how long a model hyperparameter training job can run. It also\n specifies how long a managed spot training job has to complete. When the job reaches the\n time limit, SageMaker ends the training job. Use this API to cap model training costs.
", - "smithy.api#required": {} - } - }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n network isolation is used for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
" - } - }, - "EnableInterContainerTrafficEncryption": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.
A Boolean indicating whether managed spot training is enabled (True) or\n not (False).
The number of times to retry the job when the job fails due to an\n InternalServerError.
An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See\n Define metrics and variables for more information.
\nThe maximum number of items specified for Map Entries refers to the\n maximum number of environment variables for each TrainingJobDefinition\n and also the maximum for the hyperparameter tuning job itself. That is, the sum of\n the number of environment variables for all the training job definitions can't\n exceed the maximum number specified.
Defines\n the training jobs launched by a hyperparameter tuning job.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" - } - }, - "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" - } - }, - "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 48 - } - } - }, - "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\S\\s]*$" - } - }, - "com.amazonaws.sagemaker#HyperParameterTrainingJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary" - } - }, - "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary": { - "type": "structure", - "members": { - "TrainingJobDefinitionName": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", - "traits": { - "smithy.api#documentation": "The training job definition name.
" - } - }, - "TrainingJobName": { - "target": "com.amazonaws.sagemaker#TrainingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the training job.
", - "smithy.api#required": {} - } - }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
", - "smithy.api#required": {} - } - }, - "TuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", - "traits": { - "smithy.api#documentation": "The HyperParameter tuning job that launched the training job.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the training job was created.
", - "smithy.api#required": {} - } - }, - "TrainingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the training job started.
" - } - }, - "TrainingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Specifies the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
The\n status\n of the training job.
", - "smithy.api#required": {} - } - }, - "TunedHyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A\n list of the hyperparameters for which you specified ranges to\n search.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The\n reason that the training job failed.\n
" - } - }, - "FinalHyperParameterTuningJobObjectiveMetric": { - "target": "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric", - "traits": { - "smithy.api#documentation": "The FinalHyperParameterTuningJobObjectiveMetric object that specifies the\n value\n of the\n objective\n metric of the tuning job that launched this training job.
" - } - }, - "ObjectiveStatus": { - "target": "com.amazonaws.sagemaker#ObjectiveStatus", - "traits": { - "smithy.api#documentation": "The status of the objective metric for the training job:
\nSucceeded: The\n final\n objective metric for the training job was evaluated by the\n hyperparameter tuning job and\n used\n in the hyperparameter tuning process.
\nPending: The training job is in progress and evaluation of its final objective\n metric is pending.
\nFailed:\n The final objective metric for the training job was not evaluated, and was not\n used in the hyperparameter tuning process. This typically occurs when the\n training job failed or did not emit an objective\n metric.
\nThe container for the summary information about a training job.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningAllocationStrategy": { - "type": "enum", - "members": { - "PRIORITIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Prioritized" - } - } - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfig": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.sagemaker#TrainingInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The instance type used for processing of hyperparameter optimization jobs. Choose from\n general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge\n or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more\n information about instance types, see instance type\n descriptions.
", - "smithy.api#required": {} - } - }, - "InstanceCount": { - "target": "com.amazonaws.sagemaker#TrainingInstanceCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See Step 2:\n Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more\n information.
The volume size in GB of the data to be processed for hyperparameter optimization\n (optional).
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for hyperparameter tuning resources for use in training jobs\n launched by the tuning job. These resources include compute instances and storage\n volumes. Specify one or more compute instance configurations and allocation strategies\n to select resources (optional).
" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6 - } - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails": { - "type": "structure", - "members": { - "NumberOfTrainingJobsObjectiveNotImproving": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The number of training jobs launched by a tuning job that are not improving (1% or\n less) as measured by model performance evaluated against an objective function.
" - } - }, - "ConvergenceDetectedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time in timestamp format that AMT detected model convergence, as defined by a lack\n of significant improvement over time based on criteria developed over a wide range of\n diverse benchmarking tests.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure that contains runtime information about both current and completed\n hyperparameter tuning jobs.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobConfig": { - "type": "structure", - "members": { - "Strategy": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies how hyperparameter tuning chooses the combinations of hyperparameter values\n to use for the training job it launches. For information about search strategies, see\n How\n Hyperparameter Tuning Works.
", - "smithy.api#required": {} - } - }, - "StrategyConfig": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyConfig", - "traits": { - "smithy.api#documentation": "The configuration for the Hyperband optimization strategy. This parameter\n should be provided only if Hyperband is selected as the strategy for\n HyperParameterTuningJobConfig.
The HyperParameterTuningJobObjective specifies the objective metric used to\n evaluate the performance of training jobs launched by this tuning job.
" - } - }, - "ResourceLimits": { - "target": "com.amazonaws.sagemaker#ResourceLimits", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ResourceLimits\n object that specifies the maximum number of training and parallel training jobs that can\n be used for this hyperparameter tuning job.
", - "smithy.api#required": {} - } - }, - "ParameterRanges": { - "target": "com.amazonaws.sagemaker#ParameterRanges", - "traits": { - "smithy.api#documentation": "The ParameterRanges\n object that specifies the ranges of hyperparameters that this tuning job searches over\n to find the optimal configuration for the highest model performance against your chosen\n objective metric.
" - } - }, - "TrainingJobEarlyStoppingType": { - "target": "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType", - "traits": { - "smithy.api#documentation": "Specifies whether to use early stopping for training jobs launched by the\n hyperparameter tuning job. Because the Hyperband strategy has its own\n advanced internal early stopping mechanism, TrainingJobEarlyStoppingType\n must be OFF to use Hyperband. This parameter can take on one\n of the following values (the default value is OFF):
Training jobs launched by the hyperparameter tuning job do not use early\n stopping.
\nSageMaker stops training jobs launched by the hyperparameter tuning job when\n they are unlikely to perform better than previously completed training jobs.\n For more information, see Stop Training Jobs Early.
\nThe tuning job's completion criteria.
" - } - }, - "RandomSeed": { - "target": "com.amazonaws.sagemaker#RandomSeed", - "traits": { - "smithy.api#documentation": "A value used to initialize a pseudo-random number generator. Setting a random seed and\n using the same seed later for the same tuning job will allow hyperparameter optimization\n to find more a consistent hyperparameter configuration between the two runs.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configures a hyperparameter tuning job.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobConsumedResources": { - "type": "structure", - "members": { - "RuntimeInSeconds": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The wall clock runtime in seconds used by your hyperparameter tuning job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The total resources consumed by your hyperparameter tuning job.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobObjective": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Whether to minimize or maximize the objective metric.
", - "smithy.api#required": {} - } - }, - "MetricName": { - "target": "com.amazonaws.sagemaker#MetricName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The\n name of the metric to use for the objective metric.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning\n uses the value of this metric to evaluate the training jobs it launches, and returns the\n training job that results in either the highest or lowest value for this metric,\n depending on the value you specify for the Type parameter. If you want to\n define a custom objective metric, see Define metrics and environment variables.
The name of a hyperparameter tuning job.
" - } - }, - "HyperParameterTuningJobArn": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a hyperparameter tuning job.
" - } - }, - "HyperParameterTuningJobConfig": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig" - }, - "TrainingJobDefinition": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition" - }, - "TrainingJobDefinitions": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", - "traits": { - "smithy.api#documentation": "The job definitions included in a hyperparameter tuning job.
" - } - }, - "HyperParameterTuningJobStatus": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", - "traits": { - "smithy.api#documentation": "The status of a hyperparameter tuning job.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that a hyperparameter tuning job was created.
" - } - }, - "HyperParameterTuningEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that a hyperparameter tuning job ended.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that a hyperparameter tuning job was last modified.
" - } - }, - "TrainingJobStatusCounters": { - "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters" - }, - "ObjectiveStatusCounters": { - "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters" - }, - "BestTrainingJob": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary" - }, - "OverallBestTrainingJob": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary" - }, - "WarmStartConfig": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig" - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The error that was created when a hyperparameter tuning job failed.
" - } - }, - "TuningJobCompletionDetails": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails", - "traits": { - "smithy.api#documentation": "Information about either a current or completed hyperparameter tuning job.
" - } - }, - "ConsumedResources": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConsumedResources", - "traits": { - "smithy.api#documentation": "The total amount of resources consumed by a hyperparameter tuning job.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An entity returned by the SearchRecord API\n containing the properties of a hyperparameter tuning job.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobSortByOptions": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "Status": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - }, - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobStatus": { - "type": "enum", - "members": { - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteFailed" - } - } - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyConfig": { - "type": "structure", - "members": { - "HyperbandStrategyConfig": { - "target": "com.amazonaws.sagemaker#HyperbandStrategyConfig", - "traits": { - "smithy.api#documentation": "The configuration for the object that specifies the Hyperband strategy.\n This parameter is only supported for the Hyperband selection for\n Strategy within the HyperParameterTuningJobConfig API.
The configuration for a training job launched by a hyperparameter tuning job. Choose\n Bayesian for Bayesian optimization, and Random for random\n search optimization. For more advanced use cases, use Hyperband, which\n evaluates objective metrics for training jobs after every epoch. For more information about\n strategies, see How Hyperparameter\n Tuning Works.
The strategy hyperparameter tuning uses to find the best combination of\n hyperparameters for your model.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSummary" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobSummary": { - "type": "structure", - "members": { - "HyperParameterTuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the tuning job.
", - "smithy.api#required": {} - } - }, - "HyperParameterTuningJobArn": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The\n Amazon\n Resource Name (ARN) of the tuning job.
", - "smithy.api#required": {} - } - }, - "HyperParameterTuningJobStatus": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the\n tuning\n job.
", - "smithy.api#required": {} - } - }, - "Strategy": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the search strategy hyperparameter tuning uses to choose which\n hyperparameters to\n evaluate\n at each iteration.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the tuning job was created.
", - "smithy.api#required": {} - } - }, - "HyperParameterTuningEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the tuning job ended.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the tuning job was\n modified.
" - } - }, - "TrainingJobStatusCounters": { - "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the numbers of training\n jobs, categorized by status, that this tuning job launched.
", - "smithy.api#required": {} - } - }, - "ObjectiveStatusCounters": { - "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the numbers of training jobs,\n categorized by objective metric status, that this tuning job launched.
", - "smithy.api#required": {} - } - }, - "ResourceLimits": { - "target": "com.amazonaws.sagemaker#ResourceLimits", - "traits": { - "smithy.api#documentation": "The ResourceLimits\n object that specifies the maximum number of training jobs and parallel training jobs\n allowed for this tuning job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides summary information about a hyperparameter tuning job.
" - } - }, - "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig": { - "type": "structure", - "members": { - "ParentHyperParameterTuningJobs": { - "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of hyperparameter tuning jobs that are used as the starting point for the new\n hyperparameter tuning job. For more information about warm starting a hyperparameter\n tuning job, see Using a Previous\n Hyperparameter Tuning Job as a Starting Point.
\nHyperparameter tuning jobs created before October 1, 2018 cannot be used as parent\n jobs for warm start tuning jobs.
", - "smithy.api#required": {} - } - }, - "WarmStartType": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies one of the following:
\nThe new hyperparameter tuning job uses the same input data and training\n image as the parent tuning jobs. You can change the hyperparameter ranges to\n search and the maximum number of training jobs that the hyperparameter\n tuning job launches. You cannot use a new version of the training algorithm,\n unless the changes in the new version do not affect the algorithm itself.\n For example, changes that improve logging or adding support for a different\n data format are allowed. You can also change hyperparameters from tunable to\n static, and from static to tunable, but the total number of static plus\n tunable hyperparameters must remain the same as it is in all parent jobs.\n The objective metric for the new tuning job must be the same as for all\n parent jobs.
\nThe new hyperparameter tuning job can include input data, hyperparameter\n ranges, maximum number of concurrent training jobs, and maximum number of\n training jobs that are different than those of its parent hyperparameter\n tuning jobs. The training image can also be a different version from the\n version used in the parent hyperparameter tuning job. You can also change\n hyperparameters from tunable to static, and from static to tunable, but the\n total number of static plus tunable hyperparameters must remain the same as\n it is in all parent jobs. The objective metric for the new tuning job must\n be the same as for all parent jobs.
\nSpecifies the configuration for a hyperparameter tuning job that uses one or more\n previous hyperparameter tuning jobs as a starting point. The results of previous tuning\n jobs are used to inform which combinations of hyperparameters to search over in the new\n tuning job.
\nAll training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric, and the training job that performs the best is compared to the\n best training jobs from the parent tuning jobs. From these, the training job that\n performs the best as measured by the objective metric is returned as the overall best\n training job.
\nAll training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.
\nThe instance type used to run hyperparameter optimization tuning jobs. See descriptions of\n instance types for more information.
" - } - }, - "InstanceCount": { - "target": "com.amazonaws.sagemaker#TrainingInstanceCount", - "traits": { - "smithy.api#documentation": "The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
The volume size in GB for the storage volume to be used in processing hyperparameter\n optimization jobs (optional). These volumes store model artifacts, incremental states\n and optionally, scratch space for training algorithms. Do not provide a value for this\n parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these\n instances for training, VolumeSizeInGB cannot be greater than this total\n size. For a list of instance types with local instance storage and their sizes, see\n instance store volumes.
SageMaker supports only the General Purpose SSD\n (gp2) storage volume type.
\nA key used by Amazon Web Services Key Management Service to encrypt data on the storage volume\n attached to the compute instances used to run the training job. You can use either of\n the following formats to specify a key.
\nKMS Key ID:
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS key:
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Some instances use local storage, which use a hardware module to\n encrypt storage volumes. If you choose one of these instance types, you\n cannot request a VolumeKmsKeyId. For a list of instance types that use\n local storage, see instance store\n volumes. For more information about Amazon Web Services Key Management Service, see KMS\n encryption for more information.
The strategy that determines the order of preference for resources specified in\n InstanceConfigs used in hyperparameter optimization.
A list containing the configuration(s) for one or more resources for processing\n hyperparameter jobs. These resources include compute instances and storage volumes to\n use in model training jobs launched by hyperparameter tuning jobs. The\n AllocationStrategy controls the order in which multiple configurations\n provided in InstanceConfigs are used.
If you only want to use a single instance configuration inside the\n HyperParameterTuningResourceConfig API, do not provide a value for\n InstanceConfigs. Instead, use InstanceType,\n VolumeSizeInGB and InstanceCount. If you use\n InstanceConfigs, do not provide values for\n InstanceType, VolumeSizeInGB or\n InstanceCount.
The configuration of resources, including compute instances and storage volumes for\n use in training jobs launched by hyperparameter tuning jobs.\n HyperParameterTuningResourceConfig is similar to\n ResourceConfig, but has the additional InstanceConfigs and\n AllocationStrategy fields to allow for flexible instance management.\n Specify one or more instance types, count, and the allocation strategy for instance\n selection.
\n HyperParameterTuningResourceConfig supports the capabilities of\n ResourceConfig with the exception of\n KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools\n by default, which reuse clusters between training jobs.
The minimum number of resources (such as epochs) that can be used by a training job\n launched by a hyperparameter tuning job. If the value for MinResource has not\n been reached, the training job is not stopped by Hyperband.
The maximum number of resources (such as epochs) that can be used by a training job\n launched by a hyperparameter tuning job. Once a job reaches the MaxResource\n value, it is stopped. If a value for MaxResource is not provided, and\n Hyperband is selected as the hyperparameter tuning strategy,\n HyperbandTraining attempts to infer MaxResource from the\n following keys (if present) in StaticsHyperParameters:
\n epochs\n
\n numepochs\n
\n n-epochs\n
\n n_epochs\n
\n num_epochs\n
If HyperbandStrategyConfig is unable to infer a value for\n MaxResource, it generates a validation error. The maximum value is 20,000\n epochs. All metrics that correspond to an objective metric are used to derive early stopping\n decisions. For distributed training jobs,\n ensure that duplicate metrics are not printed in the logs across the individual nodes in a\n training job. If multiple nodes are publishing duplicate or incorrect metrics, training\n jobs may make an incorrect stopping decision and stop the job prematurely.
The configuration for Hyperband, a multi-fidelity based hyperparameter\n tuning strategy. Hyperband uses the final and intermediate results of a\n training job to dynamically allocate resources to utilized hyperparameter configurations\n while automatically stopping under-performing configurations. This parameter should be\n provided only if Hyperband is selected as the StrategyConfig\n under the HyperParameterTuningJobConfig API.
The Amazon Resource Name (ARN) of the IAM identity.
" - } - }, - "PrincipalId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The ID of the principal that assumes the IAM identity.
" - } - }, - "SourceIdentity": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The person or application which assumes the IAM identity.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The IAM Identity details associated with the user. These details are\n associated with model package groups, model packages and project entities only.
" - } - }, - "com.amazonaws.sagemaker#IamPolicyConstraints": { - "type": "structure", - "members": { - "SourceIp": { - "target": "com.amazonaws.sagemaker#EnabledOrDisabled", - "traits": { - "smithy.api#documentation": "When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal.
When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal.
Use this parameter to specify a supported global condition key that is added to the IAM policy.
" - } - }, - "com.amazonaws.sagemaker#IdempotencyToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 128 - } - } - }, - "com.amazonaws.sagemaker#IdentityProviderOAuthSetting": { - "type": "structure", - "members": { - "DataSourceName": { - "target": "com.amazonaws.sagemaker#DataSourceName", - "traits": { - "smithy.api#documentation": "The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#FeatureStatus", - "traits": { - "smithy.api#documentation": "Describes whether OAuth for a data source is enabled or disabled in the Canvas\n application.
" - } - }, - "SecretArn": { - "target": "com.amazonaws.sagemaker#SecretArn", - "traits": { - "smithy.api#documentation": "The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your\n identity provider, such as the client ID and secret, authorization URL, and token URL.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external\n data source, such as Snowflake.
" - } - }, - "com.amazonaws.sagemaker#IdentityProviderOAuthSettings": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#IdentityProviderOAuthSetting" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#IdleSettings": { - "type": "structure", - "members": { - "LifecycleManagement": { - "target": "com.amazonaws.sagemaker#LifecycleManagement", - "traits": { - "smithy.api#documentation": "Indicates whether idle shutdown is activated for the application type.
" - } - }, - "IdleTimeoutInMinutes": { - "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", - "traits": { - "smithy.api#documentation": "The time that SageMaker waits after the application becomes idle before shutting it\n down.
" - } - }, - "MinIdleTimeoutInMinutes": { - "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", - "traits": { - "smithy.api#documentation": "The minimum value in minutes that custom idle shutdown can be set to by the user.
" - } - }, - "MaxIdleTimeoutInMinutes": { - "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", - "traits": { - "smithy.api#documentation": "The maximum value in minutes that custom idle shutdown can be set to by the user.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings related to idle shutdown of Studio applications.
" - } - }, - "com.amazonaws.sagemaker#IdleTimeoutInMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 525600 - } - } - }, - "com.amazonaws.sagemaker#Image": { - "type": "structure", - "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "When the image was created.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ImageDescription", - "traits": { - "smithy.api#documentation": "The description of the image.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ImageDisplayName", - "traits": { - "smithy.api#documentation": "The name of the image as displayed.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "When a create, update, or delete operation fails, the reason for the failure.
" - } - }, - "ImageArn": { - "target": "com.amazonaws.sagemaker#ImageArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the image.
", - "smithy.api#required": {} - } - }, - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image.
", - "smithy.api#required": {} - } - }, - "ImageStatus": { - "target": "com.amazonaws.sagemaker#ImageStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the image.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "When the image was last modified.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from\n a common base container image. Each of these container images is represented by a SageMaker AI\n ImageVersion.
How long a job is allowed to run, or how many candidates a job is allowed to\n generate.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the image classification problem\n type.
" - } - }, - "com.amazonaws.sagemaker#ImageConfig": { - "type": "structure", - "members": { - "RepositoryAccessMode": { - "target": "com.amazonaws.sagemaker#RepositoryAccessMode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Set this to one of the following values:
\n\n Platform - The model image is hosted in Amazon ECR.
\n Vpc - The model image is hosted in a private Docker registry in\n your VPC.
(Optional) Specifies an authentication configuration for the private docker registry\n where your model image is hosted. Specify a value for this property only if you\n specified Vpc as the value for the RepositoryAccessMode field,\n and the private Docker registry where the model image is hosted requires\n authentication.
Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC).
" - } - }, - "com.amazonaws.sagemaker#ImageContainerImage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.sagemaker#ImageDeleteProperty": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 11 - }, - "smithy.api#pattern": "^(^DisplayName$)|(^Description$)$" - } - }, - "com.amazonaws.sagemaker#ImageDeletePropertyList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ImageDeleteProperty" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.sagemaker#ImageDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ImageDigest": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 72 - }, - "smithy.api#pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" - } - }, - "com.amazonaws.sagemaker#ImageDisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^\\S(.*\\S)?$" - } - }, - "com.amazonaws.sagemaker#ImageName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#ImageNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-.]+$" - } - }, - "com.amazonaws.sagemaker#ImageSortBy": { - "type": "enum", - "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_TIME" - } - }, - "LAST_MODIFIED_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST_MODIFIED_TIME" - } - }, - "IMAGE_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE_NAME" - } - } - } - }, - "com.amazonaws.sagemaker#ImageSortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASCENDING" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESCENDING" - } - } - } - }, - "com.amazonaws.sagemaker#ImageStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.sagemaker#ImageUri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ImageVersion": { - "type": "structure", - "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "When the version was created.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "When a create or delete operation fails, the reason for the failure.
" - } - }, - "ImageArn": { - "target": "com.amazonaws.sagemaker#ImageArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the image the version is based on.
", - "smithy.api#required": {} - } - }, - "ImageVersionArn": { - "target": "com.amazonaws.sagemaker#ImageVersionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the version.
", - "smithy.api#required": {} - } - }, - "ImageVersionStatus": { - "target": "com.amazonaws.sagemaker#ImageVersionStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the version.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "When the version was last modified.
", - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.sagemaker#ImageVersionNumber", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version number.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A version of a SageMaker AI Image. A version represents an existing container\n image.
Import hub content.
" - } - }, - "com.amazonaws.sagemaker#ImportHubContentRequest": { - "type": "structure", - "members": { - "HubContentName": { - "target": "com.amazonaws.sagemaker#HubContentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub content to import.
", - "smithy.api#required": {} - } - }, - "HubContentVersion": { - "target": "com.amazonaws.sagemaker#HubContentVersion", - "traits": { - "smithy.api#documentation": "The version of the hub content to import.
" - } - }, - "HubContentType": { - "target": "com.amazonaws.sagemaker#HubContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of hub content to import.
", - "smithy.api#required": {} - } - }, - "DocumentSchemaVersion": { - "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the hub content schema to import.
", - "smithy.api#required": {} - } - }, - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub to import content into.
", - "smithy.api#required": {} - } - }, - "HubContentDisplayName": { - "target": "com.amazonaws.sagemaker#HubContentDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the hub content to import.
" - } - }, - "HubContentDescription": { - "target": "com.amazonaws.sagemaker#HubContentDescription", - "traits": { - "smithy.api#documentation": "A description of the hub content to import.
" - } - }, - "HubContentMarkdown": { - "target": "com.amazonaws.sagemaker#HubContentMarkdown", - "traits": { - "smithy.api#documentation": "A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
" - } - }, - "HubContentDocument": { - "target": "com.amazonaws.sagemaker#HubContentDocument", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
", - "smithy.api#required": {} - } - }, - "HubContentSearchKeywords": { - "target": "com.amazonaws.sagemaker#HubContentSearchKeywordList", - "traits": { - "smithy.api#documentation": "The searchable keywords of the hub content.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Any tags associated with the hub content.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ImportHubContentResponse": { - "type": "structure", - "members": { - "HubArn": { - "target": "com.amazonaws.sagemaker#HubArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the hub that the content was imported into.
", - "smithy.api#required": {} - } - }, - "HubContentArn": { - "target": "com.amazonaws.sagemaker#HubContentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the hub content that was imported.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#InUseInstanceCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#InferenceComponentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements": { - "type": "structure", - "members": { - "NumberOfCpuCoresRequired": { - "target": "com.amazonaws.sagemaker#NumberOfCpuCores", - "traits": { - "smithy.api#documentation": "The number of CPU cores to allocate to run a model that you assign to an inference\n component.
" - } - }, - "NumberOfAcceleratorDevicesRequired": { - "target": "com.amazonaws.sagemaker#NumberOfAcceleratorDevices", - "traits": { - "smithy.api#documentation": "The number of accelerators to allocate to run a model that you assign to an inference\n component. Accelerators include GPUs and Amazon Web Services Inferentia.
" - } - }, - "MinMemoryRequiredInMb": { - "target": "com.amazonaws.sagemaker#MemoryInMb", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The minimum MB of memory to allocate to run a model that you assign to an inference\n component.
", - "smithy.api#required": {} - } - }, - "MaxMemoryRequiredInMb": { - "target": "com.amazonaws.sagemaker#MemoryInMb", - "traits": { - "smithy.api#documentation": "The maximum MB of memory to allocate to run a model that you assign to an inference\n component.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the compute resources to allocate to run a model, plus any adapter models, that\n you assign to an inference component. These resources include CPU cores, accelerators, and\n memory.
" - } - }, - "com.amazonaws.sagemaker#InferenceComponentContainerSpecification": { - "type": "structure", - "members": { - "Image": { - "target": "com.amazonaws.sagemaker#ContainerImage", - "traits": { - "smithy.api#documentation": "The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.
" - } - }, - "ArtifactUrl": { - "target": "com.amazonaws.sagemaker#Url", - "traits": { - "smithy.api#documentation": "The Amazon S3 path where the model artifacts, which result from model training,\n are stored. This path must point to a single gzip compressed tar archive (.tar.gz\n suffix).
" - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#EnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container. Each key and value in the\n Environment string-to-string map can have length of up to 1024. We support up to 16 entries\n in the map.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.
" - } - }, - "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary": { - "type": "structure", - "members": { - "DeployedImage": { - "target": "com.amazonaws.sagemaker#DeployedImage" - }, - "ArtifactUrl": { - "target": "com.amazonaws.sagemaker#Url", - "traits": { - "smithy.api#documentation": "The Amazon S3 path where the model artifacts are stored.
" - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#EnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the resources that are deployed with this inference component.
" - } - }, - "com.amazonaws.sagemaker#InferenceComponentCopyCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#InferenceComponentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" - } - }, - "com.amazonaws.sagemaker#InferenceComponentNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig": { - "type": "structure", - "members": { - "CopyCount": { - "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of runtime copies of the model container to deploy with the inference\n component. Each copy can serve inference requests.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
" - } - }, - "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary": { - "type": "structure", - "members": { - "DesiredCopyCount": { - "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", - "traits": { - "smithy.api#documentation": "The number of runtime copies of the model container that you requested to deploy with\n the inference component.
" - } - }, - "CurrentCopyCount": { - "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", - "traits": { - "smithy.api#documentation": "The number of runtime copies of the model container that are currently deployed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the runtime settings for the model that is deployed with the inference\n component.
" - } - }, - "com.amazonaws.sagemaker#InferenceComponentSortKey": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "Status": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - } - } - }, - "com.amazonaws.sagemaker#InferenceComponentSpecification": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "The name of an existing SageMaker AI model object in your account that you want to\n deploy with the inference component.
" - } - }, - "Container": { - "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecification", - "traits": { - "smithy.api#documentation": "Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.
" - } - }, - "StartupParameters": { - "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", - "traits": { - "smithy.api#documentation": "Settings that take effect while the model container starts up.
" - } - }, - "ComputeResourceRequirements": { - "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", - "traits": { - "smithy.api#documentation": "The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.
\nOmit this parameter if your request is meant to create an adapter inference component.\n An adapter inference component is loaded by a base inference component, and it uses the\n compute resources of the base inference component.
" - } - }, - "BaseInferenceComponentName": { - "target": "com.amazonaws.sagemaker#InferenceComponentName", - "traits": { - "smithy.api#documentation": "The name of an existing inference component that is to contain the inference component\n that you're creating with your request.
\nSpecify this parameter only if your request is meant to create an adapter inference\n component. An adapter inference component contains the path to an adapter model. The\n purpose of the adapter model is to tailor the inference output of a base foundation model,\n which is hosted by the base inference component. The adapter inference component uses the\n compute resources that you assigned to the base inference component.
\nWhen you create an adapter inference component, use the Container parameter\n to specify the location of the adapter artifacts. In the parameter value, use the\n ArtifactUrl parameter of the\n InferenceComponentContainerSpecification data type.
Before you can create an adapter inference component, you must have an existing\n inference component that contains the foundation model that you want to adapt.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.
" - } - }, - "com.amazonaws.sagemaker#InferenceComponentSpecificationSummary": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "The name of the SageMaker AI model object that is deployed with the inference\n component.
" - } - }, - "Container": { - "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary", - "traits": { - "smithy.api#documentation": "Details about the container that provides the runtime environment for the model that is\n deployed with the inference component.
" - } - }, - "StartupParameters": { - "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", - "traits": { - "smithy.api#documentation": "Settings that take effect while the model container starts up.
" - } - }, - "ComputeResourceRequirements": { - "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", - "traits": { - "smithy.api#documentation": "The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.
" - } - }, - "BaseInferenceComponentName": { - "target": "com.amazonaws.sagemaker#InferenceComponentName", - "traits": { - "smithy.api#documentation": "The name of the base inference component that contains this inference component.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the resources that are deployed with this inference component.
" - } - }, - "com.amazonaws.sagemaker#InferenceComponentStartupParameters": { - "type": "structure", - "members": { - "ModelDataDownloadTimeoutInSeconds": { - "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this inference\n component.
" - } - }, - "ContainerStartupHealthCheckTimeoutInSeconds": { - "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "The timeout value, in seconds, for your inference container to pass health check by\n Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings that take effect while the model container starts up.
" - } - }, - "com.amazonaws.sagemaker#InferenceComponentStatus": { - "type": "enum", - "members": { - "IN_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.sagemaker#InferenceComponentSummary": { - "type": "structure", - "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when the inference component was created.
", - "smithy.api#required": {} - } - }, - "InferenceComponentArn": { - "target": "com.amazonaws.sagemaker#InferenceComponentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", - "smithy.api#required": {} - } - }, - "InferenceComponentName": { - "target": "com.amazonaws.sagemaker#InferenceComponentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference component.
", - "smithy.api#required": {} - } - }, - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
", - "smithy.api#required": {} - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint that hosts the inference component.
", - "smithy.api#required": {} - } - }, - "VariantName": { - "target": "com.amazonaws.sagemaker#VariantName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the production variant that hosts the inference component.
", - "smithy.api#required": {} - } - }, - "InferenceComponentStatus": { - "target": "com.amazonaws.sagemaker#InferenceComponentStatus", - "traits": { - "smithy.api#documentation": "The status of the inference component.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when the inference component was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of the properties of an inference component.
" - } - }, - "com.amazonaws.sagemaker#InferenceComponentSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#InferenceComponentSummary" - } - }, - "com.amazonaws.sagemaker#InferenceExecutionConfig": { - "type": "structure", - "members": { - "Mode": { - "target": "com.amazonaws.sagemaker#InferenceExecutionMode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "How containers in a multi-container are run. The following values are valid.
\n\n SERIAL - Containers run as a serial pipeline.
\n DIRECT - Only the individual container that you specify is\n run.
Specifies details about how containers in a multi-container endpoint are run.
" - } - }, - "com.amazonaws.sagemaker#InferenceExecutionMode": { - "type": "enum", - "members": { - "SERIAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Serial" - } - }, - "DIRECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Direct" - } - } - } - }, - "com.amazonaws.sagemaker#InferenceExperimentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/" - } - }, - "com.amazonaws.sagemaker#InferenceExperimentDataStorageConfig": { - "type": "structure", - "members": { - "Destination": { - "target": "com.amazonaws.sagemaker#DestinationS3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 bucket where the inference request and response data is stored.
", - "smithy.api#required": {} - } - }, - "KmsKey": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "\n The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3\n server-side encryption.\n
" - } - }, - "ContentType": { - "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader" - } - }, - "traits": { - "smithy.api#documentation": "The Amazon S3 location and configuration for storing inference request and response data.
" - } - }, - "com.amazonaws.sagemaker#InferenceExperimentDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#InferenceExperimentList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#InferenceExperimentSummary" - } - }, - "com.amazonaws.sagemaker#InferenceExperimentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 120 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}$" - } - }, - "com.amazonaws.sagemaker#InferenceExperimentSchedule": { - "type": "structure", - "members": { - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the inference experiment started or will start.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the inference experiment ended or will end.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The start and end times of an inference experiment.
\nThe maximum duration that you can set for an inference experiment is 30 days.
" - } - }, - "com.amazonaws.sagemaker#InferenceExperimentStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Created" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Starting" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelled" - } - } - } - }, - "com.amazonaws.sagemaker#InferenceExperimentStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#InferenceExperimentStopDesiredState": { - "type": "enum", - "members": { - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelled" - } - } - } - }, - "com.amazonaws.sagemaker#InferenceExperimentSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#InferenceExperimentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference experiment.
", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.sagemaker#InferenceExperimentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of the inference experiment.
", - "smithy.api#required": {} - } - }, - "Schedule": { - "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", - "traits": { - "smithy.api#documentation": "The duration for which the inference experiment ran or will run.
\nThe maximum duration that you can set for an inference experiment is 30 days.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the inference experiment.
", - "smithy.api#required": {} - } - }, - "StatusReason": { - "target": "com.amazonaws.sagemaker#InferenceExperimentStatusReason", - "traits": { - "smithy.api#documentation": "The error message for the inference experiment status result.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#InferenceExperimentDescription", - "traits": { - "smithy.api#documentation": "The description of the inference experiment.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The timestamp at which the inference experiment was created.
", - "smithy.api#required": {} - } - }, - "CompletionTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the inference experiment was completed.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The timestamp when you last modified the inference experiment.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "Lists a summary of properties of an inference experiment.
" - } - }, - "com.amazonaws.sagemaker#InferenceExperimentType": { - "type": "enum", - "members": { - "SHADOW_MODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ShadowMode" - } - } - } - }, - "com.amazonaws.sagemaker#InferenceHubAccessConfig": { - "type": "structure", - "members": { - "HubContentArn": { - "target": "com.amazonaws.sagemaker#HubContentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the hub content for which deployment access is allowed.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration information specifying which hub contents have accessible deployment options.
" - } - }, - "com.amazonaws.sagemaker#InferenceImage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#InferenceMetrics": { - "type": "structure", - "members": { - "MaxInvocations": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The expected maximum number of requests per minute for the instance.
", - "smithy.api#required": {} - } - }, - "ModelLatency": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The expected model latency at maximum invocations per minute for the instance.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The metrics for an existing endpoint compared in an Inference Recommender job.
" - } - }, - "com.amazonaws.sagemaker#InferenceRecommendation": { - "type": "structure", - "members": { - "RecommendationId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The recommendation ID which uniquely identifies each recommendation.
" - } - }, - "Metrics": { - "target": "com.amazonaws.sagemaker#RecommendationMetrics", - "traits": { - "smithy.api#documentation": "The metrics used to decide what recommendation to make.
" - } - }, - "EndpointConfiguration": { - "target": "com.amazonaws.sagemaker#EndpointOutputConfiguration", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Defines the endpoint configuration parameters.
", - "smithy.api#required": {} - } - }, - "ModelConfiguration": { - "target": "com.amazonaws.sagemaker#ModelConfiguration", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Defines the model configuration.
", - "smithy.api#required": {} - } - }, - "InvocationEndTime": { - "target": "com.amazonaws.sagemaker#InvocationEndTime", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the benchmark completed.
" - } - }, - "InvocationStartTime": { - "target": "com.amazonaws.sagemaker#InvocationStartTime", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the benchmark started.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A list of recommendations made by Amazon SageMaker Inference Recommender.
" - } - }, - "com.amazonaws.sagemaker#InferenceRecommendations": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#InferenceRecommendation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#InferenceRecommendationsJob": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.sagemaker#RecommendationJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the job.
", - "smithy.api#required": {} - } - }, - "JobDescription": { - "target": "com.amazonaws.sagemaker#RecommendationJobDescription", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The job description.
", - "smithy.api#required": {} - } - }, - "JobType": { - "target": "com.amazonaws.sagemaker#RecommendationJobType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The recommendation job type.
", - "smithy.api#required": {} - } - }, - "JobArn": { - "target": "com.amazonaws.sagemaker#RecommendationJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommendation job.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#RecommendationJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the job was created.
", - "smithy.api#required": {} - } - }, - "CompletionTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the job completed.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the job was last modified.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the job fails, provides information why the job failed.
" - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "The name of the created model.
" - } - }, - "SamplePayloadUrl": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix).
" - } - }, - "ModelPackageVersionArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a versioned model package.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure that contains a list of recommendation jobs.
" - } - }, - "com.amazonaws.sagemaker#InferenceRecommendationsJobStep": { - "type": "structure", - "members": { - "StepType": { - "target": "com.amazonaws.sagemaker#RecommendationStepType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of the subtask.
\n\n BENCHMARK: Evaluate the performance of your model on different instance types.
The name of the Inference Recommender job.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#RecommendationJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the benchmark.
", - "smithy.api#required": {} - } - }, - "InferenceBenchmark": { - "target": "com.amazonaws.sagemaker#RecommendationJobInferenceBenchmark", - "traits": { - "smithy.api#documentation": "The details for a specific benchmark.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A returned array object for the Steps response field in the\n ListInferenceRecommendationsJobSteps API command.
The Amazon ECR registry path of the Docker image that contains the inference code.
", - "smithy.api#required": {} - } - }, - "SupportedTransformInstanceTypes": { - "target": "com.amazonaws.sagemaker#TransformInstanceTypes", - "traits": { - "smithy.api#documentation": "A list of the instance types on which a transformation job can be run or on which an\n endpoint can be deployed.
\nThis parameter is required for unversioned models, and optional for versioned\n models.
" - } - }, - "SupportedRealtimeInferenceInstanceTypes": { - "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", - "traits": { - "smithy.api#documentation": "A list of the instance types that are used to generate inferences in real-time.
\nThis parameter is required for unversioned models, and optional for versioned\n models.
" - } - }, - "SupportedContentTypes": { - "target": "com.amazonaws.sagemaker#ContentTypes", - "traits": { - "smithy.api#documentation": "The supported MIME types for the input data.
" - } - }, - "SupportedResponseMIMETypes": { - "target": "com.amazonaws.sagemaker#ResponseMIMETypes", - "traits": { - "smithy.api#documentation": "The supported MIME types for the output data.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines how to perform inference generation after a training job is run.
" - } - }, - "com.amazonaws.sagemaker#InferenceSpecificationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#InfraCheckConfig": { - "type": "structure", - "members": { - "EnableInfraCheck": { - "target": "com.amazonaws.sagemaker#EnableInfraCheck", - "traits": { - "smithy.api#documentation": "Enables an infrastructure health check.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network \n connectivity.
" - } - }, - "com.amazonaws.sagemaker#InitialInstanceCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#InitialNumberOfUsers": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#InitialTaskCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#InputConfig": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix).
", - "smithy.api#required": {} - } - }, - "DataInputConfig": { - "target": "com.amazonaws.sagemaker#DataInputConfig", - "traits": { - "smithy.api#documentation": "Specifies the name and shape of the expected data inputs for your trained model with a\n JSON dictionary form. The data inputs are Framework specific.
\n TensorFlow: You must specify the name and shape (NHWC format) of\n the expected data inputs using a dictionary format for your trained model. The\n dictionary formats required for the console and CLI are different.
Examples for one input:
\nIf using the console,\n {\"input\":[1,1024,1024,3]}\n
If using the CLI,\n {\\\"input\\\":[1,1024,1024,3]}\n
Examples for two inputs:
\nIf using the console, {\"data1\": [1,28,28,1],\n \"data2\":[1,28,28,1]}\n
If using the CLI, {\\\"data1\\\": [1,28,28,1],\n \\\"data2\\\":[1,28,28,1]}\n
\n KERAS: You must specify the name and shape (NCHW format) of\n expected data inputs using a dictionary format for your trained model. Note that\n while Keras model artifacts should be uploaded in NHWC (channel-last) format,\n DataInputConfig should be specified in NCHW (channel-first)\n format. The dictionary formats required for the console and CLI are\n different.
Examples for one input:
\nIf using the console,\n {\"input_1\":[1,3,224,224]}\n
If using the CLI,\n {\\\"input_1\\\":[1,3,224,224]}\n
Examples for two inputs:
\nIf using the console, {\"input_1\": [1,3,224,224],\n \"input_2\":[1,3,224,224]} \n
If using the CLI, {\\\"input_1\\\": [1,3,224,224],\n \\\"input_2\\\":[1,3,224,224]}\n
\n MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW\n format) of the expected data inputs in order using a dictionary format for your\n trained model. The dictionary formats required for the console and CLI are\n different.
Examples for one input:
\nIf using the console,\n {\"data\":[1,3,1024,1024]}\n
If using the CLI,\n {\\\"data\\\":[1,3,1024,1024]}\n
Examples for two inputs:
\nIf using the console, {\"var1\": [1,1,28,28],\n \"var2\":[1,1,28,28]} \n
If using the CLI, {\\\"var1\\\": [1,1,28,28],\n \\\"var2\\\":[1,1,28,28]}\n
\n PyTorch: You can either specify the name and shape (NCHW format)\n of expected data inputs in order using a dictionary format for your trained\n model or you can specify the shape only using a list format. The dictionary\n formats required for the console and CLI are different. The list formats for the\n console and CLI are the same.
Examples for one input in dictionary format:
\nIf using the console,\n {\"input0\":[1,3,224,224]}\n
If using the CLI,\n {\\\"input0\\\":[1,3,224,224]}\n
Example for one input in list format:\n [[1,3,224,224]]\n
Examples for two inputs in dictionary format:
\nIf using the console, {\"input0\":[1,3,224,224],\n \"input1\":[1,3,224,224]}\n
If using the CLI, {\\\"input0\\\":[1,3,224,224],\n \\\"input1\\\":[1,3,224,224]} \n
Example for two inputs in list format: [[1,3,224,224],\n [1,3,224,224]]\n
\n XGBOOST: input data name and shape are not needed.
\n DataInputConfig supports the following parameters for CoreML\n TargetDevice (ML Model format):
\n shape: Input shape, for example {\"input_1\": {\"shape\":\n [1,224,224,3]}}. In addition to static input shapes, CoreML converter\n supports Flexible input shapes:
Range Dimension. You can use the Range Dimension feature if you know\n the input shape will be within some specific interval in that dimension,\n for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224,\n 3]}}\n
Enumerated shapes. Sometimes, the models are trained to work only on a\n select set of inputs. You can enumerate all supported input shapes, for\n example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160,\n 3]]}}\n
\n default_shape: Default input shape. You can set a default shape\n during conversion for both Range Dimension and Enumerated Shapes. For example\n {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1,\n 224, 224, 3]}}\n
\n type: Input type. Allowed values: Image and\n Tensor. By default, the converter generates an ML Model with\n inputs of type Tensor (MultiArray). User can set input type to be Image. Image\n input type requires additional input parameters such as bias and\n scale.
\n bias: If the input type is an Image, you need to provide the bias\n vector.
\n scale: If the input type is an Image, you need to provide a scale\n factor.
CoreML ClassifierConfig parameters can be specified using OutputConfig\n CompilerOptions. CoreML converter supports Tensorflow and PyTorch models.\n CoreML conversion examples:
Tensor type input:
\n\n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3],\n [1,160,160,3]], \"default_shape\": [1,224,224,3]}}\n
Tensor type input without input name (PyTorch):
\n\n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]],\n \"default_shape\": [1,3,224,224]}]\n
Image type input:
\n\n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3],\n [1,160,160,3]], \"default_shape\": [1,224,224,3], \"type\": \"Image\",\n \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}\n
\n \"CompilerOptions\": {\"class_labels\":\n \"imagenet_labels_1000.txt\"}\n
Image type input without input name (PyTorch):
\n\n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]],\n \"default_shape\": [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1],\n \"scale\": 0.007843137255}]\n
\n \"CompilerOptions\": {\"class_labels\":\n \"imagenet_labels_1000.txt\"}\n
Depending on the model format, DataInputConfig requires the following\n parameters for ml_eia2\n OutputConfig:TargetDevice.
For TensorFlow models saved in the SavedModel format, specify the input names\n from signature_def_key and the input model shapes for\n DataInputConfig. Specify the signature_def_key in\n \n OutputConfig:CompilerOptions\n if the model does not\n use TensorFlow's default signature def key. For example:
\n \"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}\n
\n \"CompilerOptions\": {\"signature_def_key\":\n \"serving_custom\"}\n
For TensorFlow models saved as a frozen graph, specify the input tensor names\n and shapes in DataInputConfig and the output tensor names for\n output_names in \n OutputConfig:CompilerOptions\n . For\n example:
\n \"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224,\n 3]}\n
\n \"CompilerOptions\": {\"output_names\":\n [\"output_tensor:0\"]}\n
Identifies the framework in which the model was trained. For example:\n TENSORFLOW.
", - "smithy.api#required": {} - } - }, - "FrameworkVersion": { - "target": "com.amazonaws.sagemaker#FrameworkVersion", - "traits": { - "smithy.api#documentation": "Specifies the framework version to use. This API field is only supported for the\n MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.
\nFor information about framework versions supported for cloud targets and edge devices,\n see Cloud\n Supported Instance Types and Frameworks and Edge Supported\n Frameworks.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the location of input model artifacts, the name and\n shape\n of the expected data inputs, and the framework in which the model was trained.
" - } - }, - "com.amazonaws.sagemaker#InputDataConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Channel" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#InputMode": { - "type": "enum", - "members": { - "PIPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pipe" - } - }, - "FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "File" - } - } - } - }, - "com.amazonaws.sagemaker#InputModes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrainingInputMode" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#InstanceCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#InstanceGroup": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.sagemaker#TrainingInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the instance type of the instance group.
", - "smithy.api#required": {} - } - }, - "InstanceCount": { - "target": "com.amazonaws.sagemaker#TrainingInstanceCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the number of instances of the instance group.
", - "smithy.api#required": {} - } - }, - "InstanceGroupName": { - "target": "com.amazonaws.sagemaker#InstanceGroupName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the name of the instance group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines an instance group for heterogeneous cluster training. When requesting a\n training job using the CreateTrainingJob API, you can configure multiple instance groups .
" - } - }, - "com.amazonaws.sagemaker#InstanceGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.sagemaker#InstanceGroupNames": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#InstanceGroupName" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#InstanceGroupStatus": { - "type": "enum", - "members": { - "INSERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "DEGRADED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Degraded" - } - }, - "SYSTEMUPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SystemUpdating" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.sagemaker#InstanceGroupTrainingPlanStatus": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - } - } - }, - "com.amazonaws.sagemaker#InstanceGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#InstanceGroup" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration": { - "type": "structure", - "members": { - "MinimumInstanceMetadataServiceVersion": { - "target": "com.amazonaws.sagemaker#MinimumInstanceMetadataServiceVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Indicates the minimum IMDS version that the notebook instance supports. When passed as\n part of CreateNotebookInstance, if no value is selected, then it defaults\n to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of\n UpdateNotebookInstance, there is no default.
Information on the IMDS configuration of the notebook instance
" - } - }, - "com.amazonaws.sagemaker#InstanceType": { - "type": "enum", - "members": { - "ML_T2_MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t2.medium" - } - }, - "ML_T2_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t2.large" - } - }, - "ML_T2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t2.xlarge" - } - }, - "ML_T2_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t2.2xlarge" - } - }, - "ML_T3_MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.medium" - } - }, - "ML_T3_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.large" - } - }, - "ML_T3_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.xlarge" - } - }, - "ML_T3_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t3.2xlarge" - } - }, - "ML_M4_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.xlarge" - } - }, - "ML_M4_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.2xlarge" - } - }, - "ML_M4_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.4xlarge" - } - }, - "ML_M4_10XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.10xlarge" - } - }, - "ML_M4_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.16xlarge" - } - }, - "ML_M5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.xlarge" - } - }, - "ML_M5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.2xlarge" - } - }, - "ML_M5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.4xlarge" - } - }, - "ML_M5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.12xlarge" - } - }, - "ML_M5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.24xlarge" - } - }, - "ML_M5D_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.large" - } - }, - "ML_M5D_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.xlarge" - } - }, - "ML_M5D_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.2xlarge" - } - }, - "ML_M5D_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.4xlarge" - } - }, - "ML_M5D_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.8xlarge" - } - }, - "ML_M5D_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.12xlarge" - } - }, - "ML_M5D_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.16xlarge" - } - }, - "ML_M5D_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.24xlarge" - } - }, - "ML_C4_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.xlarge" - } - }, - "ML_C4_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.2xlarge" - } - }, - "ML_C4_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.4xlarge" - } - }, - "ML_C4_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.8xlarge" - } - }, - "ML_C5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.xlarge" - } - }, - "ML_C5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.2xlarge" - } - }, - "ML_C5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.4xlarge" - } - }, - "ML_C5_9XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.9xlarge" - } - }, - "ML_C5_18XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.18xlarge" - } - }, - "ML_C5D_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.xlarge" - } - }, - "ML_C5D_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.2xlarge" - } - }, - "ML_C5D_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.4xlarge" - } - }, - "ML_C5D_9XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.9xlarge" - } - }, - "ML_C5D_18XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.18xlarge" - } - }, - "ML_P2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p2.xlarge" - } - }, - "ML_P2_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p2.8xlarge" - } - }, - "ML_P2_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p2.16xlarge" - } - }, - "ML_P3_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.2xlarge" - } - }, - "ML_P3_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.8xlarge" - } - }, - "ML_P3_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.16xlarge" - } - }, - "ML_P3DN_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3dn.24xlarge" - } - }, - "ML_G4DN_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.xlarge" - } - }, - "ML_G4DN_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.2xlarge" - } - }, - "ML_G4DN_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.4xlarge" - } - }, - "ML_G4DN_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.8xlarge" - } - }, - "ML_G4DN_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.12xlarge" - } - }, - "ML_G4DN_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.16xlarge" - } - }, - "ML_R5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.large" - } - }, - "ML_R5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.xlarge" - } - }, - "ML_R5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.2xlarge" - } - }, - "ML_R5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.4xlarge" - } - }, - "ML_R5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.8xlarge" - } - }, - "ML_R5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.12xlarge" - } - }, - "ML_R5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.16xlarge" - } - }, - "ML_R5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.24xlarge" - } - }, - "ML_G5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.xlarge" - } - }, - "ML_G5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.2xlarge" - } - }, - "ML_G5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.4xlarge" - } - }, - "ML_G5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.8xlarge" - } - }, - "ML_G5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.16xlarge" - } - }, - "ML_G5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.12xlarge" - } - }, - "ML_G5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.24xlarge" - } - }, - "ML_G5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.48xlarge" - } - }, - "ML_INF1_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf1.xlarge" - } - }, - "ML_INF1_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf1.2xlarge" - } - }, - "ML_INF1_6XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf1.6xlarge" - } - }, - "ML_INF1_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf1.24xlarge" - } - }, - "ML_TRN1_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.2xlarge" - } - }, - "ML_TRN1_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.32xlarge" - } - }, - "ML_TRN1N_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1n.32xlarge" - } - }, - "ML_INF2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.xlarge" - } - }, - "ML_INF2_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.8xlarge" - } - }, - "ML_INF2_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.24xlarge" - } - }, - "ML_INF2_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.48xlarge" - } - }, - "ML_P4D_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4d.24xlarge" - } - }, - "ML_P4DE_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4de.24xlarge" - } - }, - "ML_P5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p5.48xlarge" - } - }, - "ML_M6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.large" - } - }, - "ML_M6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.xlarge" - } - }, - "ML_M6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.2xlarge" - } - }, - "ML_M6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.4xlarge" - } - }, - "ML_M6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.8xlarge" - } - }, - "ML_M6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.12xlarge" - } - }, - "ML_M6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.16xlarge" - } - }, - "ML_M6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.24xlarge" - } - }, - "ML_M6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.32xlarge" - } - }, - "ML_M7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.large" - } - }, - "ML_M7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.xlarge" - } - }, - "ML_M7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.2xlarge" - } - }, - "ML_M7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.4xlarge" - } - }, - "ML_M7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.8xlarge" - } - }, - "ML_M7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.12xlarge" - } - }, - "ML_M7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.16xlarge" - } - }, - "ML_M7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.24xlarge" - } - }, - "ML_M7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.48xlarge" - } - }, - "ML_C6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.large" - } - }, - "ML_C6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.xlarge" - } - }, - "ML_C6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.2xlarge" - } - }, - "ML_C6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.4xlarge" - } - }, - "ML_C6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.8xlarge" - } - }, - "ML_C6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.12xlarge" - } - }, - "ML_C6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.16xlarge" - } - }, - "ML_C6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.24xlarge" - } - }, - "ML_C6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.32xlarge" - } - }, - "ML_C7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.large" - } - }, - "ML_C7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.xlarge" - } - }, - "ML_C7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.2xlarge" - } - }, - "ML_C7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.4xlarge" - } - }, - "ML_C7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.8xlarge" - } - }, - "ML_C7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.12xlarge" - } - }, - "ML_C7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.16xlarge" - } - }, - "ML_C7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.24xlarge" - } - }, - "ML_C7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.48xlarge" - } - }, - "ML_R6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.large" - } - }, - "ML_R6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.xlarge" - } - }, - "ML_R6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.2xlarge" - } - }, - "ML_R6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.4xlarge" - } - }, - "ML_R6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.8xlarge" - } - }, - "ML_R6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.12xlarge" - } - }, - "ML_R6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.16xlarge" - } - }, - "ML_R6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.24xlarge" - } - }, - "ML_R6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.32xlarge" - } - }, - "ML_R7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.large" - } - }, - "ML_R7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.xlarge" - } - }, - "ML_R7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.2xlarge" - } - }, - "ML_R7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.4xlarge" - } - }, - "ML_R7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.8xlarge" - } - }, - "ML_R7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.12xlarge" - } - }, - "ML_R7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.16xlarge" - } - }, - "ML_R7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.24xlarge" - } - }, - "ML_R7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.48xlarge" - } - }, - "ML_M6ID_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.large" - } - }, - "ML_M6ID_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.xlarge" - } - }, - "ML_M6ID_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.2xlarge" - } - }, - "ML_M6ID_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.4xlarge" - } - }, - "ML_M6ID_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.8xlarge" - } - }, - "ML_M6ID_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.12xlarge" - } - }, - "ML_M6ID_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.16xlarge" - } - }, - "ML_M6ID_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.24xlarge" - } - }, - "ML_M6ID_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6id.32xlarge" - } - }, - "ML_C6ID_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.large" - } - }, - "ML_C6ID_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.xlarge" - } - }, - "ML_C6ID_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.2xlarge" - } - }, - "ML_C6ID_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.4xlarge" - } - }, - "ML_C6ID_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.8xlarge" - } - }, - "ML_C6ID_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.12xlarge" - } - }, - "ML_C6ID_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.16xlarge" - } - }, - "ML_C6ID_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.24xlarge" - } - }, - "ML_C6ID_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6id.32xlarge" - } - }, - "ML_R6ID_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.large" - } - }, - "ML_R6ID_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.xlarge" - } - }, - "ML_R6ID_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.2xlarge" - } - }, - "ML_R6ID_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.4xlarge" - } - }, - "ML_R6ID_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.8xlarge" - } - }, - "ML_R6ID_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.12xlarge" - } - }, - "ML_R6ID_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.16xlarge" - } - }, - "ML_R6ID_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.24xlarge" - } - }, - "ML_R6ID_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6id.32xlarge" - } - }, - "ML_G6_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.xlarge" - } - }, - "ML_G6_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.2xlarge" - } - }, - "ML_G6_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.4xlarge" - } - }, - "ML_G6_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.8xlarge" - } - }, - "ML_G6_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.12xlarge" - } - }, - "ML_G6_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.16xlarge" - } - }, - "ML_G6_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.24xlarge" - } - }, - "ML_G6_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.48xlarge" - } - } - } - }, - "com.amazonaws.sagemaker#Integer": { - "type": "integer" - }, - "com.amazonaws.sagemaker#IntegerParameterRange": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#ParameterKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hyperparameter to search.
", - "smithy.api#required": {} - } - }, - "MinValue": { - "target": "com.amazonaws.sagemaker#ParameterValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The minimum\n value\n of the hyperparameter to search.
", - "smithy.api#required": {} - } - }, - "MaxValue": { - "target": "com.amazonaws.sagemaker#ParameterValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum\n value\n of the hyperparameter to search.
", - "smithy.api#required": {} - } - }, - "ScalingType": { - "target": "com.amazonaws.sagemaker#HyperParameterScalingType", - "traits": { - "smithy.api#documentation": "The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
\nSageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.
\nLogarithmic scaling works only for ranges that have only values greater\n than 0.
\nFor a hyperparameter of the integer type, specifies the range\n that\n a hyperparameter tuning job searches.
" - } - }, - "com.amazonaws.sagemaker#IntegerParameterRangeSpecification": { - "type": "structure", - "members": { - "MinValue": { - "target": "com.amazonaws.sagemaker#ParameterValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The minimum integer value allowed.
", - "smithy.api#required": {} - } - }, - "MaxValue": { - "target": "com.amazonaws.sagemaker#ParameterValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum integer value allowed.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the possible values for an integer hyperparameter.
" - } - }, - "com.amazonaws.sagemaker#IntegerParameterRanges": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#IntegerParameterRange" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.sagemaker#InvocationEndTime": { - "type": "timestamp" - }, - "com.amazonaws.sagemaker#InvocationStartTime": { - "type": "timestamp" - }, - "com.amazonaws.sagemaker#InvocationsMaxRetries": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 3600 - } - } - }, - "com.amazonaws.sagemaker#IotRoleAlias": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.sagemaker#IsTrackingServerActive": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Inactive" - } - } - } - }, - "com.amazonaws.sagemaker#ItemIdentifierAttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#JobDurationInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#JobReferenceCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.sagemaker#JobReferenceCodeContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.sagemaker#JobType": { - "type": "enum", - "members": { - "TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRAINING" - } - }, - "INFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFERENCE" - } - }, - "NOTEBOOK_KERNEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOTEBOOK_KERNEL" - } - } - } - }, - "com.amazonaws.sagemaker#JoinSource": { - "type": "enum", - "members": { - "INPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Input" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - } - } - }, - "com.amazonaws.sagemaker#JsonContentType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*$" - } - }, - "com.amazonaws.sagemaker#JsonContentTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#JsonContentType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#JsonPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - } - } - }, - "com.amazonaws.sagemaker#JupyterLabAppImageConfig": { - "type": "structure", - "members": { - "FileSystemConfig": { - "target": "com.amazonaws.sagemaker#FileSystemConfig" - }, - "ContainerConfig": { - "target": "com.amazonaws.sagemaker#ContainerConfig" - } - }, - "traits": { - "smithy.api#documentation": "The configuration for the file system and kernels in a SageMaker AI image running as a JupyterLab app. The FileSystemConfig object is not supported.
A list of custom SageMaker images that are configured to run as a JupyterLab app.
" - } - }, - "LifecycleConfigArns": { - "target": "com.amazonaws.sagemaker#LifecycleConfigArns", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
" - } - }, - "AppLifecycleManagement": { - "target": "com.amazonaws.sagemaker#AppLifecycleManagement", - "traits": { - "smithy.api#documentation": "Indicates whether idle shutdown is activated for JupyterLab applications.
" - } - }, - "EmrSettings": { - "target": "com.amazonaws.sagemaker#EmrSettings", - "traits": { - "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.
" - } - }, - "BuiltInLifecycleConfigArn": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", - "traits": { - "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The settings for the JupyterLab application.
" - } - }, - "com.amazonaws.sagemaker#JupyterServerAppSettings": { - "type": "structure", - "members": { - "DefaultResourceSpec": { - "target": "com.amazonaws.sagemaker#ResourceSpec", - "traits": { - "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the\n LifecycleConfigArns parameter, then this parameter is also required.
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the\n JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is\n also required.
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.
A list of Git repositories that SageMaker AI automatically displays to users for\n cloning in the JupyterServer application.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The JupyterServer app settings.
" - } - }, - "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds": { - "type": "integer", - "traits": { - "smithy.api#documentation": "Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.", - "smithy.api#range": { - "min": 0, - "max": 3600 - } - } - }, - "com.amazonaws.sagemaker#KendraSettings": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#FeatureStatus", - "traits": { - "smithy.api#documentation": "Describes whether the document querying feature is enabled\n or disabled in the Canvas application.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon SageMaker Canvas application setting where you configure\n document querying.
" - } - }, - "com.amazonaws.sagemaker#KernelDisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.sagemaker#KernelGatewayAppSettings": { - "type": "structure", - "members": { - "DefaultResourceSpec": { - "target": "com.amazonaws.sagemaker#ResourceSpec", - "traits": { - "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.
\nThe Amazon SageMaker AI Studio UI does not use the default instance type value set\n here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not\n passed.
\nA list of custom SageMaker AI images that are configured to run as a KernelGateway\n app.
" - } - }, - "LifecycleConfigArns": { - "target": "com.amazonaws.sagemaker#LifecycleConfigArns", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user\n profile or domain.
\nTo remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.
The KernelGateway app settings.
" - } - }, - "com.amazonaws.sagemaker#KernelGatewayImageConfig": { - "type": "structure", - "members": { - "KernelSpecs": { - "target": "com.amazonaws.sagemaker#KernelSpecs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The specification of the Jupyter kernels in the image.
", - "smithy.api#required": {} - } - }, - "FileSystemConfig": { - "target": "com.amazonaws.sagemaker#FileSystemConfig", - "traits": { - "smithy.api#documentation": "The Amazon Elastic File System storage configuration for a SageMaker AI image.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for the file system and kernels in a SageMaker AI image running as a\n KernelGateway app.
" - } - }, - "com.amazonaws.sagemaker#KernelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.sagemaker#KernelSpec": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#KernelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Jupyter kernel in the image. This value is case sensitive.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#KernelDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the kernel.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specification of a Jupyter kernel.
" - } - }, - "com.amazonaws.sagemaker#KernelSpecs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#KernelSpec" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.sagemaker#KmsKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^[a-zA-Z0-9:/_-]*$" - } - }, - "com.amazonaws.sagemaker#LabelAttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}$" - } - }, - "com.amazonaws.sagemaker#LabelCounter": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#LabelCounters": { - "type": "structure", - "members": { - "TotalLabeled": { - "target": "com.amazonaws.sagemaker#LabelCounter", - "traits": { - "smithy.api#documentation": "The total number of objects labeled.
" - } - }, - "HumanLabeled": { - "target": "com.amazonaws.sagemaker#LabelCounter", - "traits": { - "smithy.api#documentation": "The total number of objects labeled by a human worker.
" - } - }, - "MachineLabeled": { - "target": "com.amazonaws.sagemaker#LabelCounter", - "traits": { - "smithy.api#documentation": "The total number of objects labeled by automated data labeling.
" - } - }, - "FailedNonRetryableError": { - "target": "com.amazonaws.sagemaker#LabelCounter", - "traits": { - "smithy.api#documentation": "The total number of objects that could not be labeled due to an error.
" - } - }, - "Unlabeled": { - "target": "com.amazonaws.sagemaker#LabelCounter", - "traits": { - "smithy.api#documentation": "The total number of objects not yet labeled.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides a breakdown of the number of objects labeled.
" - } - }, - "com.amazonaws.sagemaker#LabelCountersForWorkteam": { - "type": "structure", - "members": { - "HumanLabeled": { - "target": "com.amazonaws.sagemaker#LabelCounter", - "traits": { - "smithy.api#documentation": "The total number of data objects labeled by a human worker.
" - } - }, - "PendingHuman": { - "target": "com.amazonaws.sagemaker#LabelCounter", - "traits": { - "smithy.api#documentation": "The total number of data objects that need to be labeled by a human worker.
" - } - }, - "Total": { - "target": "com.amazonaws.sagemaker#LabelCounter", - "traits": { - "smithy.api#documentation": "The total number of tasks in the labeling job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides counts for human-labeled tasks in the labeling job.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobAlgorithmSpecificationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^arn:" - } - }, - "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig": { - "type": "structure", - "members": { - "LabelingJobAlgorithmSpecificationArn": { - "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmSpecificationArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You\n must select one of the following ARNs:
\n\n Image classification\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification\n
\n Text classification\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification\n
\n Object detection\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection\n
\n Semantic Segmentation\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation\n
At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final\n model used for auto-labeling. You can use this model as the starting point for\n subsequent similar jobs by providing the ARN of the model here.
" - } - }, - "LabelingJobResourceConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobResourceConfig", - "traits": { - "smithy.api#documentation": "Provides configuration information for a labeling job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides configuration information for auto-labeling of your data objects. A\n LabelingJobAlgorithmsConfig object must be supplied in order to use\n auto-labeling.
Declares that your content is free of personally identifiable information or adult\n content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task\n based on this information.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Attributes of the data specified by the customer. Use these to describe the data to be\n labeled.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobDataSource": { - "type": "structure", - "members": { - "S3DataSource": { - "target": "com.amazonaws.sagemaker#LabelingJobS3DataSource", - "traits": { - "smithy.api#documentation": "The Amazon S3 location of the input data objects.
" - } - }, - "SnsDataSource": { - "target": "com.amazonaws.sagemaker#LabelingJobSnsDataSource", - "traits": { - "smithy.api#documentation": "An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about the location of input data.
\nYou must specify at least one of the following: S3DataSource or SnsDataSource.
Use SnsDataSource to specify an SNS input topic\n for a streaming labeling job. If you do not specify \n and SNS input topic ARN, Ground Truth will create a one-time labeling job.
Use S3DataSource to specify an input \n manifest file for both streaming and one-time labeling jobs.\n Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.
The name of the labeling job that the work team is assigned to.
" - } - }, - "JobReferenceCode": { - "target": "com.amazonaws.sagemaker#JobReferenceCode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique identifier for a labeling job. You can use this to refer to a specific\n labeling job.
", - "smithy.api#required": {} - } - }, - "WorkRequesterAccountId": { - "target": "com.amazonaws.sagemaker#AccountId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Web Services account ID of the account used to start the labeling\n job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the labeling job was created.
", - "smithy.api#required": {} - } - }, - "LabelCounters": { - "target": "com.amazonaws.sagemaker#LabelCountersForWorkteam", - "traits": { - "smithy.api#documentation": "Provides information about the progress of a labeling job.
" - } - }, - "NumberOfHumanWorkersPerDataObject": { - "target": "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject", - "traits": { - "smithy.api#documentation": "The configured number of workers per data object.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides summary information for a work team.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobForWorkteamSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#LabelingJobForWorkteamSummary" - } - }, - "com.amazonaws.sagemaker#LabelingJobInputConfig": { - "type": "structure", - "members": { - "DataSource": { - "target": "com.amazonaws.sagemaker#LabelingJobDataSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location of the input data.
", - "smithy.api#required": {} - } - }, - "DataAttributes": { - "target": "com.amazonaws.sagemaker#LabelingJobDataAttributes", - "traits": { - "smithy.api#documentation": "Attributes of the data specified by the customer.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Input configuration information for a labeling job.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#LabelingJobOutput": { - "type": "structure", - "members": { - "OutputDatasetS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 bucket location of the manifest file for labeled data.
", - "smithy.api#required": {} - } - }, - "FinalActiveLearningModelArn": { - "target": "com.amazonaws.sagemaker#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of\n automated data labeling.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the location of the output produced by the labeling job.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobOutputConfig": { - "type": "structure", - "members": { - "S3OutputPath": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 location to write output data.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.
\nIf you provide your own KMS key ID, you must add the required permissions to your KMS\n key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.
\nIf you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your\n role's account to encrypt your output data.
\nIf you use a bucket policy with an s3:PutObject permission that only\n allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n
An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to\n do real time chaining to another streaming job and receive an Amazon SNS notifications each\n time a data object is submitted by a worker.
If you provide an SnsTopicArn in OutputConfig, when workers\n complete labeling tasks, Ground Truth will send labeling task output data to the SNS output\n topic you specify here.
To learn more, see Receive Output Data from a Streaming Labeling\n Job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Output configuration information for a labeling job.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobResourceConfig": { - "type": "structure", - "members": { - "VolumeKmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training and inference jobs used for\n automated data labeling.
\nYou can only specify a VolumeKmsKeyId when you create a labeling job with\n automated data labeling enabled using the API operation CreateLabelingJob.\n You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for\n automated data labeling model training and inference when you create a labeling job\n using the console. To learn more, see Output Data and Storage Volume\n Encryption.
The VolumeKmsKeyId can be any of the following formats:
KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configure encryption on the storage volume attached to the ML compute instance used to\n run automated data labeling model training and inference.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobS3DataSource": { - "type": "structure", - "members": { - "ManifestS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 location of the manifest file that describes the input data objects.
\nThe input manifest file referenced in ManifestS3Uri must contain one of\n the following keys: source-ref or source. The value of the\n keys are interpreted as follows:
\n source-ref: The source of the object is the Amazon S3 object\n specified in the value. Use this value when the object is a binary object, such\n as an image.
\n source: The source of the object is the value. Use this\n value when the object is a text value.
If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to\n create an input manifest file.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon S3 location of the input data objects.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobSnsDataSource": { - "type": "structure", - "members": { - "SnsTopicArn": { - "target": "com.amazonaws.sagemaker#SnsTopicArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic\n you will use to send new data objects to a streaming labeling job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "An Amazon SNS data source used for streaming labeling jobs.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobStatus": { - "type": "enum", - "members": { - "INITIALIZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Initializing" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#LabelingJobStoppingConditions": { - "type": "structure", - "members": { - "MaxHumanLabeledObjectCount": { - "target": "com.amazonaws.sagemaker#MaxHumanLabeledObjectCount", - "traits": { - "smithy.api#documentation": "The maximum number of objects that can be labeled by human workers.
" - } - }, - "MaxPercentageOfInputDatasetLabeled": { - "target": "com.amazonaws.sagemaker#MaxPercentageOfInputDatasetLabeled", - "traits": { - "smithy.api#documentation": "The maximum number of input data objects that should be labeled.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped. You can use these conditions to control the cost of data\n labeling.
\nLabeling jobs fail after 30 days with an appropriate client error message.
\nThe name of the labeling job.
", - "smithy.api#required": {} - } - }, - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the labeling job when it was\n created.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the job was created (timestamp).
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the job was last modified (timestamp).
", - "smithy.api#required": {} - } - }, - "LabelingJobStatus": { - "target": "com.amazonaws.sagemaker#LabelingJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the labeling job.
", - "smithy.api#required": {} - } - }, - "LabelCounters": { - "target": "com.amazonaws.sagemaker#LabelCounters", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Counts showing the progress of the labeling job.
", - "smithy.api#required": {} - } - }, - "WorkteamArn": { - "target": "com.amazonaws.sagemaker#WorkteamArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team assigned to the job.
", - "smithy.api#required": {} - } - }, - "PreHumanTaskLambdaArn": { - "target": "com.amazonaws.sagemaker#LambdaFunctionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function. The function is run before each\n data object is sent to a worker.
" - } - }, - "AnnotationConsolidationLambdaArn": { - "target": "com.amazonaws.sagemaker#LambdaFunctionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function used to consolidate the\n annotations from individual workers into a label for a data object. For more\n information, see Annotation\n Consolidation.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the LabelingJobStatus field is Failed, this field\n contains a description of the error.
The location of the output produced by the labeling job.
" - } - }, - "InputConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", - "traits": { - "smithy.api#documentation": "Input configuration for the labeling job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides summary information about a labeling job.
" - } - }, - "com.amazonaws.sagemaker#LabelingJobSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#LabelingJobSummary" - } - }, - "com.amazonaws.sagemaker#LambdaFunctionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:" - } - }, - "com.amazonaws.sagemaker#LambdaStepMetadata": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.
" - } - }, - "OutputParameters": { - "target": "com.amazonaws.sagemaker#OutputParameterList", - "traits": { - "smithy.api#documentation": "A list of the output parameters of the Lambda step.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for a Lambda step.
" - } - }, - "com.amazonaws.sagemaker#LandingUri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1023 - } - } - }, - "com.amazonaws.sagemaker#LastModifiedTime": { - "type": "timestamp" - }, - "com.amazonaws.sagemaker#LastUpdateStatus": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#LastUpdateStatusValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A value that indicates whether the update was made successful.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the update wasn't successful, indicates the reason why it failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A value that indicates whether the update was successful.
" - } - }, - "com.amazonaws.sagemaker#LastUpdateStatusValue": { - "type": "enum", - "members": { - "SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Successful" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - } - } - }, - "com.amazonaws.sagemaker#LifecycleConfigArns": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn" - } - }, - "com.amazonaws.sagemaker#LifecycleManagement": { - "type": "enum", - "members": { - "Enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "Disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.sagemaker#LineageEntityParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#StringParameterValue" - }, - "value": { - "target": "com.amazonaws.sagemaker#StringParameterValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.sagemaker#LineageGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/" - } - }, - "com.amazonaws.sagemaker#LineageGroupNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})$" - } - }, - "com.amazonaws.sagemaker#LineageGroupSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#LineageGroupSummary" - } - }, - "com.amazonaws.sagemaker#LineageGroupSummary": { - "type": "structure", - "members": { - "LineageGroupArn": { - "target": "com.amazonaws.sagemaker#LineageGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group resource.
" - } - }, - "LineageGroupName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the lineage group.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The display name of the lineage group summary.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the lineage group summary.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The last modified time of the lineage group summary.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity \n resources.
" - } - }, - "com.amazonaws.sagemaker#LineageType": { - "type": "enum", - "members": { - "TRIAL_COMPONENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TrialComponent" - } - }, - "ARTIFACT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Artifact" - } - }, - "CONTEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Context" - } - }, - "ACTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Action" - } - } - } - }, - "com.amazonaws.sagemaker#ListActions": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListActionsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListActionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Lists the actions in your account and their properties.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ActionSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListActionsRequest": { - "type": "structure", - "members": { - "SourceUri": { - "target": "com.amazonaws.sagemaker#SourceUri", - "traits": { - "smithy.api#documentation": "A filter that returns only actions with the specified source URI.
" - } - }, - "ActionType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "A filter that returns only actions of the specified type.
" - } - }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only actions created on or after the specified time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only actions created on or before the specified time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortActionsBy", - "traits": { - "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListActions didn't return the full set of actions,\n the call returns a token for getting the next set of actions.
The maximum number of actions to return in the response. The default value is 10.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListActionsResponse": { - "type": "structure", - "members": { - "ActionSummaries": { - "target": "com.amazonaws.sagemaker#ActionSummaries", - "traits": { - "smithy.api#documentation": "A list of actions and their properties.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of actions, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListAlgorithms": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListAlgorithmsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListAlgorithmsOutput" - }, - "traits": { - "smithy.api#documentation": "Lists the machine learning algorithms that have been created.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AlgorithmSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListAlgorithmsInput": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only algorithms created after the specified time\n (timestamp).
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only algorithms created before the specified time\n (timestamp).
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of algorithms to return in the response.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "A string in the algorithm name. This filter returns only algorithms whose name\n contains the specified string.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to a previous ListAlgorithms request was truncated, the\n response includes a NextToken. To retrieve the next set of algorithms, use\n the token in the next request.
The parameter by which to sort the results. The default is\n CreationTime.
The sort order for the results. The default is Ascending.
>An array of AlgorithmSummary objects, each of which lists an\n algorithm.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListAliases": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListAliasesRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListAliasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Lists the aliases of a specified image or image version.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SageMakerImageVersionAliases", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListAliasesRequest": { - "type": "structure", - "members": { - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image.
", - "smithy.api#required": {} - } - }, - "Alias": { - "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", - "traits": { - "smithy.api#documentation": "The alias of the image version.
" - } - }, - "Version": { - "target": "com.amazonaws.sagemaker#ImageVersionNumber", - "traits": { - "smithy.api#documentation": "The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of aliases to return.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous call to ListAliases didn't return the full set of\n aliases, the call returns a token for retrieving the next set of aliases.
A list of SageMaker AI image version aliases.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of aliases, if more aliases exist.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListAppImageConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListAppImageConfigsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListAppImageConfigsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists the AppImageConfigs in your account and their properties. The list can be\n filtered by creation time or modified time, and whether the AppImageConfig name contains\n a specified string.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AppImageConfigs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListAppImageConfigsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
If the previous call to ListImages didn't return the full set of\n AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
A filter that returns only AppImageConfigs whose name contains the specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only AppImageConfigs created on or before the specified time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only AppImageConfigs created on or after the specified time.
" - } - }, - "ModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only AppImageConfigs modified on or before the specified time.
" - } - }, - "ModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only AppImageConfigs modified on or after the specified time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#AppImageConfigSortKey", - "traits": { - "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
A token for getting the next set of AppImageConfigs, if there are any.
" - } - }, - "AppImageConfigs": { - "target": "com.amazonaws.sagemaker#AppImageConfigList", - "traits": { - "smithy.api#documentation": "A list of AppImageConfigs and their properties.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListApps": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListAppsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListAppsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists apps.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Apps", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListAppsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
The sort order for the results. The default is Ascending.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#AppSortKey", - "traits": { - "smithy.api#documentation": "The parameter by which to sort the results. The default is CreationTime.
" - } - }, - "DomainIdEquals": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "A parameter to search for the domain ID.
" - } - }, - "UserProfileNameEquals": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "A parameter to search by user profile name. If SpaceNameEquals is set, then\n this value cannot be set.
A parameter to search by space name. If UserProfileNameEquals is set, then\n this value cannot be set.
The list of apps.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListArtifacts": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListArtifactsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListArtifactsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Lists the artifacts in your account and their properties.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ArtifactSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListArtifactsRequest": { - "type": "structure", - "members": { - "SourceUri": { - "target": "com.amazonaws.sagemaker#SourceUri", - "traits": { - "smithy.api#documentation": "A filter that returns only artifacts with the specified source URI.
" - } - }, - "ArtifactType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "A filter that returns only artifacts of the specified type.
" - } - }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only artifacts created on or after the specified time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only artifacts created on or before the specified time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortArtifactsBy", - "traits": { - "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListArtifacts didn't return the full set of artifacts,\n the call returns a token for getting the next set of artifacts.
The maximum number of artifacts to return in the response. The default value is 10.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListArtifactsResponse": { - "type": "structure", - "members": { - "ArtifactSummaries": { - "target": "com.amazonaws.sagemaker#ArtifactSummaries", - "traits": { - "smithy.api#documentation": "A list of artifacts and their properties.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of artifacts, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListAssociationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Lists the associations in your account and their properties.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AssociationSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListAssociationsRequest": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#documentation": "A filter that returns only associations with the specified source ARN.
" - } - }, - "DestinationArn": { - "target": "com.amazonaws.sagemaker#AssociationEntityArn", - "traits": { - "smithy.api#documentation": "A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
" - } - }, - "SourceType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "A filter that returns only associations with the specified source type.
" - } - }, - "DestinationType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "A filter that returns only associations with the specified destination type.
" - } - }, - "AssociationType": { - "target": "com.amazonaws.sagemaker#AssociationEdgeType", - "traits": { - "smithy.api#documentation": "A filter that returns only associations of the specified type.
" - } - }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only associations created on or after the specified time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only associations created on or before the specified time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortAssociationsBy", - "traits": { - "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListAssociations didn't return the full set of associations,\n the call returns a token for getting the next set of associations.
The maximum number of associations to return in the response. The default value is 10.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListAssociationsResponse": { - "type": "structure", - "members": { - "AssociationSummaries": { - "target": "com.amazonaws.sagemaker#AssociationSummaries", - "traits": { - "smithy.api#documentation": "A list of associations and their properties.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of associations, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListAutoMLJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListAutoMLJobsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListAutoMLJobsResponse" - }, - "traits": { - "smithy.api#documentation": "Request a list of jobs.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AutoMLJobSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListAutoMLJobsRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Request a list of jobs, using a filter for time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Request a list of jobs, using a filter for time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Request a list of jobs, using a filter for time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Request a list of jobs, using a filter for time.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#AutoMLNameContains", - "traits": { - "smithy.api#documentation": "Request a list of jobs, using a search filter for name.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#AutoMLJobStatus", - "traits": { - "smithy.api#documentation": "Request a list of jobs, using a filter for status.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#AutoMLSortOrder", - "traits": { - "smithy.api#documentation": "The sort order for the results. The default is Descending.
The parameter by which to sort the results. The default is Name.
Request a list of jobs up to a specified limit.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListAutoMLJobsResponse": { - "type": "structure", - "members": { - "AutoMLJobSummaries": { - "target": "com.amazonaws.sagemaker#AutoMLJobSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns a summary list of jobs.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListCandidatesForAutoMLJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "List the candidates created for the job.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Candidates", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobRequest": { - "type": "structure", - "members": { - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List the candidates created for the job by providing the job's name.
", - "smithy.api#required": {} - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#CandidateStatus", - "traits": { - "smithy.api#documentation": "List the candidates for the job and filter by status.
" - } - }, - "CandidateNameEquals": { - "target": "com.amazonaws.sagemaker#CandidateName", - "traits": { - "smithy.api#documentation": "List the candidates for the job and filter by candidate name.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#AutoMLSortOrder", - "traits": { - "smithy.api#documentation": "The sort order for the results. The default is Ascending.
The parameter by which to sort the results. The default is\n Descending.
List the job's candidates up to a specified limit.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobResponse": { - "type": "structure", - "members": { - "Candidates": { - "target": "com.amazonaws.sagemaker#AutoMLCandidates", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Summaries about the AutoMLCandidates.
If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListClusterNodes": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListClusterNodesRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListClusterNodesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves the list of instances (also called nodes interchangeably)\n in a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#ListClusterNodesRequest": { - "type": "structure", - "members": { - "ClusterName": { - "target": "com.amazonaws.sagemaker#ClusterNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the\n list of nodes.
", - "smithy.api#required": {} - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time.\n Timestamps are formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
A filter that returns the instance groups whose name contain a specified string.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of nodes to return in the response.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListClusterNodes request was truncated, the\n response includes a NextToken. To retrieve the next set of cluster nodes, use\n the token in the next request.
The field by which to sort results. The default value is\n CREATION_TIME.
The sort order for results. The default value is Ascending.
The next token specified for listing instances in a SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - }, - "ClusterNodeSummaries": { - "target": "com.amazonaws.sagemaker#ClusterNodeSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The summaries of listed instances in a SageMaker HyperPod cluster
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListClusterSchedulerConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigsResponse" - }, - "traits": { - "smithy.api#documentation": "List the cluster policy configurations.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ClusterSchedulerConfigSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListClusterSchedulerConfigsRequest": { - "type": "structure", - "members": { - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "Filter for name containing this string.
" - } - }, - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#documentation": "Filter for ARN of the cluster.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", - "traits": { - "smithy.api#documentation": "Filter for status.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortClusterSchedulerConfigBy", - "traits": { - "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of cluster policies to list.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListClusterSchedulerConfigsResponse": { - "type": "structure", - "members": { - "ClusterSchedulerConfigSummaries": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigSummaryList", - "traits": { - "smithy.api#documentation": "Summaries of the cluster policies.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListClustersRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListClustersResponse" - }, - "traits": { - "smithy.api#documentation": "Retrieves the list of SageMaker HyperPod clusters.
" - } - }, - "com.amazonaws.sagemaker#ListClustersRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Set a start time for the time range during which you want to list SageMaker HyperPod clusters.\n Timestamps are formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
Set the maximum number of SageMaker HyperPod clusters to list.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Set the maximum number of instances to print in the list.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "Set the next token to retrieve the list of SageMaker HyperPod clusters.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ClusterSortBy", - "traits": { - "smithy.api#documentation": "The field by which to sort results. The default value is\n CREATION_TIME.
The sort order for results. The default value is Ascending.
The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about\n reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
If the result of the previous ListClusters request was truncated, the\n response includes a NextToken. To retrieve the next set of clusters, use the\n token in the next request.
The summaries of listed SageMaker HyperPod clusters.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListCodeRepositories": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListCodeRepositoriesInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListCodeRepositoriesOutput" - }, - "traits": { - "smithy.api#documentation": "Gets a list of the Git repositories in your account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CodeRepositorySummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListCodeRepositoriesInput": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only Git repositories that were created after the specified\n time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only Git repositories that were created before the specified\n time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only Git repositories that were last modified after the\n specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only Git repositories that were last modified before the\n specified time.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of Git repositories to return in the response.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameContains", - "traits": { - "smithy.api#documentation": "A string in the Git repositories name. This filter returns only repositories whose\n name contains the specified string.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.
The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:
\nName
\nAmazon Resource Name (ARN)
\nCreation time
\nLast modified time
\nConfiguration information, including the URL location of the repository and\n the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.
\nIf the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.
Lists model compilation jobs that satisfy various filters.
\nTo create a model compilation job, use CreateCompilationJob. To get information about a particular model\n compilation job you have created, use DescribeCompilationJob.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CompilationJobSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListCompilationJobsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.
The maximum number of model compilation jobs to return in the response.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns the model compilation jobs that were created after a specified\n time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns the model compilation jobs that were created before a specified\n time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A filter that returns the model compilation jobs that were modified after a specified\n time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A filter that returns the model compilation jobs that were modified before a specified\n time.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "A filter that returns the model compilation jobs whose name contains a specified\n string.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#CompilationJobStatus", - "traits": { - "smithy.api#documentation": "A filter that retrieves model compilation jobs with a specific\n CompilationJobStatus status.
The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of CompilationJobSummary objects, each describing a model compilation job.\n
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon SageMaker AI returns this NextToken. To retrieve\n the next set of model compilation jobs, use this token in the next request.
List the resource allocation definitions.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ComputeQuotaSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListComputeQuotasRequest": { - "type": "structure", - "members": { - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "Filter for name containing this string.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", - "traits": { - "smithy.api#documentation": "Filter for status.
" - } - }, - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#documentation": "Filter for ARN of the cluster.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortQuotaBy", - "traits": { - "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of compute allocation definitions to list.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListComputeQuotasResponse": { - "type": "structure", - "members": { - "ComputeQuotaSummaries": { - "target": "com.amazonaws.sagemaker#ComputeQuotaSummaryList", - "traits": { - "smithy.api#documentation": "Summaries of the compute allocation definitions.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListContexts": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListContextsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListContextsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Lists the contexts in your account and their properties.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ContextSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListContextsRequest": { - "type": "structure", - "members": { - "SourceUri": { - "target": "com.amazonaws.sagemaker#SourceUri", - "traits": { - "smithy.api#documentation": "A filter that returns only contexts with the specified source URI.
" - } - }, - "ContextType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "A filter that returns only contexts of the specified type.
" - } - }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only contexts created on or after the specified time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only contexts created on or before the specified time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortContextsBy", - "traits": { - "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListContexts didn't return the full set of contexts,\n the call returns a token for getting the next set of contexts.
The maximum number of contexts to return in the response. The default value is 10.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListContextsResponse": { - "type": "structure", - "members": { - "ContextSummaries": { - "target": "com.amazonaws.sagemaker#ContextSummaries", - "traits": { - "smithy.api#documentation": "A list of contexts and their properties.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of contexts, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListDataQualityJobDefinitions": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists the data quality job definitions in your account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "JobDefinitionSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsRequest": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "A filter that lists the data quality job definitions associated with the specified\n endpoint.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
If the result of the previous ListDataQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of\n transform jobs, use the token in the next request.>
The maximum number of data quality monitoring job definitions to return in the\n response.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "A string in the data quality monitoring job definition name. This filter returns only\n data quality monitoring job definitions whose name contains the specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only data quality monitoring job definitions created before the\n specified time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only data quality monitoring job definitions created after the\n specified time.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsResponse": { - "type": "structure", - "members": { - "JobDefinitionSummaries": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of data quality monitoring job definitions.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListDataQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of data\n quality monitoring job definitions, use the token in the next request.
Returns a list of devices in the fleet.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DeviceFleetSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListDeviceFleetsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#ListMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to select.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter fleets where packaging job was created after specified time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter fleets where the edge packaging job was created before specified time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Select fleets where the job was updated after X
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Select fleets where the job was updated before X
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Filter for fleets containing this name in their fleet device name.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ListDeviceFleetsSortBy", - "traits": { - "smithy.api#documentation": "The column to sort by.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "What direction to sort in.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListDeviceFleetsResponse": { - "type": "structure", - "members": { - "DeviceFleetSummaries": { - "target": "com.amazonaws.sagemaker#DeviceFleetSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Summary of the device fleet.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListDeviceFleetsSortBy": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAME" - } - }, - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_TIME" - } - }, - "LastModifiedTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST_MODIFIED_TIME" - } - } - } - }, - "com.amazonaws.sagemaker#ListDevices": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListDevicesRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListDevicesResponse" - }, - "traits": { - "smithy.api#documentation": "A list of devices.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DeviceSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListDevicesRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#ListMaxResults", - "traits": { - "smithy.api#documentation": "Maximum number of results to select.
" - } - }, - "LatestHeartbeatAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Select fleets where the job was updated after X
" - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "A filter that searches devices that contains this name in any of their models.
" - } - }, - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "Filter for fleets containing this name in their device fleet name.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListDevicesResponse": { - "type": "structure", - "members": { - "DeviceSummaries": { - "target": "com.amazonaws.sagemaker#DeviceSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Summary of devices.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListDomains": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListDomainsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListDomainsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists the domains.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Domains", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListDomainsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
The list of domains.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListEdgeDeploymentPlans": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansResponse" - }, - "traits": { - "smithy.api#documentation": "Lists all edge deployment plans.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "EdgeDeploymentPlanSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListEdgeDeploymentPlansRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to need\n tokening.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#ListMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to select (50 by default).
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Selects edge deployment plans created after this time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Selects edge deployment plans created before this time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Selects edge deployment plans that were last updated after this time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Selects edge deployment plans that were last updated before this time.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Selects edge deployment plans with names containing this name.
" - } - }, - "DeviceFleetNameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Selects edge deployment plans with a device fleet name containing this name.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansSortBy", - "traits": { - "smithy.api#documentation": "The column by which to sort the edge deployment plans. Can be one of\n NAME, DEVICEFLEETNAME, CREATIONTIME,\n LASTMODIFIEDTIME.
The direction of the sorting (ascending or descending).
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListEdgeDeploymentPlansResponse": { - "type": "structure", - "members": { - "EdgeDeploymentPlanSummaries": { - "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List of summaries of edge deployment plans.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The token to use when calling the next page of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListEdgeDeploymentPlansSortBy": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAME" - } - }, - "DeviceFleetName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEVICE_FLEET_NAME" - } - }, - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_TIME" - } - }, - "LastModifiedTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST_MODIFIED_TIME" - } - } - } - }, - "com.amazonaws.sagemaker#ListEdgePackagingJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListEdgePackagingJobsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListEdgePackagingJobsResponse" - }, - "traits": { - "smithy.api#documentation": "Returns a list of edge packaging jobs.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "EdgePackagingJobSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListEdgePackagingJobsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#ListMaxResults", - "traits": { - "smithy.api#documentation": "Maximum number of results to select.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Select jobs where the job was created after specified time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Select jobs where the job was created before specified time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Select jobs where the job was updated after specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Select jobs where the job was updated before specified time.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Filter for jobs containing this name in their packaging job name.
" - } - }, - "ModelNameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Filter for jobs where the model name contains this string.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#EdgePackagingJobStatus", - "traits": { - "smithy.api#documentation": "The job status to filter for.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ListEdgePackagingJobsSortBy", - "traits": { - "smithy.api#documentation": "Use to specify what column to sort by.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "What direction to sort by.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListEdgePackagingJobsResponse": { - "type": "structure", - "members": { - "EdgePackagingJobSummaries": { - "target": "com.amazonaws.sagemaker#EdgePackagingJobSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Summaries of edge packaging jobs.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "Token to use when calling the next page of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListEdgePackagingJobsSortBy": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAME" - } - }, - "ModelName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODEL_NAME" - } - }, - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_TIME" - } - }, - "LastModifiedTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST_MODIFIED_TIME" - } - }, - "EdgePackagingJobStatus": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATUS" - } - } - } - }, - "com.amazonaws.sagemaker#ListEndpointConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListEndpointConfigsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListEndpointConfigsOutput" - }, - "traits": { - "smithy.api#documentation": "Lists endpoint configurations.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "EndpointConfigs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListEndpointConfigsInput": { - "type": "structure", - "members": { - "SortBy": { - "target": "com.amazonaws.sagemaker#EndpointConfigSortKey", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
If the result of the previous ListEndpointConfig request was\n truncated, the response includes a NextToken. To retrieve the next set of\n endpoint configurations, use the token in the next request.
The maximum number of training jobs to return in the response.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#EndpointConfigNameContains", - "traits": { - "smithy.api#documentation": "A string in the endpoint configuration name. This filter returns only endpoint\n configurations whose name contains the specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only endpoint configurations created before the specified\n time (timestamp).
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only endpoint configurations with a creation time greater\n than or equal to the specified time (timestamp).
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListEndpointConfigsOutput": { - "type": "structure", - "members": { - "EndpointConfigs": { - "target": "com.amazonaws.sagemaker#EndpointConfigSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of endpoint configurations.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#PaginationToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n endpoint configurations, use it in the subsequent request
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListEndpointsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListEndpointsOutput" - }, - "traits": { - "smithy.api#documentation": "Lists endpoints.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Endpoints", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListEndpointsInput": { - "type": "structure", - "members": { - "SortBy": { - "target": "com.amazonaws.sagemaker#EndpointSortKey", - "traits": { - "smithy.api#documentation": "Sorts the list of results. The default is CreationTime.
The sort order for results. The default is Descending.
If the result of a ListEndpoints request was truncated, the response\n includes a NextToken. To retrieve the next set of endpoints, use the token\n in the next request.
The maximum number of endpoints to return in the response. This value defaults to\n 10.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#EndpointNameContains", - "traits": { - "smithy.api#documentation": "A string in endpoint names. This filter returns only endpoints whose name contains\n the specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only endpoints that were created before the specified time\n (timestamp).
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only endpoints with a creation time greater than or equal to\n the specified time (timestamp).
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only endpoints that were modified before the specified\n timestamp.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only endpoints that were modified after the specified\n timestamp.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#EndpointStatus", - "traits": { - "smithy.api#documentation": "A filter that returns only endpoints with the specified status.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListEndpointsOutput": { - "type": "structure", - "members": { - "Endpoints": { - "target": "com.amazonaws.sagemaker#EndpointSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array or endpoint objects.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#PaginationToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListExperiments": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListExperimentsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListExperimentsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists all the experiments in your account. The list can be filtered to show only\n experiments that were created in a specific time range. The list can be sorted by experiment\n name or creation time.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ExperimentSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListExperimentsRequest": { - "type": "structure", - "members": { - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only experiments created after the specified time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only experiments created before the specified time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortExperimentsBy", - "traits": { - "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListExperiments didn't return the full set of\n experiments, the call returns a token for getting the next set of experiments.
The maximum number of experiments to return in the response. The default value is\n 10.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListExperimentsResponse": { - "type": "structure", - "members": { - "ExperimentSummaries": { - "target": "com.amazonaws.sagemaker#ExperimentSummaries", - "traits": { - "smithy.api#documentation": "A list of the summaries of your experiments.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of experiments, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListFeatureGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListFeatureGroupsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListFeatureGroupsResponse" - }, - "traits": { - "smithy.api#documentation": "List FeatureGroups based on given filter and order.
A string that partially matches one or more FeatureGroups names. Filters\n FeatureGroups by name.
A FeatureGroup status. Filters by FeatureGroup status.
An OfflineStore status. Filters by OfflineStore status.\n
Use this parameter to search for FeatureGroupss created after a specific\n date and time.
Use this parameter to search for FeatureGroupss created before a specific\n date and time.
The order in which feature groups are listed.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#FeatureGroupSortBy", - "traits": { - "smithy.api#documentation": "The value on which the feature group list is sorted.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#FeatureGroupMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results returned by ListFeatureGroups.
A token to resume pagination of ListFeatureGroups results.
A summary of feature groups.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token to resume pagination of ListFeatureGroups results.
Returns information about the flow definitions in your account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FlowDefinitionSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListFlowDefinitionsRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only flow definitions that were created before the specified timestamp.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A token to resume pagination.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
An array of objects describing the flow definitions.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token to resume pagination.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListHubContentVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListHubContentVersionsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListHubContentVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "List hub content versions.
" - } - }, - "com.amazonaws.sagemaker#ListHubContentVersionsRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub to list the content versions of.
", - "smithy.api#required": {} - } - }, - "HubContentType": { - "target": "com.amazonaws.sagemaker#HubContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of hub content to list versions of.
", - "smithy.api#required": {} - } - }, - "HubContentName": { - "target": "com.amazonaws.sagemaker#HubContentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub content.
", - "smithy.api#required": {} - } - }, - "MinVersion": { - "target": "com.amazonaws.sagemaker#HubContentVersion", - "traits": { - "smithy.api#documentation": "The lower bound of the hub content versions to list.
" - } - }, - "MaxSchemaVersion": { - "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", - "traits": { - "smithy.api#documentation": "The upper bound of the hub content schema version.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list hub content versions that were created before the time specified.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list hub content versions that were created after the time specified.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#HubContentSortBy", - "traits": { - "smithy.api#documentation": "Sort hub content versions by either name or creation time.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "Sort hub content versions by ascending or descending order.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of hub content versions to list.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.
The summaries of the listed hub content versions.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListHubContents": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListHubContentsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListHubContentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "List the contents of a hub.
" - } - }, - "com.amazonaws.sagemaker#ListHubContentsRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub to list the contents of.
", - "smithy.api#required": {} - } - }, - "HubContentType": { - "target": "com.amazonaws.sagemaker#HubContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of hub content to list.
", - "smithy.api#required": {} - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Only list hub content if the name contains the specified string.
" - } - }, - "MaxSchemaVersion": { - "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", - "traits": { - "smithy.api#documentation": "The upper bound of the hub content schema verion.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list hub content that was created before the time specified.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list hub content that was created after the time specified.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#HubContentSortBy", - "traits": { - "smithy.api#documentation": "Sort hub content versions by either name or creation time.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "Sort hubs by ascending or descending order.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum amount of hub content to list.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.
The summaries of the listed hub content.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListHubs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListHubsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListHubsResponse" - }, - "traits": { - "smithy.api#documentation": "List all existing hubs.
" - } - }, - "com.amazonaws.sagemaker#ListHubsRequest": { - "type": "structure", - "members": { - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Only list hubs with names that contain the specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list hubs that were created before the time specified.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list hubs that were created after the time specified.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list hubs that were last modified before the time specified.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list hubs that were last modified after the time specified.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#HubSortBy", - "traits": { - "smithy.api#documentation": "Sort hubs by either name or creation time.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "Sort hubs by ascending or descending order.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of hubs to list.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.
The summaries of the listed hubs.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListHumanTaskUis": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListHumanTaskUisRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListHumanTaskUisResponse" - }, - "traits": { - "smithy.api#documentation": "Returns information about the human task user interfaces in your account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "HumanTaskUiSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListHumanTaskUisRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only human task user interfaces that were created before the specified timestamp.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A token to resume pagination.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
An array of objects describing the human task user interfaces.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token to resume pagination.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListHyperParameterTuningJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListHyperParameterTuningJobsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListHyperParameterTuningJobsResponse" - }, - "traits": { - "smithy.api#documentation": "Gets a list of HyperParameterTuningJobSummary objects that\n describe\n the hyperparameter tuning jobs launched in your account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "HyperParameterTuningJobSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListHyperParameterTuningJobsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListHyperParameterTuningJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n tuning jobs, use the token in the next request.
The\n maximum number of tuning jobs to return. The default value is\n 10.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSortByOptions", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
A string in the tuning job name. This filter returns only tuning jobs whose name\n contains the specified string.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only tuning jobs that were created after the specified\n time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only tuning jobs that were created before the specified\n time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only tuning jobs that were modified after the specified\n time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only tuning jobs that were modified before the specified\n time.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", - "traits": { - "smithy.api#documentation": "A filter that returns only tuning jobs with the specified status.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListHyperParameterTuningJobsResponse": { - "type": "structure", - "members": { - "HyperParameterTuningJobSummaries": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of HyperParameterTuningJobSummary objects that\n describe\n the tuning jobs that the ListHyperParameterTuningJobs\n request returned.
If the result of this ListHyperParameterTuningJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of tuning jobs,\n use the token in the next request.
Lists the versions of a specified image and their properties. The list can be filtered\n by creation time or modified time.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ImageVersions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListImageVersionsRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only versions created on or after the specified time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only versions created on or before the specified time.
" - } - }, - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image to list the versions of.
", - "smithy.api#required": {} - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only versions modified on or after the specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only versions modified on or before the specified time.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of versions to return in the response. The default value is 10.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous call to ListImageVersions didn't return the full set of\n versions, the call returns a token for getting the next set of versions.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
A list of versions and their properties.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of versions, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListImagesRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListImagesResponse" - }, - "traits": { - "smithy.api#documentation": "Lists the images in your account and their properties. The list can be filtered by\n creation time or modified time, and whether the image name contains a specified string.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Images", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListImagesRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only images created on or after the specified time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only images created on or before the specified time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only images modified on or after the specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only images modified on or before the specified time.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of images to return in the response. The default value is 10.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#ImageNameContains", - "traits": { - "smithy.api#documentation": "A filter that returns only images whose name contains the specified string.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous call to ListImages didn't return the full set of images,\n the call returns a token for getting the next set of images.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
A list of images and their properties.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of images, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListInferenceComponents": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListInferenceComponentsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListInferenceComponentsOutput" - }, - "traits": { - "smithy.api#documentation": "Lists the inference components in your account and their properties.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InferenceComponents", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListInferenceComponentsInput": { - "type": "structure", - "members": { - "SortBy": { - "target": "com.amazonaws.sagemaker#InferenceComponentSortKey", - "traits": { - "smithy.api#documentation": "The field by which to sort the inference components in the response. The default is\n CreationTime.
The sort order for results. The default is Descending.
A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of inference components to return in the response. This value\n defaults to 10.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#InferenceComponentNameContains", - "traits": { - "smithy.api#documentation": "Filters the results to only those inference components with a name that contains the\n specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filters the results to only those inference components that were created before the\n specified time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filters the results to only those inference components that were created after the\n specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filters the results to only those inference components that were updated before the\n specified time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filters the results to only those inference components that were updated after the\n specified time.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#InferenceComponentStatus", - "traits": { - "smithy.api#documentation": "Filters the results to only those inference components with the specified status.
" - } - }, - "EndpointNameEquals": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "An endpoint name to filter the listed inference components. The response includes only\n those inference components that are hosted at the specified endpoint.
" - } - }, - "VariantNameEquals": { - "target": "com.amazonaws.sagemaker#VariantName", - "traits": { - "smithy.api#documentation": "A production variant name to filter the listed inference components. The response\n includes only those inference components that are hosted at the specified variant.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListInferenceComponentsOutput": { - "type": "structure", - "members": { - "InferenceComponents": { - "target": "com.amazonaws.sagemaker#InferenceComponentSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of inference components and their properties that matches any of the filters you\n specified in the request.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#PaginationToken", - "traits": { - "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results following a\n truncated response.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListInferenceExperiments": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListInferenceExperimentsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListInferenceExperimentsResponse" - }, - "traits": { - "smithy.api#documentation": "Returns the list of all inference experiments.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InferenceExperiments", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListInferenceExperimentsRequest": { - "type": "structure", - "members": { - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Selects inference experiments whose names contain this name.
" - } - }, - "Type": { - "target": "com.amazonaws.sagemaker#InferenceExperimentType", - "traits": { - "smithy.api#documentation": "\n Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.\n
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", - "traits": { - "smithy.api#documentation": "\n Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.\n
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Selects inference experiments which were created after this timestamp.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Selects inference experiments which were created before this timestamp.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Selects inference experiments which were last modified after this timestamp.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Selects inference experiments which were last modified before this timestamp.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortInferenceExperimentsBy", - "traits": { - "smithy.api#documentation": "The column by which to sort the listed inference experiments.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "The direction of sorting (ascending or descending).
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "\n The response from the last list when returning a list large enough to need tokening.\n
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to select.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListInferenceExperimentsResponse": { - "type": "structure", - "members": { - "InferenceExperiments": { - "target": "com.amazonaws.sagemaker#InferenceExperimentList", - "traits": { - "smithy.api#documentation": "List of inference experiments.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The token to use when calling the next page of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListInferenceRecommendationsJobSteps": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of the subtasks for an Inference Recommender job.
\nThe supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Steps", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsRequest": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.sagemaker#RecommendationJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name for the Inference Recommender job.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#RecommendationJobStatus", - "traits": { - "smithy.api#documentation": "A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
" - } - }, - "StepType": { - "target": "com.amazonaws.sagemaker#RecommendationStepType", - "traits": { - "smithy.api#documentation": "A filter to return details about the specified type of subtask.
\n\n BENCHMARK: Evaluate the performance of your model on different instance types.
The maximum number of results to return.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsResponse": { - "type": "structure", - "members": { - "Steps": { - "target": "com.amazonaws.sagemaker#InferenceRecommendationsJobSteps", - "traits": { - "smithy.api#documentation": "A list of all subtask details in Inference Recommender.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token that you can specify in your next request to return more results from the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListInferenceRecommendationsJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists recommendation jobs that satisfy various filters.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InferenceRecommendationsJobs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs created after the specified time (timestamp).
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs created before the specified time (timestamp).
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs that were last modified after the specified time (timestamp).
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs that were last modified before the specified time (timestamp).
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "A string in the job name. This filter returns only recommendations whose name contains the specified string.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#RecommendationJobStatus", - "traits": { - "smithy.api#documentation": "A filter that retrieves only inference recommendations jobs with a specific status.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsSortBy", - "traits": { - "smithy.api#documentation": "The parameter by which to sort the results.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "The sort order for the results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to a previous ListInferenceRecommendationsJobsRequest request \n was truncated, the response includes a NextToken. To retrieve the next set \n of recommendations, use the token in the next request.
The maximum number of recommendations to return in the response.
" - } - }, - "ModelNameEquals": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs that were created for this model.
" - } - }, - "ModelPackageVersionArnEquals": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs that were created for this versioned model package.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsResponse": { - "type": "structure", - "members": { - "InferenceRecommendationsJobs": { - "target": "com.amazonaws.sagemaker#InferenceRecommendationsJobs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The recommendations created from the Amazon SageMaker Inference Recommender job.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of recommendations, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - } - } - }, - "com.amazonaws.sagemaker#ListLabelingJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListLabelingJobsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListLabelingJobsResponse" - }, - "traits": { - "smithy.api#documentation": "Gets a list of labeling jobs.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LabelingJobSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListLabelingJobsForWorkteam": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Gets a list of labeling jobs assigned to a specified work team.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LabelingJobSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamRequest": { - "type": "structure", - "members": { - "WorkteamArn": { - "target": "com.amazonaws.sagemaker#WorkteamArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team for which you want to see labeling\n jobs for.
", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of labeling jobs to return in each page of the response.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListLabelingJobsForWorkteam request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.
A filter that returns only labeling jobs created after the specified time\n (timestamp).
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs created before the specified time\n (timestamp).
" - } - }, - "JobReferenceCodeContains": { - "target": "com.amazonaws.sagemaker#JobReferenceCodeContains", - "traits": { - "smithy.api#documentation": "A filter the limits jobs to only the ones whose job reference code contains the\n specified string.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamSortByOptions", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of LabelingJobSummary objects, each describing a labeling\n job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamSortByOptions": { - "type": "enum", - "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#ListLabelingJobsRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs created after the specified time\n (timestamp).
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs created before the specified time\n (timestamp).
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs modified after the specified time\n (timestamp).
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs modified before the specified time\n (timestamp).
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of labeling jobs to return in each page of the response.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListLabelingJobs request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.
A string in the labeling job name. This filter returns only labeling jobs whose name\n contains the specified string.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortBy", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that retrieves only labeling jobs with a specific status.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListLabelingJobsResponse": { - "type": "structure", - "members": { - "LabelingJobSummaryList": { - "target": "com.amazonaws.sagemaker#LabelingJobSummaryList", - "traits": { - "smithy.api#documentation": "An array of LabelingJobSummary objects, each describing a labeling\n job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListLineageEntityParameterKey": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#StringParameterValue" - } - }, - "com.amazonaws.sagemaker#ListLineageGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListLineageGroupsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListLineageGroupsResponse" - }, - "traits": { - "smithy.api#documentation": "A list of lineage groups shared with your Amazon Web Services account. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LineageGroupSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListLineageGroupsRequest": { - "type": "structure", - "members": { - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp to filter against lineage groups created after a certain point in time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp to filter against lineage groups created before a certain point in time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortLineageGroupsBy", - "traits": { - "smithy.api#documentation": "The parameter by which to sort the results. The default is\n CreationTime.
The sort order for the results. The default is Ascending.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of endpoints to return in the response. This value defaults to\n 10.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListLineageGroupsResponse": { - "type": "structure", - "members": { - "LineageGroupSummaries": { - "target": "com.amazonaws.sagemaker#LineageGroupSummaries", - "traits": { - "smithy.api#documentation": "A list of lineage groups and their properties.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#ListMlflowTrackingServers": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListMlflowTrackingServersRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListMlflowTrackingServersResponse" - }, - "traits": { - "smithy.api#documentation": "Lists all MLflow Tracking Servers.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TrackingServerSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListMlflowTrackingServersRequest": { - "type": "structure", - "members": { - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Use the CreatedAfter filter to only list tracking servers created after a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a\n Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Use the CreatedBefore filter to only list tracking servers created before a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in\n a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Filter for tracking servers with a specified creation status.
" - } - }, - "MlflowVersion": { - "target": "com.amazonaws.sagemaker#MlflowVersion", - "traits": { - "smithy.api#documentation": "Filter for tracking servers using the specified MLflow version.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortTrackingServerBy", - "traits": { - "smithy.api#documentation": "Filter for trackings servers sorting by name, creation time, or creation status.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. \n To change the list order, you can specify SortOrder to be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of tracking servers to list.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListMlflowTrackingServersResponse": { - "type": "structure", - "members": { - "TrackingServerSummaries": { - "target": "com.amazonaws.sagemaker#TrackingServerSummaryList", - "traits": { - "smithy.api#documentation": "A list of tracking servers according to chosen filters.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModelBiasJobDefinitions": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists model bias jobs definitions that satisfy various filters.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "JobDefinitionSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsRequest": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "Name of the endpoint to monitor for model bias.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", - "traits": { - "smithy.api#documentation": "Whether to sort results by the Name or CreationTime field. \n The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of model bias jobs to return in the response. The default value is\n 10.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Filter for model bias jobs whose name contains a specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only model bias jobs created before a specified time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only model bias jobs created after a specified time.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsResponse": { - "type": "structure", - "members": { - "JobDefinitionSummaries": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A JSON array in which each element is a summary for a model bias jobs.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModelCardExportJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelCardExportJobsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelCardExportJobsResponse" - }, - "traits": { - "smithy.api#documentation": "List the export jobs for the Amazon SageMaker Model Card.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ModelCardExportJobSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListModelCardExportJobsRequest": { - "type": "structure", - "members": { - "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List export jobs for the model card with the specified name.
", - "smithy.api#required": {} - } - }, - "ModelCardVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "List export jobs for the model card with the specified version.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list model card export jobs that were created after the time specified.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list model card export jobs that were created before the time specified.
" - } - }, - "ModelCardExportJobNameContains": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "Only list model card export jobs with names that contain the specified string.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", - "traits": { - "smithy.api#documentation": "Only list model card export jobs with the specified status.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobSortBy", - "traits": { - "smithy.api#documentation": "Sort model card export jobs by either name or creation time. Sorts by creation time by default.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobSortOrder", - "traits": { - "smithy.api#documentation": "Sort model card export jobs by ascending or descending order.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to a previous ListModelCardExportJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model card export jobs, use the token in the next request.
The maximum number of model card export jobs to list.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListModelCardExportJobsResponse": { - "type": "structure", - "members": { - "ModelCardExportJobSummaries": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The summaries of the listed model card export jobs.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n card export jobs, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModelCardVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelCardVersionsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelCardVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "List existing versions of an Amazon SageMaker Model Card.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ModelCardVersionSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListModelCardVersionsRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list model card versions that were created after the time specified.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list model card versions that were created before the time specified.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of model card versions to list.
" - } - }, - "ModelCardName": { - "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List model card versions for the model card with the specified name or Amazon Resource Name (ARN).
", - "smithy.api#required": {} - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#documentation": "Only list model card versions with the specified approval status.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to a previous ListModelCardVersions request was truncated,\n the response includes a NextToken. To retrieve the next set of model card\n versions, use the token in the next request.
Sort listed model card versions by version. Sorts by version by default.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#ModelCardSortOrder", - "traits": { - "smithy.api#documentation": "Sort model card versions by ascending or descending order.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListModelCardVersionsResponse": { - "type": "structure", - "members": { - "ModelCardVersionSummaryList": { - "target": "com.amazonaws.sagemaker#ModelCardVersionSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The summaries of the listed versions of the model card.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n card versions, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModelCards": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelCardsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelCardsResponse" - }, - "traits": { - "smithy.api#documentation": "List existing model cards.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ModelCardSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListModelCardsRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list model cards that were created after the time specified.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Only list model cards that were created before the time specified.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of model cards to list.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "Only list model cards with names that contain the specified string.
" - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#documentation": "Only list model cards with the specified approval status.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to a previous ListModelCards request was truncated, the\n response includes a NextToken. To retrieve the next set of model cards, use\n the token in the next request.
Sort model cards by either name or creation time. Sorts by creation time by default.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#ModelCardSortOrder", - "traits": { - "smithy.api#documentation": "Sort model cards by ascending or descending order.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListModelCardsResponse": { - "type": "structure", - "members": { - "ModelCardSummaries": { - "target": "com.amazonaws.sagemaker#ModelCardSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The summaries of the listed model cards.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n cards, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitions": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists model explainability job definitions that satisfy various filters.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "JobDefinitionSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsRequest": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "Name of the endpoint to monitor for model explainability.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", - "traits": { - "smithy.api#documentation": "Whether to sort results by the Name or CreationTime field. \n The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of jobs to return in the response. The default value is 10.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Filter for model explainability jobs whose name contains a specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only model explainability jobs created before a specified\n time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only model explainability jobs created after a specified\n time.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsResponse": { - "type": "structure", - "members": { - "JobDefinitionSummaries": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A JSON array in which each element is a summary for a explainability bias jobs.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModelMetadata": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelMetadataRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelMetadataResponse" - }, - "traits": { - "smithy.api#documentation": "Lists the domain, framework, task, and model name of standard \n machine learning models found in common model zoos.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ModelMetadataSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListModelMetadataRequest": { - "type": "structure", - "members": { - "SearchExpression": { - "target": "com.amazonaws.sagemaker#ModelMetadataSearchExpression", - "traits": { - "smithy.api#documentation": "One or more filters that searches for the specified resource or resources \n in a search. All resource objects that satisfy the expression's condition are \n included in the search results. Specify the Framework, FrameworkVersion, Domain \n or Task to filter supported. Filter names and values are case-sensitive.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to a previous ListModelMetadataResponse request was truncated, \n the response includes a NextToken. To retrieve the next set of model metadata, \n use the token in the next request.
The maximum number of models to return in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListModelMetadataResponse": { - "type": "structure", - "members": { - "ModelMetadataSummaries": { - "target": "com.amazonaws.sagemaker#ModelMetadataSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A structure that holds model metadata.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of recommendations, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModelPackageGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelPackageGroupsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelPackageGroupsOutput" - }, - "traits": { - "smithy.api#documentation": "Gets a list of the model groups in your Amazon Web Services account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ModelPackageGroupSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListModelPackageGroupsInput": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only model groups created after the specified time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only model groups created before the specified time.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "A string in the model group name. This filter returns only model groups whose name\n contains the specified string.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListModelPackageGroups request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model groups, use the token in the next request.
The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that returns either model groups shared with you or model groups in\n\t your own account. When the value is CrossAccount, the results show\n\t the resources made discoverable to you from other accounts. When the value is\n SameAccount or null, the results show resources from your\n \t account. The default is SameAccount.
A list of summaries of the model groups in your Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set\n of model groups, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModelPackages": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelPackagesInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelPackagesOutput" - }, - "traits": { - "smithy.api#documentation": "Lists the model packages that have been created.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ModelPackageSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListModelPackagesInput": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only model packages created after the specified time\n (timestamp).
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only model packages created before the specified time\n (timestamp).
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of model packages to return in the response.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "A string in the model package name. This filter returns only model packages whose name\n contains the specified string.
" - } - }, - "ModelApprovalStatus": { - "target": "com.amazonaws.sagemaker#ModelApprovalStatus", - "traits": { - "smithy.api#documentation": "A filter that returns only the model packages with the specified approval\n status.
" - } - }, - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#ArnOrName", - "traits": { - "smithy.api#documentation": "A filter that returns only model versions that belong to the specified model group.
" - } - }, - "ModelPackageType": { - "target": "com.amazonaws.sagemaker#ModelPackageType", - "traits": { - "smithy.api#documentation": "A filter that returns only the model packages of the specified type. This can be one\n of the following values.
\n\n UNVERSIONED - List only unversioined models. \n This is the default value if no ModelPackageType is specified.
\n VERSIONED - List only versioned models.
\n BOTH - List both versioned and unversioned models.
If the response to a previous ListModelPackages request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n packages, use the token in the next request.
The parameter by which to sort the results. The default is\n CreationTime.
The sort order for the results. The default is Ascending.
An array of ModelPackageSummary objects, each of which lists a model\n package.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n model packages, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModelQualityJobDefinitions": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsResponse" - }, - "traits": { - "smithy.api#documentation": "Gets a list of model quality monitoring job definitions in your account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "JobDefinitionSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsRequest": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions that are associated\n with the specified endpoint.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
If the result of the previous ListModelQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model quality monitoring job definitions, use the token in the next request.
The maximum number of results to return in a call to\n ListModelQualityJobDefinitions.
A string in the transform job name. This filter returns only model quality monitoring\n job definitions whose name contains the specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions created before the\n specified time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions created after the\n specified time.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsResponse": { - "type": "structure", - "members": { - "JobDefinitionSummaries": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of summaries of model quality monitoring job definitions.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the\n next set of model quality monitoring job definitions, use it in the next request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListModels": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListModelsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListModelsOutput" - }, - "traits": { - "smithy.api#documentation": "Lists models created with the CreateModel API.
Sorts the list of results. The default is CreationTime.
The sort order for results. The default is Descending.
If the response to a previous ListModels request was truncated, the\n response includes a NextToken. To retrieve the next set of models, use the\n token in the next request.
The maximum number of models to return in the response.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#ModelNameContains", - "traits": { - "smithy.api#documentation": "A string in the model name. This filter returns only models whose name contains the\n specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only models created before the specified time\n (timestamp).
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only models with a creation time greater than or equal to the\n specified time (timestamp).
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListModelsOutput": { - "type": "structure", - "members": { - "Models": { - "target": "com.amazonaws.sagemaker#ModelSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of ModelSummary objects, each of which lists a\n model.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n models, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListMonitoringAlertHistory": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListMonitoringAlertHistoryRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListMonitoringAlertHistoryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Gets a list of past alerts in a model monitoring schedule.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MonitoringAlertHistory", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListMonitoringAlertHistoryRequest": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#documentation": "The name of a monitoring schedule.
" - } - }, - "MonitoringAlertName": { - "target": "com.amazonaws.sagemaker#MonitoringAlertName", - "traits": { - "smithy.api#documentation": "The name of a monitoring alert.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#MonitoringAlertHistorySortKey", - "traits": { - "smithy.api#documentation": "The field used to sort results. The default is CreationTime.
The sort order, whether Ascending or Descending, of the alert\n history. The default is Descending.
If the result of the previous ListMonitoringAlertHistory request was\n truncated, the response includes a NextToken. To retrieve the next set of\n alerts in the history, use the token in the next request.
The maximum number of results to display. The default is 100.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only alerts created on or before the specified time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only alerts created on or after the specified time.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#MonitoringAlertStatus", - "traits": { - "smithy.api#documentation": "A filter that retrieves only alerts with a specific status.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListMonitoringAlertHistoryResponse": { - "type": "structure", - "members": { - "MonitoringAlertHistory": { - "target": "com.amazonaws.sagemaker#MonitoringAlertHistoryList", - "traits": { - "smithy.api#documentation": "An alert history for a model monitoring schedule.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n alerts, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListMonitoringAlerts": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListMonitoringAlertsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListMonitoringAlertsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Gets the alerts for a single monitoring schedule.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MonitoringAlertSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListMonitoringAlertsRequest": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a monitoring schedule.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListMonitoringAlerts request was truncated,\n the response includes a NextToken. To retrieve the next set of alerts in the\n history, use the token in the next request.
The maximum number of results to display. The default is 100.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListMonitoringAlertsResponse": { - "type": "structure", - "members": { - "MonitoringAlertSummaries": { - "target": "com.amazonaws.sagemaker#MonitoringAlertSummaryList", - "traits": { - "smithy.api#documentation": "A JSON array where each element is a summary for a monitoring alert.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n alerts, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListMonitoringExecutions": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListMonitoringExecutionsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListMonitoringExecutionsResponse" - }, - "traits": { - "smithy.api#documentation": "Returns list of all monitoring job executions.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MonitoringExecutionSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListMonitoringExecutionsRequest": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#documentation": "Name of a specific schedule to fetch jobs for.
" - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "Name of a specific endpoint to fetch jobs for.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#MonitoringExecutionSortKey", - "traits": { - "smithy.api#documentation": "Whether to sort the results by the Status, CreationTime, or \n ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of jobs to return in the response. The default value is 10.
" - } - }, - "ScheduledTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter for jobs scheduled before a specified time.
" - } - }, - "ScheduledTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter for jobs scheduled after a specified time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs created before a specified time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs created after a specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs modified after a specified time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only jobs modified before a specified time.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#ExecutionStatus", - "traits": { - "smithy.api#documentation": "A filter that retrieves only jobs with a specific status.
" - } - }, - "MonitoringJobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#documentation": "Gets a list of the monitoring job runs of the specified monitoring job\n definitions.
" - } - }, - "MonitoringTypeEquals": { - "target": "com.amazonaws.sagemaker#MonitoringType", - "traits": { - "smithy.api#documentation": "A filter that returns only the monitoring job runs of the specified monitoring\n type.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListMonitoringExecutionsResponse": { - "type": "structure", - "members": { - "MonitoringExecutionSummaries": { - "target": "com.amazonaws.sagemaker#MonitoringExecutionSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A JSON array in which each element is a summary for a monitoring execution.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListMonitoringSchedules": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListMonitoringSchedulesRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListMonitoringSchedulesResponse" - }, - "traits": { - "smithy.api#documentation": "Returns list of all monitoring schedules.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MonitoringScheduleSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListMonitoringSchedulesRequest": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "Name of a specific endpoint to fetch schedules for.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleSortKey", - "traits": { - "smithy.api#documentation": "Whether to sort the results by the Status, CreationTime, or \n ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of jobs to return in the response. The default value is 10.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Filter for monitoring schedules whose name contains a specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only monitoring schedules created before a specified time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only monitoring schedules created after a specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only monitoring schedules modified before a specified time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only monitoring schedules modified after a specified time.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#ScheduleStatus", - "traits": { - "smithy.api#documentation": "A filter that returns only monitoring schedules modified before a specified time.
" - } - }, - "MonitoringJobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#documentation": "Gets a list of the monitoring schedules for the specified monitoring job\n definition.
" - } - }, - "MonitoringTypeEquals": { - "target": "com.amazonaws.sagemaker#MonitoringType", - "traits": { - "smithy.api#documentation": "A filter that returns only the monitoring schedules for the specified monitoring\n type.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListMonitoringSchedulesResponse": { - "type": "structure", - "members": { - "MonitoringScheduleSummaries": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleSummaryList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A JSON array in which each element is a summary for a monitoring schedule.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsOutput" - }, - "traits": { - "smithy.api#documentation": "Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NotebookInstanceLifecycleConfigs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsInput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of a ListNotebookInstanceLifecycleConfigs request was\n truncated, the response includes a NextToken. To get the next set of\n lifecycle configurations, use the token in the next request.
The maximum number of lifecycle configurations to return in the response.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortKey", - "traits": { - "smithy.api#documentation": "Sorts the list of results. The default is CreationTime.
The sort order for results.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigNameContains", - "traits": { - "smithy.api#documentation": "A string in the lifecycle configuration name. This filter returns only lifecycle\n configurations whose name contains the specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only lifecycle configurations that were created before the\n specified time (timestamp).
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only lifecycle configurations that were created after the\n specified time (timestamp).
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A filter that returns only lifecycle configurations that were modified before the\n specified time (timestamp).
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A filter that returns only lifecycle configurations that were modified after the\n specified time (timestamp).
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsOutput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker AI returns this token. To get the next\n set of lifecycle configurations, use it in the next request.
" - } - }, - "NotebookInstanceLifecycleConfigs": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummaryList", - "traits": { - "smithy.api#documentation": "An array of NotebookInstanceLifecycleConfiguration objects, each listing\n a lifecycle configuration.
Returns a list of the SageMaker AI notebook instances in the requester's\n account in an Amazon Web Services Region.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NotebookInstances", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListNotebookInstancesInput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": " If the previous call to the ListNotebookInstances is truncated, the\n response includes a NextToken. You can use this token in your subsequent\n ListNotebookInstances request to fetch the next set of notebook\n instances.
You might specify a filter or a sort order in your request. When response is\n truncated, you must use the same values for the filer and sort order in the next\n request.
\nThe maximum number of notebook instances to return.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#NotebookInstanceSortKey", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is Name.
The sort order for results.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NotebookInstanceNameContains", - "traits": { - "smithy.api#documentation": "A string in the notebook instances' name. This filter returns only notebook\n instances whose name contains the specified string.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances that were created before the\n specified time (timestamp).
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances that were created after the specified\n time (timestamp).
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances that were modified before the\n specified time (timestamp).
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances that were modified after the\n specified time (timestamp).
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", - "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances with the specified status.
" - } - }, - "NotebookInstanceLifecycleConfigNameContains": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#documentation": "A string in the name of a notebook instances lifecycle configuration associated with\n this notebook instance. This filter returns only notebook instances associated with a\n lifecycle configuration with a name that contains the specified string.
" - } - }, - "DefaultCodeRepositoryContains": { - "target": "com.amazonaws.sagemaker#CodeRepositoryContains", - "traits": { - "smithy.api#documentation": "A string in the name or URL of a Git repository associated with this notebook\n instance. This filter returns only notebook instances associated with a git repository\n with a name that contains the specified string.
" - } - }, - "AdditionalCodeRepositoryEquals": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", - "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances with associated with the specified git\n repository.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListNotebookInstancesOutput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the response to the previous ListNotebookInstances request was\n truncated, SageMaker AI returns this token. To retrieve the next set of notebook\n instances, use the token in the next request.
An array of NotebookInstanceSummary objects, one for each notebook\n instance.
Lists the optimization jobs in your account and their properties.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "OptimizationJobSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListOptimizationJobsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of optimization jobs to return in the response. The default is\n 50.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that were created after the\n specified time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that were created before the\n specified time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated after the\n specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated before the\n specified time.
" - } - }, - "OptimizationContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that apply the specified\n optimization techniques. You can specify either Quantization or\n Compilation.
Filters the results to only those optimization jobs with a name that contains the\n specified string.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#OptimizationJobStatus", - "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs with the specified status.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ListOptimizationJobsSortBy", - "traits": { - "smithy.api#documentation": "The field by which to sort the optimization jobs in the response. The default is\n CreationTime\n
The sort order for results. The default is Ascending\n
A list of optimization jobs and their properties that matches any of the filters you\n specified in the request.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results following a\n truncated response.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListOptimizationJobsSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - } - } - }, - "com.amazonaws.sagemaker#ListPartnerApps": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListPartnerAppsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListPartnerAppsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists all of the SageMaker Partner AI Apps in an account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Summaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListPartnerAppsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be returned in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListPartnerAppsResponse": { - "type": "structure", - "members": { - "Summaries": { - "target": "com.amazonaws.sagemaker#PartnerAppSummaries", - "traits": { - "smithy.api#documentation": "The information related to each of the SageMaker Partner AI Apps in an account.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListPipelineExecutionSteps": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListPipelineExecutionStepsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListPipelineExecutionStepsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Gets a list of PipeLineExecutionStep objects.
The Amazon Resource Name (ARN) of the pipeline execution.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelineExecutionSteps request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
The maximum number of pipeline execution steps to return in the response.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "The field by which to sort results. The default is CreatedTime.
A list of PipeLineExecutionStep objects. Each\n PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus,\n and Metadata. Metadata is an object with properties for each job that contains relevant\n information about the job created by the step.
If the result of the previous ListPipelineExecutionSteps request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
Gets a list of the pipeline executions.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PipelineExecutionSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListPipelineExecutionsRequest": { - "type": "structure", - "members": { - "PipelineName": { - "target": "com.amazonaws.sagemaker#PipelineNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the pipeline.
", - "smithy.api#required": {} - } - }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns the pipeline executions that were created after a specified\n time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns the pipeline executions that were created before a specified\n time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortPipelineExecutionsBy", - "traits": { - "smithy.api#documentation": "The field by which to sort results. The default is CreatedTime.
The sort order for results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelineExecutions request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
The maximum number of pipeline executions to return in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListPipelineExecutionsResponse": { - "type": "structure", - "members": { - "PipelineExecutionSummaries": { - "target": "com.amazonaws.sagemaker#PipelineExecutionSummaryList", - "traits": { - "smithy.api#documentation": "Contains a sorted list of pipeline execution summary objects matching the specified\n filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date,\n and the status. This list can be empty.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelineExecutions request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
Gets a list of parameters for a pipeline execution.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PipelineParameters", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListPipelineParametersForExecutionRequest": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelineParametersForExecution request was truncated,\n the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
The maximum number of parameters to return in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListPipelineParametersForExecutionResponse": { - "type": "structure", - "members": { - "PipelineParameters": { - "target": "com.amazonaws.sagemaker#ParameterList", - "traits": { - "smithy.api#documentation": "Contains a list of pipeline parameters. This list can be empty.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelineParametersForExecution request was truncated,\n the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
Gets a list of pipelines.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PipelineSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListPipelinesRequest": { - "type": "structure", - "members": { - "PipelineNamePrefix": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#documentation": "The prefix of the pipeline name.
" - } - }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns the pipelines that were created after a specified\n time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns the pipelines that were created before a specified\n time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortPipelinesBy", - "traits": { - "smithy.api#documentation": "The field by which to sort results. The default is CreatedTime.
The sort order for results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelines request was truncated,\n the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
The maximum number of pipelines to return in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListPipelinesResponse": { - "type": "structure", - "members": { - "PipelineSummaries": { - "target": "com.amazonaws.sagemaker#PipelineSummaryList", - "traits": { - "smithy.api#documentation": "Contains a sorted list of PipelineSummary objects matching the specified\n filters. Each PipelineSummary consists of PipelineArn, PipelineName,\n ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and\n RoleArn. This list can be empty.
If the result of the previous ListPipelines request was truncated,\n the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
Lists processing jobs that satisfy various filters.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ProcessingJobSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListProcessingJobsRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only processing jobs created after the specified time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only processing jobs created after the specified time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only processing jobs modified after the specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only processing jobs modified before the specified time.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "A string in the processing job name. This filter returns only processing jobs whose\n name contains the specified string.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#ProcessingJobStatus", - "traits": { - "smithy.api#documentation": "A filter that retrieves only processing jobs with a specific status.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortBy", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
If the result of the previous ListProcessingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of processing\n jobs, use the token in the next request.
The maximum number of processing jobs to return in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListProcessingJobsResponse": { - "type": "structure", - "members": { - "ProcessingJobSummaries": { - "target": "com.amazonaws.sagemaker#ProcessingJobSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of ProcessingJobSummary objects, each listing a processing\n job.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n processing jobs, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListProjects": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListProjectsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListProjectsOutput" - }, - "traits": { - "smithy.api#documentation": "Gets a list of the projects in an Amazon Web Services account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListProjectsInput": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns the projects that were created after a specified\n time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns the projects that were created before a specified\n time.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of projects to return in the response.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#ProjectEntityName", - "traits": { - "smithy.api#documentation": "A filter that returns the projects whose name contains a specified\n string.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListProjects request was truncated,\n the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.
The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
A list of summaries of projects.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.
Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of\n ResourceCatalogs viewable is 1000.
A string that partially matches one or more ResourceCatalogs names.\n Filters ResourceCatalog by name.
Use this parameter to search for ResourceCatalogs created after a\n specific date and time.
Use this parameter to search for ResourceCatalogs created before a\n specific date and time.
The order in which the resource catalogs are listed.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ResourceCatalogSortBy", - "traits": { - "smithy.api#documentation": "The value on which the resource catalog list is sorted.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": " The maximum number of results returned by ListResourceCatalogs.
A token to resume pagination of ListResourceCatalogs results.
A list of the requested ResourceCatalogs.
A token to resume pagination of ListResourceCatalogs results.
Lists spaces.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Spaces", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListSpacesRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
The sort order for the results. The default is Ascending.
The parameter by which to sort the results. The default is\n CreationTime.
A parameter to search for the domain ID.
" - } - }, - "SpaceNameContains": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#documentation": "A parameter by which to filter the results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListSpacesResponse": { - "type": "structure", - "members": { - "Spaces": { - "target": "com.amazonaws.sagemaker#SpaceList", - "traits": { - "smithy.api#documentation": "The list of spaces.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListStageDevices": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListStageDevicesRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListStageDevicesResponse" - }, - "traits": { - "smithy.api#documentation": "Lists devices allocated to the stage, containing detailed device information and\n deployment status.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DeviceDeploymentSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListStageDevicesRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to neeed\n tokening.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#ListMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of requests to select.
" - } - }, - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan.
", - "smithy.api#required": {} - } - }, - "ExcludeDevicesDeployedInOtherStage": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Toggle for excluding devices deployed in other stages.
" - } - }, - "StageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stage in the deployment.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListStageDevicesResponse": { - "type": "structure", - "members": { - "DeviceDeploymentSummaries": { - "target": "com.amazonaws.sagemaker#DeviceDeploymentSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List of summaries of devices allocated to the stage.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "The token to use when calling the next page of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListStudioLifecycleConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListStudioLifecycleConfigsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListStudioLifecycleConfigsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - } - ], - "traits": { - "smithy.api#documentation": "Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services\n Account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StudioLifecycleConfigs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListStudioLifecycleConfigsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The total number of items to return in the response. If the total number of items\n available is more than the value specified, a NextToken is provided in the\n response. To resume pagination, provide the NextToken value in the as part of a\n subsequent call. The default value is 10.
If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle\n Configurations, the call returns a token for getting the next set of Lifecycle\n Configurations.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", - "traits": { - "smithy.api#documentation": "A string in the Lifecycle Configuration name. This filter returns only Lifecycle\n Configurations whose name contains the specified string.
" - } - }, - "AppTypeEquals": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", - "traits": { - "smithy.api#documentation": "A parameter to search for the App Type to which the Lifecycle Configuration is\n attached.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or before the specified\n time.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or after the specified\n time.
" - } - }, - "ModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified before the specified\n time.
" - } - }, - "ModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified after the specified\n time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigSortKey", - "traits": { - "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "The sort order. The default value is Descending.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListStudioLifecycleConfigsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - }, - "StudioLifecycleConfigs": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigsList", - "traits": { - "smithy.api#documentation": "A list of Lifecycle Configurations and their properties.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListSubscribedWorkteams": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListSubscribedWorkteamsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListSubscribedWorkteamsResponse" - }, - "traits": { - "smithy.api#documentation": "Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The\n list may be empty if no work team satisfies the filter specified in the\n NameContains parameter.
A string in the work team name. This filter returns only work teams whose name\n contains the specified string.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListSubscribedWorkteams request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.
The maximum number of work teams to return in each page of the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListSubscribedWorkteamsResponse": { - "type": "structure", - "members": { - "SubscribedWorkteams": { - "target": "com.amazonaws.sagemaker#SubscribedWorkteams", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of Workteam objects, each describing a work team.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n work teams, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListTagsInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListTagsOutput" - }, - "traits": { - "smithy.api#documentation": "Returns the tags for the specified SageMaker resource.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Tags", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListTagsInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.sagemaker#ResourceArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource whose tags you want to\n retrieve.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": " If the response to the previous ListTags request is truncated, SageMaker\n returns this token. To retrieve the next set of tags, use it in the subsequent request.\n
Maximum number of tags to return.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListTagsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 50 - } - } - }, - "com.amazonaws.sagemaker#ListTagsOutput": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of Tag objects, each with a tag key and a value.
If response is truncated, SageMaker includes a token in the response. You can use this\n token in your subsequent request to fetch next set of tokens.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListTrainingJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListTrainingJobsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListTrainingJobsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists training jobs.
\nWhen StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.
For example, if ListTrainingJobs is invoked with the following\n parameters:
\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n
First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.
You can quickly test the API using the following Amazon Web Services CLI\n code.
\n\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n
Gets a list of TrainingJobSummary objects that describe the training jobs that a\n hyperparameter tuning job launched.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TrainingJobSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJobRequest": { - "type": "structure", - "members": { - "HyperParameterTuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the tuning job whose training jobs you want to list.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListTrainingJobsForHyperParameterTuningJob\n request was truncated, the response includes a NextToken. To retrieve the\n next set of training jobs, use the token in the next request.
The maximum number of training jobs to return. The default value is 10.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", - "traits": { - "smithy.api#documentation": "A filter that returns only training jobs with the specified status.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#TrainingJobSortByOptions", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is Name.
If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.
The sort order for results. The default is Ascending.
A list of TrainingJobSummary objects that\n describe\n the training jobs that the\n ListTrainingJobsForHyperParameterTuningJob request returned.
If the result of this ListTrainingJobsForHyperParameterTuningJob request\n was truncated, the response includes a NextToken. To retrieve the next set\n of training jobs, use the token in the next request.
If the result of the previous ListTrainingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of training\n jobs, use the token in the next request.
The maximum number of training jobs to return in the response.
" - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only training jobs created after the specified time\n (timestamp).
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only training jobs created before the specified time\n (timestamp).
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only training jobs modified after the specified time\n (timestamp).
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only training jobs modified before the specified time\n (timestamp).
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "A string in the training job name. This filter returns only training jobs whose\n name contains the specified string.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", - "traits": { - "smithy.api#documentation": "A filter that retrieves only training jobs with a specific status.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortBy", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that retrieves only training jobs with a specific warm pool status.
" - } - }, - "TrainingPlanArnEquals": { - "target": "com.amazonaws.sagemaker#TrainingPlanArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information\n about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
An array of TrainingJobSummary objects, each listing a training\n job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListTrainingPlans": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListTrainingPlansRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListTrainingPlansResponse" - }, - "traits": { - "smithy.api#documentation": "Retrieves a list of training plans for the current account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TrainingPlanSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListTrainingPlansRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token to continue pagination if more results are available.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response.
" - } - }, - "StartTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter to list only training plans with an actual start time after this date.
" - } - }, - "StartTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Filter to list only training plans with an actual start time before this date.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#TrainingPlanSortBy", - "traits": { - "smithy.api#documentation": "The training plan field to sort the results by (e.g., StartTime, Status).
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#TrainingPlanSortOrder", - "traits": { - "smithy.api#documentation": "The order to sort the results (Ascending or Descending).
" - } - }, - "Filters": { - "target": "com.amazonaws.sagemaker#TrainingPlanFilters", - "traits": { - "smithy.api#documentation": "Additional filters to apply to the list of training plans.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListTrainingPlansResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token to continue pagination if more results are available.
" - } - }, - "TrainingPlanSummaries": { - "target": "com.amazonaws.sagemaker#TrainingPlanSummaries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of summary information for the training plans.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListTransformJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListTransformJobsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListTransformJobsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists transform jobs.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransformJobSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListTransformJobsRequest": { - "type": "structure", - "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only transform jobs created after the specified time.
" - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only transform jobs created before the specified time.
" - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only transform jobs modified after the specified time.
" - } - }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only transform jobs modified before the specified time.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "A string in the transform job name. This filter returns only transform jobs whose name\n contains the specified string.
" - } - }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#TransformJobStatus", - "traits": { - "smithy.api#documentation": "A filter that retrieves only transform jobs with a specific status.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortBy", - "traits": { - "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
If the result of the previous ListTransformJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of transform\n jobs, use the token in the next request.
The maximum number of transform jobs to return in the response. The default value is 10.
An array of\n TransformJobSummary\n objects.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n transform jobs, use it in the next request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListTrialComponentKey256": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrialComponentKey256" - } - }, - "com.amazonaws.sagemaker#ListTrialComponents": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListTrialComponentsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListTrialComponentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Lists the trial components in your account. You can sort the list by trial component name\n or creation time. You can filter the list to show only components that were created in a\n specific time range. You can also filter on one of the following:
\n\n ExperimentName\n
\n SourceArn\n
\n TrialName\n
A filter that returns only components that are part of the specified experiment. If you\n specify ExperimentName, you can't filter by SourceArn or\n TrialName.
A filter that returns only components that are part of the specified trial. If you specify\n TrialName, you can't filter by ExperimentName or\n SourceArn.
A filter that returns only components that have the specified source Amazon Resource Name (ARN). \n If you specify SourceArn, you can't filter by ExperimentName\n or TrialName.
A filter that returns only components created after the specified time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only components created before the specified time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortTrialComponentsBy", - "traits": { - "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of components to return in the response. The default value is\n 10.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous call to ListTrialComponents didn't return the full set of\n components, the call returns a token for getting the next set of components.
A list of the summaries of your trial components.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of components, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListTrials": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListTrialsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListTrialsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Lists the trials in your account. Specify an experiment name to limit the list to the\n trials that are part of that experiment. Specify a trial component name to limit the list to\n the trials that associated with that trial component. The list can be filtered to show only\n trials that were created in a specific time range. The list can be sorted by trial name or\n creation time.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TrialSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListTrialsRequest": { - "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "A filter that returns only trials that are part of the specified experiment.
" - } - }, - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "A filter that returns only trials that are associated with the specified trial\n component.
" - } - }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only trials created after the specified time.
" - } - }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter that returns only trials created before the specified time.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortTrialsBy", - "traits": { - "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of trials to return in the response. The default value is 10.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous call to ListTrials didn't return the full set of trials, the\n call returns a token for getting the next set of trials.
A list of the summaries of your trials.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token for getting the next set of trials, if there are any.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListUserProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListUserProfilesRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListUserProfilesResponse" - }, - "traits": { - "smithy.api#documentation": "Lists user profiles.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "UserProfiles", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListUserProfilesRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
The sort order for the results. The default is Ascending.
" - } - }, - "SortBy": { - "target": "com.amazonaws.sagemaker#UserProfileSortKey", - "traits": { - "smithy.api#documentation": "The parameter by which to sort the results. The default is CreationTime.
" - } - }, - "DomainIdEquals": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "A parameter by which to filter the results.
" - } - }, - "UserProfileNameContains": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "A parameter by which to filter the results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListUserProfilesResponse": { - "type": "structure", - "members": { - "UserProfiles": { - "target": "com.amazonaws.sagemaker#UserProfileList", - "traits": { - "smithy.api#documentation": "The list of user profiles.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListWorkforces": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListWorkforcesRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListWorkforcesResponse" - }, - "traits": { - "smithy.api#documentation": "Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only \n have one private workforce per Amazon Web Services Region.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Workforces", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#ListWorkforcesRequest": { - "type": "structure", - "members": { - "SortBy": { - "target": "com.amazonaws.sagemaker#ListWorkforcesSortByOptions", - "traits": { - "smithy.api#documentation": "Sort workforces using the workforce name or creation date.
" - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "Sort workforces in ascending or descending order.
" - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#WorkforceName", - "traits": { - "smithy.api#documentation": "A filter you can use to search for workforces using part of the workforce name.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token to resume pagination.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of workforces returned in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListWorkforcesResponse": { - "type": "structure", - "members": { - "Workforces": { - "target": "com.amazonaws.sagemaker#Workforces", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list containing information about your workforce.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "A token to resume pagination.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListWorkforcesSortByOptions": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CreateDate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDate" - } - } - } - }, - "com.amazonaws.sagemaker#ListWorkteams": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#ListWorkteamsRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#ListWorkteamsResponse" - }, - "traits": { - "smithy.api#documentation": "Gets a list of private work teams that you have defined in a region. The list may be empty if\n no work team satisfies the filter specified in the NameContains\n parameter.
The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A string in the work team's name. This filter returns only work teams whose name\n contains the specified string.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "If the result of the previous ListWorkteams request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.
The maximum number of work teams to return in each page of the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#ListWorkteamsResponse": { - "type": "structure", - "members": { - "Workteams": { - "target": "com.amazonaws.sagemaker#Workteams", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of Workteam objects, each describing a work team.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n work teams, use it in the subsequent request.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ListWorkteamsSortByOptions": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CreateDate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDate" - } - } - } - }, - "com.amazonaws.sagemaker#Long": { - "type": "long" - }, - "com.amazonaws.sagemaker#MLFramework": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" - } - }, - "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#ManagedInstanceScalingStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaxCandidates": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 750 - } - } - }, - "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.sagemaker#MaxConcurrentTaskCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 5000 - } - } - }, - "com.amazonaws.sagemaker#MaxConcurrentTransforms": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#MaxHumanLabeledObjectCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaxNumberOfTests": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaxNumberOfTrainingJobsNotImproving": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 3 - } - } - }, - "com.amazonaws.sagemaker#MaxParallelExecutionSteps": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaxParallelOfTests": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaxParallelTrainingJobs": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaxPayloadInMB": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#MaxPendingTimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#documentation": "Maximum job scheduler pending time in seconds.", - "smithy.api#range": { - "min": 7200, - "max": 2419200 - } - } - }, - "com.amazonaws.sagemaker#MaxPercentageOfInputDatasetLabeled": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#MaxRuntimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaxWaitTimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 600, - "max": 28800 - } - } - }, - "com.amazonaws.sagemaker#MaximumRetryAttempts": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 30 - } - } - }, - "com.amazonaws.sagemaker#MediaType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[-\\w]+\\/[-\\w+]+$" - } - }, - "com.amazonaws.sagemaker#MemberDefinition": { - "type": "structure", - "members": { - "CognitoMemberDefinition": { - "target": "com.amazonaws.sagemaker#CognitoMemberDefinition", - "traits": { - "smithy.api#documentation": "The Amazon Cognito user group that is part of the work team.
" - } - }, - "OidcMemberDefinition": { - "target": "com.amazonaws.sagemaker#OidcMemberDefinition", - "traits": { - "smithy.api#documentation": "A list user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.
Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
" - } - }, - "com.amazonaws.sagemaker#MemberDefinitions": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MemberDefinition" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#MemoryInMb": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 128 - } - } - }, - "com.amazonaws.sagemaker#MetadataProperties": { - "type": "structure", - "members": { - "CommitId": { - "target": "com.amazonaws.sagemaker#MetadataPropertyValue", - "traits": { - "smithy.api#documentation": "The commit ID.
" - } - }, - "Repository": { - "target": "com.amazonaws.sagemaker#MetadataPropertyValue", - "traits": { - "smithy.api#documentation": "The repository.
" - } - }, - "GeneratedBy": { - "target": "com.amazonaws.sagemaker#MetadataPropertyValue", - "traits": { - "smithy.api#documentation": "The entity this entity was generated by.
" - } - }, - "ProjectId": { - "target": "com.amazonaws.sagemaker#MetadataPropertyValue", - "traits": { - "smithy.api#documentation": "The project ID.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata properties of the tracking entity, trial, or trial component.
" - } - }, - "com.amazonaws.sagemaker#MetadataPropertyValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#MetricData": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.sagemaker#MetricName", - "traits": { - "smithy.api#documentation": "The name of the metric.
" - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#Float", - "traits": { - "smithy.api#documentation": "The value of the metric.
" - } - }, - "Timestamp": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the algorithm emitted the metric.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
" - } - }, - "com.amazonaws.sagemaker#MetricDataList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MetricDatum" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 40 - } - } - }, - "com.amazonaws.sagemaker#MetricDatum": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", - "traits": { - "smithy.api#documentation": "The name of the metric.
" - } - }, - "StandardMetricName": { - "target": "com.amazonaws.sagemaker#AutoMLMetricExtendedEnum", - "traits": { - "smithy.api#documentation": "The name of the standard metric.
\nFor definitions of the standard metrics, see \n Autopilot candidate metrics\n .
The value of the metric.
" - } - }, - "Set": { - "target": "com.amazonaws.sagemaker#MetricSetSource", - "traits": { - "smithy.api#documentation": "The dataset split from which the AutoML job produced the metric.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the metric for a candidate produced by an AutoML job.
" - } - }, - "com.amazonaws.sagemaker#MetricDefinition": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#MetricName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the metric.
", - "smithy.api#required": {} - } - }, - "Regex": { - "target": "com.amazonaws.sagemaker#MetricRegex", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A regular expression that searches the output of a training job and gets the value of\n the metric. For more information about using regular expressions to define metrics, see\n Defining metrics and environment variables.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a metric that the training algorithm writes to stderr or\n stdout. You can view these logs to understand how your training job\n performs and check for any errors encountered during training. SageMaker hyperparameter\n tuning captures all defined metrics. Specify one of the defined metrics to use as an\n objective metric using the TuningObjective parameter in the\n HyperParameterTrainingJobDefinition API to evaluate job performance\n during hyperparameter tuning.
Information about a predefined metric.
" - } - }, - "Customized": { - "target": "com.amazonaws.sagemaker#CustomizedMetricSpecification", - "traits": { - "smithy.api#documentation": "Information about a customized metric.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object containing information about a metric.
" - } - }, - "com.amazonaws.sagemaker#MetricValue": { - "type": "float" - }, - "com.amazonaws.sagemaker#MetricsSource": { - "type": "structure", - "members": { - "ContentType": { - "target": "com.amazonaws.sagemaker#ContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The metric source content type.
", - "smithy.api#required": {} - } - }, - "ContentDigest": { - "target": "com.amazonaws.sagemaker#ContentDigest", - "traits": { - "smithy.api#documentation": "The hash key used for the metrics source.
" - } - }, - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The S3 URI for the metrics source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the metrics source.
" - } - }, - "com.amazonaws.sagemaker#MinimumInstanceMetadataServiceVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - }, - "smithy.api#pattern": "^1|2$" - } - }, - "com.amazonaws.sagemaker#MlTools": { - "type": "enum", - "members": { - "DATA_WRANGLER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DataWrangler" - } - }, - "FEATURE_STORE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FeatureStore" - } - }, - "EMR_CLUSTERS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EmrClusters" - } - }, - "AUTO_ML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoMl" - } - }, - "EXPERIMENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Experiments" - } - }, - "TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Training" - } - }, - "MODEL_EVALUATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelEvaluation" - } - }, - "PIPELINES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pipelines" - } - }, - "MODELS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Models" - } - }, - "JUMP_START": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JumpStart" - } - }, - "INFERENCE_RECOMMENDER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InferenceRecommender" - } - }, - "ENDPOINTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Endpoints" - } - }, - "PROJECTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Projects" - } - }, - "INFERENCE_OPTIMIZATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InferenceOptimization" - } - }, - "PERFORMANCE_EVALUATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PerformanceEvaluation" - } - }, - "LAKERA_GUARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LakeraGuard" - } - }, - "COMET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Comet" - } - }, - "DEEPCHECKS_LLM_EVALUATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeepchecksLLMEvaluation" - } - }, - "FIDDLER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Fiddler" - } - }, - "HYPER_POD_CLUSTERS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HyperPodClusters" - } - } - } - }, - "com.amazonaws.sagemaker#MlflowVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 16 - }, - "smithy.api#pattern": "^[0-9]*.[0-9]*.[0-9]*$" - } - }, - "com.amazonaws.sagemaker#Model": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "The name of the model.
" - } - }, - "PrimaryContainer": { - "target": "com.amazonaws.sagemaker#ContainerDefinition" - }, - "Containers": { - "target": "com.amazonaws.sagemaker#ContainerDefinitionList", - "traits": { - "smithy.api#documentation": "The containers in the inference pipeline.
" - } - }, - "InferenceExecutionConfig": { - "target": "com.amazonaws.sagemaker#InferenceExecutionConfig" - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig" - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that indicates when the model was created.
" - } - }, - "ModelArn": { - "target": "com.amazonaws.sagemaker#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model.
" - } - }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of key-value pairs associated with the model. For more information, see\n Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" - } - }, - "DeploymentRecommendation": { - "target": "com.amazonaws.sagemaker#DeploymentRecommendation", - "traits": { - "smithy.api#documentation": "A set of recommended deployment configurations for the model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The properties of a model as returned by the Search API.
" - } - }, - "com.amazonaws.sagemaker#ModelAccessConfig": { - "type": "structure", - "members": { - "AcceptEula": { - "target": "com.amazonaws.sagemaker#AcceptEula", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies agreement to the model end-user license agreement (EULA). The\n AcceptEula value must be explicitly defined as True in order\n to accept the EULA that this model requires. You are responsible for reviewing and\n complying with any applicable license terms and making sure they are acceptable for your\n use case before downloading or using a model.
The access configuration file to control access to the ML model. You can explicitly accept the model\n end-user license agreement (EULA) within the ModelAccessConfig.
If you are a Jumpstart user, see the End-user license agreements section for more details on accepting the EULA.
\nIf you are an AutoML user, see the Optional Parameters section of\n Create an AutoML job to fine-tune text generation models using the\n API for details on How to set the EULA acceptance when fine-tuning a model using the AutoML\n API.
\nThe path of the S3 object that contains the model artifacts. For example,\n s3://bucket-name/keynameprefix/model.tar.gz.
Provides information about the location that is configured for storing model\n artifacts.
\nModel artifacts are outputs that result from training a model. They typically consist\n of trained parameters, a model definition that describes how to compute inferences, and\n other metadata. A SageMaker container stores your trained model artifacts in the\n /opt/ml/model directory. After training has completed, by default,\n these artifacts are uploaded to your Amazon S3 bucket as compressed files.
The container image to be run by the model bias job.
", - "smithy.api#required": {} - } - }, - "ConfigUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "JSON formatted S3 file that defines bias parameters. For more information on this JSON\n configuration file, see Configure\n bias parameters.
", - "smithy.api#required": {} - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", - "traits": { - "smithy.api#documentation": "Sets the environment variables in the Docker container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Docker container image configuration object for the model bias job.
" - } - }, - "com.amazonaws.sagemaker#ModelBiasBaselineConfig": { - "type": "structure", - "members": { - "BaseliningJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#documentation": "The name of the baseline model bias job.
" - } - }, - "ConstraintsResource": { - "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" - } - }, - "traits": { - "smithy.api#documentation": "The configuration for a baseline model bias job.
" - } - }, - "com.amazonaws.sagemaker#ModelBiasJobInput": { - "type": "structure", - "members": { - "EndpointInput": { - "target": "com.amazonaws.sagemaker#EndpointInput" - }, - "BatchTransformInput": { - "target": "com.amazonaws.sagemaker#BatchTransformInput", - "traits": { - "smithy.api#documentation": "Input object for the batch transform job.
" - } - }, - "GroundTruthS3Input": { - "target": "com.amazonaws.sagemaker#MonitoringGroundTruthS3Input", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Location of ground truth labels to use in model bias job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Inputs for the model bias job.
" - } - }, - "com.amazonaws.sagemaker#ModelCacheSetting": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - } - } - }, - "com.amazonaws.sagemaker#ModelCard": { - "type": "structure", - "members": { - "ModelCardArn": { - "target": "com.amazonaws.sagemaker#ModelCardArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card.
" - } - }, - "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The unique name of the model card.
" - } - }, - "ModelCardVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The version of the model card.
" - } - }, - "Content": { - "target": "com.amazonaws.sagemaker#ModelCardContent", - "traits": { - "smithy.api#documentation": "The content of the model card. Content uses the model card JSON schema and provided as a string.
" - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The security configuration used to protect model card data.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the model card was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the model card was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Key-value pairs used to manage metadata for the model card.
" - } - }, - "ModelId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The unique name (ID) of the model.
" - } - }, - "RiskRating": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
" - } - }, - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "An Amazon SageMaker Model Card.
" - } - }, - "com.amazonaws.sagemaker#ModelCardArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#ModelCardContent": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100000 - }, - "smithy.api#pattern": ".*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.sagemaker#ModelCardExportArtifacts": { - "type": "structure", - "members": { - "S3ExportArtifacts": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 URI of the exported model artifacts.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The artifacts of the model card export job.
" - } - }, - "com.amazonaws.sagemaker#ModelCardExportJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#ModelCardExportJobSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - } - }, - "traits": { - "smithy.api#documentation": "Attribute by which to sort returned export jobs." - } - }, - "com.amazonaws.sagemaker#ModelCardExportJobSortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.sagemaker#ModelCardExportJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.sagemaker#ModelCardExportJobSummary": { - "type": "structure", - "members": { - "ModelCardExportJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model card export job.
", - "smithy.api#required": {} - } - }, - "ModelCardExportJobArn": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card export job.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The completion status of the model card export job.
", - "smithy.api#required": {} - } - }, - "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model card that the export job exports.
", - "smithy.api#required": {} - } - }, - "ModelCardVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the model card that the export job exports.
", - "smithy.api#required": {} - } - }, - "CreatedAt": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the model card export job was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedAt": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the model card export job was last modified..
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The summary of the Amazon SageMaker Model Card export job.
" - } - }, - "com.amazonaws.sagemaker#ModelCardExportJobSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelCardExportJobSummary" - } - }, - "com.amazonaws.sagemaker#ModelCardExportOutputConfig": { - "type": "structure", - "members": { - "S3OutputPath": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 output path to export your model card PDF.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configure the export output details for an Amazon SageMaker Model Card.
" - } - }, - "com.amazonaws.sagemaker#ModelCardNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" - } - }, - "com.amazonaws.sagemaker#ModelCardProcessingStatus": { - "type": "enum", - "members": { - "DELETE_INPROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteInProgress" - } - }, - "DELETE_PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeletePending" - } - }, - "CONTENT_DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ContentDeleted" - } - }, - "EXPORTJOBS_DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExportJobsDeleted" - } - }, - "DELETE_COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteCompleted" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteFailed" - } - } - } - }, - "com.amazonaws.sagemaker#ModelCardSecurityConfig": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "A Key Management Service\n key\n ID to use for encrypting a model card.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configure the security settings to protect model card data.
" - } - }, - "com.amazonaws.sagemaker#ModelCardSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#ModelCardSortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.sagemaker#ModelCardStatus": { - "type": "enum", - "members": { - "DRAFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Draft" - } - }, - "PENDINGREVIEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingReview" - } - }, - "APPROVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Approved" - } - }, - "ARCHIVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Archived" - } - } - } - }, - "com.amazonaws.sagemaker#ModelCardSummary": { - "type": "structure", - "members": { - "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model card.
", - "smithy.api#required": {} - } - }, - "ModelCardArn": { - "target": "com.amazonaws.sagemaker#ModelCardArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card.
", - "smithy.api#required": {} - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The date and time that the model card was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the model card was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of the model card.
" - } - }, - "com.amazonaws.sagemaker#ModelCardSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelCardSummary" - } - }, - "com.amazonaws.sagemaker#ModelCardVersionSortBy": { - "type": "enum", - "members": { - "VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Version" - } - } - } - }, - "com.amazonaws.sagemaker#ModelCardVersionSummary": { - "type": "structure", - "members": { - "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model card.
", - "smithy.api#required": {} - } - }, - "ModelCardArn": { - "target": "com.amazonaws.sagemaker#ModelCardArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card.
", - "smithy.api#required": {} - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
A version of the model card.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The date and time that the model card version was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time date and time that the model card version was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of a specific version of the model card.
" - } - }, - "com.amazonaws.sagemaker#ModelCardVersionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelCardVersionSummary" - } - }, - "com.amazonaws.sagemaker#ModelClientConfig": { - "type": "structure", - "members": { - "InvocationsTimeoutInSeconds": { - "target": "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "The timeout value in seconds for an invocation request. The default value is\n 600.
" - } - }, - "InvocationsMaxRetries": { - "target": "com.amazonaws.sagemaker#InvocationsMaxRetries", - "traits": { - "smithy.api#documentation": "The maximum number of retries when invocation requests are failing. The default value\n is 3.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configures the timeout and maximum number of retries for processing a transform job\n invocation.
" - } - }, - "com.amazonaws.sagemaker#ModelCompilationConfig": { - "type": "structure", - "members": { - "Image": { - "target": "com.amazonaws.sagemaker#OptimizationContainerImage", - "traits": { - "smithy.api#documentation": "The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
" - } - }, - "OverrideEnvironment": { - "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", - "traits": { - "smithy.api#documentation": "Environment variables that override the default ones in the model container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for the model compilation technique that's applied by a model optimization job.
" - } - }, - "com.amazonaws.sagemaker#ModelCompressionType": { - "type": "enum", - "members": { - "None": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - }, - "Gzip": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gzip" - } - } - } - }, - "com.amazonaws.sagemaker#ModelConfiguration": { - "type": "structure", - "members": { - "InferenceSpecificationName": { - "target": "com.amazonaws.sagemaker#InferenceSpecificationName", - "traits": { - "smithy.api#documentation": "The inference specification name in the model package version.
" - } - }, - "EnvironmentParameters": { - "target": "com.amazonaws.sagemaker#EnvironmentParameters", - "traits": { - "smithy.api#documentation": "Defines the environment parameters that includes key, value types, and values.
" - } - }, - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#RecommendationJobCompilationJobName", - "traits": { - "smithy.api#documentation": "The name of the compilation job used to create the recommended model artifacts.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the model configuration. Includes the specification name and environment parameters.
" - } - }, - "com.amazonaws.sagemaker#ModelDashboardEndpoint": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The endpoint name.
", - "smithy.api#required": {} - } - }, - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that indicates when the endpoint was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The last time the endpoint was modified.
", - "smithy.api#required": {} - } - }, - "EndpointStatus": { - "target": "com.amazonaws.sagemaker#EndpointStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The endpoint status.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.
" - } - }, - "com.amazonaws.sagemaker#ModelDashboardEndpoints": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelDashboardEndpoint" - } - }, - "com.amazonaws.sagemaker#ModelDashboardIndicatorAction": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether the alert action is turned on.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into\n InAlert status.
A model displayed in the Model Dashboard.
" - } - }, - "Endpoints": { - "target": "com.amazonaws.sagemaker#ModelDashboardEndpoints", - "traits": { - "smithy.api#documentation": "The endpoints that host a model.
" - } - }, - "LastBatchTransformJob": { - "target": "com.amazonaws.sagemaker#TransformJob" - }, - "MonitoringSchedules": { - "target": "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedules", - "traits": { - "smithy.api#documentation": "The monitoring schedules for a model.
" - } - }, - "ModelCard": { - "target": "com.amazonaws.sagemaker#ModelDashboardModelCard", - "traits": { - "smithy.api#documentation": "The model card for a model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A model displayed in the Amazon SageMaker Model Dashboard.
" - } - }, - "com.amazonaws.sagemaker#ModelDashboardModelCard": { - "type": "structure", - "members": { - "ModelCardArn": { - "target": "com.amazonaws.sagemaker#ModelCardArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for a model card.
" - } - }, - "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of a model card.
" - } - }, - "ModelCardVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The model card version.
" - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#documentation": "The model card status.
" - } - }, - "SecurityConfig": { - "target": "com.amazonaws.sagemaker#ModelCardSecurityConfig", - "traits": { - "smithy.api#documentation": "The KMS Key ID (KMSKeyId) for encryption of model card information.
A timestamp that indicates when the model card was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that indicates when the model card was last updated.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "The tags associated with a model card.
" - } - }, - "ModelId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "For models created in SageMaker, this is the model ARN. For models created\n outside of SageMaker, this is a user-customized string.
" - } - }, - "RiskRating": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "A model card's risk rating. Can be low, medium, or high.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The model card for a model displayed in the Amazon SageMaker Model Dashboard.
" - } - }, - "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedule": { - "type": "structure", - "members": { - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a monitoring schedule.
" - } - }, - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#documentation": "The name of a monitoring schedule.
" - } - }, - "MonitoringScheduleStatus": { - "target": "com.amazonaws.sagemaker#ScheduleStatus", - "traits": { - "smithy.api#documentation": "The status of the monitoring schedule.
" - } - }, - "MonitoringType": { - "target": "com.amazonaws.sagemaker#MonitoringType", - "traits": { - "smithy.api#documentation": "The monitor type of a model monitor.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If a monitoring job failed, provides the reason.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that indicates when the monitoring schedule was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that indicates when the monitoring schedule was last updated.
" - } - }, - "MonitoringScheduleConfig": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig" - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "The endpoint which is monitored.
" - } - }, - "MonitoringAlertSummaries": { - "target": "com.amazonaws.sagemaker#MonitoringAlertSummaryList", - "traits": { - "smithy.api#documentation": "A JSON array where each element is a summary for a monitoring alert.
" - } - }, - "LastMonitoringExecutionSummary": { - "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary" - }, - "BatchTransformInput": { - "target": "com.amazonaws.sagemaker#BatchTransformInput" - } - }, - "traits": { - "smithy.api#documentation": "A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.
" - } - }, - "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedules": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedule" - } - }, - "com.amazonaws.sagemaker#ModelDataQuality": { - "type": "structure", - "members": { - "Statistics": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "Data quality statistics for a model.
" - } - }, - "Constraints": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "Data quality constraints for a model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Data quality constraints and statistics for a model.
" - } - }, - "com.amazonaws.sagemaker#ModelDataSource": { - "type": "structure", - "members": { - "S3DataSource": { - "target": "com.amazonaws.sagemaker#S3ModelDataSource", - "traits": { - "smithy.api#documentation": "Specifies the S3 location of ML model data to deploy.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the location of ML model data to deploy. If specified, you must specify one\n and only one of the available data sources.
" - } - }, - "com.amazonaws.sagemaker#ModelDeployConfig": { - "type": "structure", - "members": { - "AutoGenerateEndpointName": { - "target": "com.amazonaws.sagemaker#AutoGenerateEndpointName", - "traits": { - "smithy.api#documentation": "Set to True to automatically generate an endpoint name for a one-click\n Autopilot model deployment; set to False otherwise. The default value is\n False.
If you set AutoGenerateEndpointName to True, do not specify\n the EndpointName; otherwise a 400 error is thrown.
Specifies the endpoint name to use for a one-click Autopilot model deployment if the\n endpoint name is not generated automatically.
\nSpecify the EndpointName if and only if you set\n AutoGenerateEndpointName to False; otherwise a 400 error is\n thrown.
Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.
" - } - }, - "com.amazonaws.sagemaker#ModelDeployResult": { - "type": "structure", - "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "The name of the endpoint to which the model has been deployed.
\nIf model deployment fails, this field is omitted from the response.
\nProvides information about the endpoint of the model deployment.
" - } - }, - "com.amazonaws.sagemaker#ModelDigests": { - "type": "structure", - "members": { - "ArtifactDigest": { - "target": "com.amazonaws.sagemaker#ArtifactDigest", - "traits": { - "smithy.api#documentation": "Provides a hash value that uniquely identifies the stored model\n artifacts.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides information to verify the integrity of stored model artifacts.
" - } - }, - "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification": { - "type": "structure", - "members": { - "ImageUri": { - "target": "com.amazonaws.sagemaker#ImageUri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The container image to be run by the model explainability job.
", - "smithy.api#required": {} - } - }, - "ConfigUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "JSON formatted Amazon S3 file that defines explainability parameters. For more\n information on this JSON configuration file, see Configure model explainability parameters.
", - "smithy.api#required": {} - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", - "traits": { - "smithy.api#documentation": "Sets the environment variables in the Docker container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Docker container image configuration object for the model explainability job.
" - } - }, - "com.amazonaws.sagemaker#ModelExplainabilityBaselineConfig": { - "type": "structure", - "members": { - "BaseliningJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#documentation": "The name of the baseline model explainability job.
" - } - }, - "ConstraintsResource": { - "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" - } - }, - "traits": { - "smithy.api#documentation": "The configuration for a baseline model explainability job.
" - } - }, - "com.amazonaws.sagemaker#ModelExplainabilityJobInput": { - "type": "structure", - "members": { - "EndpointInput": { - "target": "com.amazonaws.sagemaker#EndpointInput" - }, - "BatchTransformInput": { - "target": "com.amazonaws.sagemaker#BatchTransformInput", - "traits": { - "smithy.api#documentation": "Input object for the batch transform job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Inputs for the model explainability job.
" - } - }, - "com.amazonaws.sagemaker#ModelInfrastructureConfig": { - "type": "structure", - "members": { - "InfrastructureType": { - "target": "com.amazonaws.sagemaker#ModelInfrastructureType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The inference option to which to deploy your model. Possible values are the following:
\n\n RealTime: Deploy to real-time inference.
The infrastructure configuration for deploying the model to real-time inference.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for the infrastructure that the model will be deployed to.
" - } - }, - "com.amazonaws.sagemaker#ModelInfrastructureType": { - "type": "enum", - "members": { - "REAL_TIME_INFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RealTimeInference" - } - } - } - }, - "com.amazonaws.sagemaker#ModelInput": { - "type": "structure", - "members": { - "DataInputConfig": { - "target": "com.amazonaws.sagemaker#DataInputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The input configuration object for the model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Input object for the model.
" - } - }, - "com.amazonaws.sagemaker#ModelInsightsLocation": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#ModelLatencyThreshold": { - "type": "structure", - "members": { - "Percentile": { - "target": "com.amazonaws.sagemaker#String64", - "traits": { - "smithy.api#documentation": "The model latency percentile threshold. Acceptable values are P95 and P99.\n For custom load tests, specify the value as P95.
The model latency percentile value in milliseconds.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The model latency threshold.
" - } - }, - "com.amazonaws.sagemaker#ModelLatencyThresholds": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelLatencyThreshold" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#ModelLifeCycle": { - "type": "structure", - "members": { - "Stage": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The current stage in the model life cycle.\n
", - "smithy.api#required": {} - } - }, - "StageStatus": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The current status of a stage in model life cycle.\n
", - "smithy.api#required": {} - } - }, - "StageDescription": { - "target": "com.amazonaws.sagemaker#StageDescription", - "traits": { - "smithy.api#documentation": "\n Describes the stage related details.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n A structure describing the current state of the model in its life cycle.\n
" - } - }, - "com.amazonaws.sagemaker#ModelMetadataFilter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#ModelMetadataFilterType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the of the model to filter by.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The value to filter the model metadata.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Part of the search expression. You can specify the name and value \n (domain, task, framework, framework version, task, and model).
" - } - }, - "com.amazonaws.sagemaker#ModelMetadataFilterType": { - "type": "enum", - "members": { - "DOMAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Domain" - } - }, - "FRAMEWORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Framework" - } - }, - "TASK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Task" - } - }, - "FRAMEWORKVERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FrameworkVersion" - } - } - } - }, - "com.amazonaws.sagemaker#ModelMetadataFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelMetadataFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4 - } - } - }, - "com.amazonaws.sagemaker#ModelMetadataSearchExpression": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.sagemaker#ModelMetadataFilters", - "traits": { - "smithy.api#documentation": "A list of filter objects.
" - } - } - }, - "traits": { - "smithy.api#documentation": "One or more filters that searches for the specified resource or resources in \n a search. All resource objects that satisfy the expression's condition are \n included in the search results
" - } - }, - "com.amazonaws.sagemaker#ModelMetadataSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelMetadataSummary" - } - }, - "com.amazonaws.sagemaker#ModelMetadataSummary": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The machine learning domain of the model.
", - "smithy.api#required": {} - } - }, - "Framework": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The machine learning framework of the model.
", - "smithy.api#required": {} - } - }, - "Task": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The machine learning task of the model.
", - "smithy.api#required": {} - } - }, - "Model": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model.
", - "smithy.api#required": {} - } - }, - "FrameworkVersion": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The framework version of the model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of the model metadata.
" - } - }, - "com.amazonaws.sagemaker#ModelMetrics": { - "type": "structure", - "members": { - "ModelQuality": { - "target": "com.amazonaws.sagemaker#ModelQuality", - "traits": { - "smithy.api#documentation": "Metrics that measure the quality of a model.
" - } - }, - "ModelDataQuality": { - "target": "com.amazonaws.sagemaker#ModelDataQuality", - "traits": { - "smithy.api#documentation": "Metrics that measure the quality of the input data for a model.
" - } - }, - "Bias": { - "target": "com.amazonaws.sagemaker#Bias", - "traits": { - "smithy.api#documentation": "Metrics that measure bias in a model.
" - } - }, - "Explainability": { - "target": "com.amazonaws.sagemaker#Explainability", - "traits": { - "smithy.api#documentation": "Metrics that help explain a model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains metrics captured from a model.
" - } - }, - "com.amazonaws.sagemaker#ModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" - } - }, - "com.amazonaws.sagemaker#ModelNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.sagemaker#ModelPackage": { - "type": "structure", - "members": { - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the model.
" - } - }, - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The model group to which the model belongs.
" - } - }, - "ModelPackageVersion": { - "target": "com.amazonaws.sagemaker#ModelPackageVersion", - "traits": { - "smithy.api#documentation": "The version number of a versioned model.
" - } - }, - "ModelPackageArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
" - } - }, - "ModelPackageDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "The description of the model package.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "The time that the model package was created.
" - } - }, - "InferenceSpecification": { - "target": "com.amazonaws.sagemaker#InferenceSpecification", - "traits": { - "smithy.api#documentation": "Defines how to perform inference generation after a training job is run.
" - } - }, - "SourceAlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", - "traits": { - "smithy.api#documentation": "A list of algorithms that were used to create a model package.
" - } - }, - "ValidationSpecification": { - "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", - "traits": { - "smithy.api#documentation": "Specifies batch transform jobs that SageMaker runs to validate your model package.
" - } - }, - "ModelPackageStatus": { - "target": "com.amazonaws.sagemaker#ModelPackageStatus", - "traits": { - "smithy.api#documentation": "The status of the model package. This can be one of the following values.
\n\n PENDING - The model package is pending being created.
\n IN_PROGRESS - The model package is in the process of being\n created.
\n COMPLETED - The model package was successfully created.
\n FAILED - The model package failed.
\n DELETING - The model package is in the process of being deleted.
Specifies the validation and image scan statuses of the model package.
" - } - }, - "CertifyForMarketplace": { - "target": "com.amazonaws.sagemaker#CertifyForMarketplace", - "traits": { - "smithy.api#documentation": "Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For\n information about listing model packages on Amazon Web Services Marketplace, see List Your\n Algorithm or Model Package on Amazon Web Services Marketplace.
" - } - }, - "ModelApprovalStatus": { - "target": "com.amazonaws.sagemaker#ModelApprovalStatus", - "traits": { - "smithy.api#documentation": "The approval status of the model. This can be one of the following values.
\n\n APPROVED - The model is approved
\n REJECTED - The model is rejected.
\n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.
Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
" - } - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties", - "traits": { - "smithy.api#documentation": "Metadata properties of the tracking entity, trial, or trial component.
" - } - }, - "ModelMetrics": { - "target": "com.amazonaws.sagemaker#ModelMetrics", - "traits": { - "smithy.api#documentation": "Metrics for the model.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The last time the model package was modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
" - } - }, - "ApprovalDescription": { - "target": "com.amazonaws.sagemaker#ApprovalDescription", - "traits": { - "smithy.api#documentation": "A description provided when the model approval is set.
" - } - }, - "Domain": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.
" - } - }, - "Task": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification.
" - } - }, - "SamplePayloadUrl": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to\n a single gzip compressed tar archive (.tar.gz suffix).
" - } - }, - "AdditionalInferenceSpecifications": { - "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", - "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects.
" - } - }, - "SourceUri": { - "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", - "traits": { - "smithy.api#documentation": "The URI of the source for the model package.
" - } - }, - "SecurityConfig": { - "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig" - }, - "ModelCard": { - "target": "com.amazonaws.sagemaker#ModelPackageModelCard" - }, - "ModelLifeCycle": { - "target": "com.amazonaws.sagemaker#ModelLifeCycle", - "traits": { - "smithy.api#documentation": "\n A structure describing the current state of the model in its life cycle.\n
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" - } - }, - "CustomerMetadataProperties": { - "target": "com.amazonaws.sagemaker#CustomerMetadataMap", - "traits": { - "smithy.api#documentation": "The metadata properties for the model package.
" - } - }, - "DriftCheckBaselines": { - "target": "com.amazonaws.sagemaker#DriftCheckBaselines", - "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.
" - } - }, - "SkipModelValidation": { - "target": "com.amazonaws.sagemaker#SkipModelValidation", - "traits": { - "smithy.api#documentation": "Indicates if you want to skip model validation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A versioned model that can be deployed for SageMaker inference.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$" - } - }, - "com.amazonaws.sagemaker#ModelPackageArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelPackageArn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#ModelPackageContainerDefinition": { - "type": "structure", - "members": { - "ContainerHostname": { - "target": "com.amazonaws.sagemaker#ContainerHostname", - "traits": { - "smithy.api#documentation": "The DNS host name for the Docker container.
" - } - }, - "Image": { - "target": "com.amazonaws.sagemaker#ContainerImage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon EC2 Container Registry path where inference code is stored.
\nIf you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.
An MD5 hash of the training algorithm that identifies the Docker image used for\n training.
" - } - }, - "ModelDataUrl": { - "target": "com.amazonaws.sagemaker#Url", - "traits": { - "smithy.api#documentation": "The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same region as the\n model package.
\nSpecifies the location of ML model data to deploy during endpoint creation.
" - } - }, - "ProductId": { - "target": "com.amazonaws.sagemaker#ProductId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Marketplace product ID of the model package.
" - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#EnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.
A structure with Model Input details.
" - } - }, - "Framework": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The machine learning framework of the model package container image.
" - } - }, - "FrameworkVersion": { - "target": "com.amazonaws.sagemaker#ModelPackageFrameworkVersion", - "traits": { - "smithy.api#documentation": "The framework version of the Model Package Container Image.
" - } - }, - "NearestModelName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The name of a pre-trained machine learning benchmarked by \n Amazon SageMaker Inference Recommender model that matches your model. \n You can find a list of benchmarked models by calling ListModelMetadata.
The additional data source that is used during inference in the Docker container for\n your model package.
" - } - }, - "ModelDataETag": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The ETag associated with Model Data URL.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the Docker container for the model package.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinition" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 15 - } - } - }, - "com.amazonaws.sagemaker#ModelPackageFrameworkVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 10 - }, - "smithy.api#pattern": "^[0-9]\\.[A-Za-z0-9.-]+$" - } - }, - "com.amazonaws.sagemaker#ModelPackageGroup": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the model group.
" - } - }, - "ModelPackageGroupArn": { - "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model group.
" - } - }, - "ModelPackageGroupDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "The description for the model group.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "The time that the model group was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "ModelPackageGroupStatus": { - "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", - "traits": { - "smithy.api#documentation": "The status of the model group. This can be one of the following values.
\n\n PENDING - The model group is pending being created.
\n IN_PROGRESS - The model group is in the process of being\n created.
\n COMPLETED - The model group was successfully created.
\n FAILED - The model group failed.
\n DELETING - The model group is in the process of being deleted.
\n DELETE_FAILED - SageMaker failed to delete the model group.
A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A group of versioned models in the model registry.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}$" - } - }, - "com.amazonaws.sagemaker#ModelPackageGroupSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#ModelPackageGroupStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteFailed" - } - } - } - }, - "com.amazonaws.sagemaker#ModelPackageGroupSummary": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model group.
", - "smithy.api#required": {} - } - }, - "ModelPackageGroupArn": { - "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model group.
", - "smithy.api#required": {} - } - }, - "ModelPackageGroupDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A description of the model group.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time that the model group was created.
", - "smithy.api#required": {} - } - }, - "ModelPackageGroupStatus": { - "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the model group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Summary information about a model group.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageGroupSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelPackageGroupSummary" - } - }, - "com.amazonaws.sagemaker#ModelPackageModelCard": { - "type": "structure", - "members": { - "ModelCardContent": { - "target": "com.amazonaws.sagemaker#ModelCardContent", - "traits": { - "smithy.api#documentation": "The content of the model card. The content must follow the schema described\n in Model\n Package Model Card Schema.
" - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates can be made to the model\n card content. If you try to update the model card content, you will receive the message Model Card\n \t is in Archived state.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
The KMS Key ID (KMSKeyId) used for encryption of model package information.
An optional Key Management Service\n key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with\n highly sensitive data.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#ModelPackageSourceUri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{N}\\p{P}]{0,1024}$" - } - }, - "com.amazonaws.sagemaker#ModelPackageStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.sagemaker#ModelPackageStatusDetails": { - "type": "structure", - "members": { - "ValidationStatuses": { - "target": "com.amazonaws.sagemaker#ModelPackageStatusItemList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The validation status of the model package.
", - "smithy.api#required": {} - } - }, - "ImageScanStatuses": { - "target": "com.amazonaws.sagemaker#ModelPackageStatusItemList", - "traits": { - "smithy.api#documentation": "The status of the scan of the Docker image container for the model package.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the validation and image scan statuses of the model package.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageStatusItem": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model package for which the overall status is being reported.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#DetailedModelPackageStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "if the overall status is Failed, the reason for the failure.
Represents the overall status of a model package.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageStatusItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelPackageStatusItem" - } - }, - "com.amazonaws.sagemaker#ModelPackageSummaries": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#ModelPackageArn" - }, - "value": { - "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageSummary" - } - }, - "com.amazonaws.sagemaker#ModelPackageSummary": { - "type": "structure", - "members": { - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "The name of the model package.
" - } - }, - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "If the model package is a versioned model, the model group that the versioned model\n belongs to.
" - } - }, - "ModelPackageVersion": { - "target": "com.amazonaws.sagemaker#ModelPackageVersion", - "traits": { - "smithy.api#documentation": "If the model package is a versioned model, the version of the model.
" - } - }, - "ModelPackageArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
", - "smithy.api#required": {} - } - }, - "ModelPackageDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "A brief description of the model package.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the model package was created.
", - "smithy.api#required": {} - } - }, - "ModelPackageStatus": { - "target": "com.amazonaws.sagemaker#ModelPackageStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The overall status of the model package.
", - "smithy.api#required": {} - } - }, - "ModelApprovalStatus": { - "target": "com.amazonaws.sagemaker#ModelApprovalStatus", - "traits": { - "smithy.api#documentation": "The approval status of the model. This can be one of the following values.
\n\n APPROVED - The model is approved
\n REJECTED - The model is rejected.
\n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.
Provides summary information about a model package.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelPackageSummary" - } - }, - "com.amazonaws.sagemaker#ModelPackageType": { - "type": "enum", - "members": { - "VERSIONED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Versioned" - } - }, - "UNVERSIONED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unversioned" - } - }, - "BOTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Both" - } - } - } - }, - "com.amazonaws.sagemaker#ModelPackageValidationProfile": { - "type": "structure", - "members": { - "ProfileName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the profile for the model package.
", - "smithy.api#required": {} - } - }, - "TransformJobDefinition": { - "target": "com.amazonaws.sagemaker#TransformJobDefinition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The TransformJobDefinition object that describes the transform job used\n for the validation of the model package.
Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.
\nThe data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageValidationProfiles": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelPackageValidationProfile" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#ModelPackageValidationSpecification": { - "type": "structure", - "members": { - "ValidationRole": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IAM roles to be used for the validation of the model package.
", - "smithy.api#required": {} - } - }, - "ValidationProfiles": { - "target": "com.amazonaws.sagemaker#ModelPackageValidationProfiles", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of ModelPackageValidationProfile objects, each of which\n specifies a batch transform job that SageMaker runs to validate your model package.
Specifies batch transform jobs that SageMaker runs to validate your model package.
" - } - }, - "com.amazonaws.sagemaker#ModelPackageVersion": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#ModelQuality": { - "type": "structure", - "members": { - "Statistics": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "Model quality statistics.
" - } - }, - "Constraints": { - "target": "com.amazonaws.sagemaker#MetricsSource", - "traits": { - "smithy.api#documentation": "Model quality constraints.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Model quality statistics and constraints.
" - } - }, - "com.amazonaws.sagemaker#ModelQualityAppSpecification": { - "type": "structure", - "members": { - "ImageUri": { - "target": "com.amazonaws.sagemaker#ImageUri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The address of the container image that the monitoring job runs.
", - "smithy.api#required": {} - } - }, - "ContainerEntrypoint": { - "target": "com.amazonaws.sagemaker#ContainerEntrypoint", - "traits": { - "smithy.api#documentation": "Specifies the entrypoint for a container that the monitoring job runs.
" - } - }, - "ContainerArguments": { - "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", - "traits": { - "smithy.api#documentation": "An array of arguments for the container used to run the monitoring job.
" - } - }, - "RecordPreprocessorSourceUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" - } - }, - "PostAnalyticsProcessorSourceUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" - } - }, - "ProblemType": { - "target": "com.amazonaws.sagemaker#MonitoringProblemType", - "traits": { - "smithy.api#documentation": "The machine learning problem type of the model that the monitoring job monitors.
" - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", - "traits": { - "smithy.api#documentation": "Sets the environment variables in the container that the monitoring job runs.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Container image configuration object for the monitoring job.
" - } - }, - "com.amazonaws.sagemaker#ModelQualityBaselineConfig": { - "type": "structure", - "members": { - "BaseliningJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#documentation": "The name of the job that performs baselining for the monitoring job.
" - } - }, - "ConstraintsResource": { - "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" - } - }, - "traits": { - "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" - } - }, - "com.amazonaws.sagemaker#ModelQualityJobInput": { - "type": "structure", - "members": { - "EndpointInput": { - "target": "com.amazonaws.sagemaker#EndpointInput" - }, - "BatchTransformInput": { - "target": "com.amazonaws.sagemaker#BatchTransformInput", - "traits": { - "smithy.api#documentation": "Input object for the batch transform job.
" - } - }, - "GroundTruthS3Input": { - "target": "com.amazonaws.sagemaker#MonitoringGroundTruthS3Input", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ground truth label provided for the model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The input for the model quality monitoring job. Currently endpoints are supported for\n input for model quality monitoring jobs.
" - } - }, - "com.amazonaws.sagemaker#ModelQuantizationConfig": { - "type": "structure", - "members": { - "Image": { - "target": "com.amazonaws.sagemaker#OptimizationContainerImage", - "traits": { - "smithy.api#documentation": "The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
" - } - }, - "OverrideEnvironment": { - "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", - "traits": { - "smithy.api#documentation": "Environment variables that override the default ones in the model container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for the model quantization technique that's applied by a model optimization job.
" - } - }, - "com.amazonaws.sagemaker#ModelRegisterSettings": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#FeatureStatus", - "traits": { - "smithy.api#documentation": "Describes whether the integration to the model registry is enabled or disabled in the\n Canvas application.
" - } - }, - "CrossAccountModelRegisterRoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions\n created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services\n account in which SageMaker model registry is set up.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The model registry settings for the SageMaker Canvas application.
" - } - }, - "com.amazonaws.sagemaker#ModelSetupTime": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#ModelShardingConfig": { - "type": "structure", - "members": { - "Image": { - "target": "com.amazonaws.sagemaker#OptimizationContainerImage", - "traits": { - "smithy.api#documentation": "The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
" - } - }, - "OverrideEnvironment": { - "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", - "traits": { - "smithy.api#documentation": "Environment variables that override the default ones in the model container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for the model sharding technique that's applied by a model optimization job.
" - } - }, - "com.amazonaws.sagemaker#ModelSortKey": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#ModelStepMetadata": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for Model steps.
" - } - }, - "com.amazonaws.sagemaker#ModelSummary": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model that you want a summary for.
", - "smithy.api#required": {} - } - }, - "ModelArn": { - "target": "com.amazonaws.sagemaker#ModelArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that indicates when the model was created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Provides summary information about a model.
" - } - }, - "com.amazonaws.sagemaker#ModelSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelSummary" - } - }, - "com.amazonaws.sagemaker#ModelVariantAction": { - "type": "enum", - "members": { - "RETAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Retain" - } - }, - "REMOVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Remove" - } - }, - "PROMOTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Promote" - } - } - } - }, - "com.amazonaws.sagemaker#ModelVariantActionMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#ModelVariantName" - }, - "value": { - "target": "com.amazonaws.sagemaker#ModelVariantAction" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.sagemaker#ModelVariantConfig": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Amazon SageMaker Model entity.
", - "smithy.api#required": {} - } - }, - "VariantName": { - "target": "com.amazonaws.sagemaker#ModelVariantName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the variant.
", - "smithy.api#required": {} - } - }, - "InfrastructureConfig": { - "target": "com.amazonaws.sagemaker#ModelInfrastructureConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration for the infrastructure that the model will be deployed to.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the deployment options of a model.
" - } - }, - "com.amazonaws.sagemaker#ModelVariantConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelVariantConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.sagemaker#ModelVariantConfigSummary": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Amazon SageMaker Model entity.
", - "smithy.api#required": {} - } - }, - "VariantName": { - "target": "com.amazonaws.sagemaker#ModelVariantName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the variant.
", - "smithy.api#required": {} - } - }, - "InfrastructureConfig": { - "target": "com.amazonaws.sagemaker#ModelInfrastructureConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration of the infrastructure that the model has been deployed to.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#ModelVariantStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of deployment for the model variant on the hosted inference endpoint.
\n\n Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.\n
\n InService - The model variant is running on the hosted inference endpoint.\n
\n Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.\n
\n Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.\n
\n Deleted - The model variant has been deleted on the hosted inference endpoint. This\n can only happen after stopping the experiment.\n
Summary of the deployment configuration of a model.
" - } - }, - "com.amazonaws.sagemaker#ModelVariantConfigSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ModelVariantConfigSummary" - } - }, - "com.amazonaws.sagemaker#ModelVariantName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" - } - }, - "com.amazonaws.sagemaker#ModelVariantStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "IN_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleted" - } - } - } - }, - "com.amazonaws.sagemaker#MonitoringAlertActions": { - "type": "structure", - "members": { - "ModelDashboardIndicator": { - "target": "com.amazonaws.sagemaker#ModelDashboardIndicatorAction", - "traits": { - "smithy.api#documentation": "An alert action taken to light up an icon on the Model Dashboard when an alert goes into\n InAlert status.
A list of alert actions taken in response to an alert going into\n InAlert status.
The name of a monitoring schedule.
", - "smithy.api#required": {} - } - }, - "MonitoringAlertName": { - "target": "com.amazonaws.sagemaker#MonitoringAlertName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a monitoring alert.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that indicates when the first alert transition occurred in an alert history.\n An alert transition can be from status InAlert to OK, \n or from OK to InAlert.
The current alert status of an alert.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Provides summary information of an alert's history.
" - } - }, - "com.amazonaws.sagemaker#MonitoringAlertName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#MonitoringAlertStatus": { - "type": "enum", - "members": { - "IN_ALERT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InAlert" - } - }, - "OK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OK" - } - } - } - }, - "com.amazonaws.sagemaker#MonitoringAlertSummary": { - "type": "structure", - "members": { - "MonitoringAlertName": { - "target": "com.amazonaws.sagemaker#MonitoringAlertName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a monitoring alert.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that indicates when a monitor alert was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that indicates when a monitor alert was last updated.
", - "smithy.api#required": {} - } - }, - "AlertStatus": { - "target": "com.amazonaws.sagemaker#MonitoringAlertStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of an alert.
", - "smithy.api#required": {} - } - }, - "DatapointsToAlert": { - "target": "com.amazonaws.sagemaker#MonitoringDatapointsToAlert", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Within EvaluationPeriod, how many execution failures will raise an\n alert.
The number of most recent monitoring executions to consider when evaluating alert\n status.
", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.sagemaker#MonitoringAlertActions", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of alert actions taken in response to an alert going into\n InAlert status.
Provides summary information about a monitor alert.
" - } - }, - "com.amazonaws.sagemaker#MonitoringAlertSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MonitoringAlertSummary" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#MonitoringAppSpecification": { - "type": "structure", - "members": { - "ImageUri": { - "target": "com.amazonaws.sagemaker#ImageUri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The container image to be run by the monitoring job.
", - "smithy.api#required": {} - } - }, - "ContainerEntrypoint": { - "target": "com.amazonaws.sagemaker#ContainerEntrypoint", - "traits": { - "smithy.api#documentation": "Specifies the entrypoint for a container used to run the monitoring job.
" - } - }, - "ContainerArguments": { - "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", - "traits": { - "smithy.api#documentation": "An array of arguments for the container used to run the monitoring job.
" - } - }, - "RecordPreprocessorSourceUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" - } - }, - "PostAnalyticsProcessorSourceUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Container image configuration object for the monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringBaselineConfig": { - "type": "structure", - "members": { - "BaseliningJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#documentation": "The name of the job that performs baselining for the monitoring job.
" - } - }, - "ConstraintsResource": { - "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource", - "traits": { - "smithy.api#documentation": "The baseline constraint file in Amazon S3 that the current monitoring job should\n validated against.
" - } - }, - "StatisticsResource": { - "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource", - "traits": { - "smithy.api#documentation": "The baseline statistics file in Amazon S3 that the current monitoring job should\n be validated against.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" - } - }, - "com.amazonaws.sagemaker#MonitoringClusterConfig": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.sagemaker#ProcessingInstanceCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of ML compute instances to use in the model monitoring job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProcessingInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ML compute instance type for the processing job.
", - "smithy.api#required": {} - } - }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size of the ML storage volume, in gigabytes, that you want to provision. You must\n specify sufficient ML storage for your scenario.
", - "smithy.api#required": {} - } - }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker AI uses to\n encrypt data on the storage volume attached to the ML compute instance(s) that run the\n model monitoring job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration for the cluster used to run model monitoring jobs.
" - } - }, - "com.amazonaws.sagemaker#MonitoringConstraintsResource": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI for the constraints resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The constraints resource for a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringContainerArguments": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ContainerArgument" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#MonitoringCsvDatasetFormat": { - "type": "structure", - "members": { - "Header": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Indicates if the CSV data has a header.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the CSV dataset format used when running a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringDatapointsToAlert": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#MonitoringDatasetFormat": { - "type": "structure", - "members": { - "Csv": { - "target": "com.amazonaws.sagemaker#MonitoringCsvDatasetFormat", - "traits": { - "smithy.api#documentation": "The CSV dataset used in the monitoring job.
" - } - }, - "Json": { - "target": "com.amazonaws.sagemaker#MonitoringJsonDatasetFormat", - "traits": { - "smithy.api#documentation": "The JSON dataset used in the monitoring job
" - } - }, - "Parquet": { - "target": "com.amazonaws.sagemaker#MonitoringParquetDatasetFormat", - "traits": { - "smithy.api#documentation": "The Parquet dataset used in the monitoring job
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the dataset format used when running a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringEnvironmentMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#MonitoringEvaluationPeriod": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#MonitoringExecutionSortKey": { - "type": "enum", - "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "SCHEDULED_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ScheduledTime" - } - }, - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - } - } - }, - "com.amazonaws.sagemaker#MonitoringExecutionSummary": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the monitoring schedule.
", - "smithy.api#required": {} - } - }, - "ScheduledTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time the monitoring job was scheduled.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time at which the monitoring job was created.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that indicates the last time the monitoring job was modified.
", - "smithy.api#required": {} - } - }, - "MonitoringExecutionStatus": { - "target": "com.amazonaws.sagemaker#ExecutionStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the monitoring job.
", - "smithy.api#required": {} - } - }, - "ProcessingJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring job.
" - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "The name of the endpoint used to run the monitoring job.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "Contains the reason a monitoring job failed, if it failed.
" - } - }, - "MonitoringJobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#documentation": "The name of the monitoring job.
" - } - }, - "MonitoringType": { - "target": "com.amazonaws.sagemaker#MonitoringType", - "traits": { - "smithy.api#documentation": "The type of the monitoring job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summary of information about the last monitoring job to run.
" - } - }, - "com.amazonaws.sagemaker#MonitoringExecutionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary" - } - }, - "com.amazonaws.sagemaker#MonitoringGroundTruthS3Input": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#MonitoringS3Uri", - "traits": { - "smithy.api#documentation": "The address of the Amazon S3 location of the ground truth labels.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The ground truth labels for the dataset used for the monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringInput": { - "type": "structure", - "members": { - "EndpointInput": { - "target": "com.amazonaws.sagemaker#EndpointInput", - "traits": { - "smithy.api#documentation": "The endpoint for a monitoring job.
" - } - }, - "BatchTransformInput": { - "target": "com.amazonaws.sagemaker#BatchTransformInput", - "traits": { - "smithy.api#documentation": "Input object for the batch transform job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The inputs for a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringInputs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MonitoringInput" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#MonitoringJobDefinition": { - "type": "structure", - "members": { - "BaselineConfig": { - "target": "com.amazonaws.sagemaker#MonitoringBaselineConfig", - "traits": { - "smithy.api#documentation": "Baseline configuration used to validate that the data conforms to the specified\n constraints and statistics
" - } - }, - "MonitoringInputs": { - "target": "com.amazonaws.sagemaker#MonitoringInputs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.
", - "smithy.api#required": {} - } - }, - "MonitoringOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The array of outputs from the monitoring job to be uploaded to Amazon S3.
", - "smithy.api#required": {} - } - }, - "MonitoringResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n monitoring job. In distributed processing, you specify more than one instance.
", - "smithy.api#required": {} - } - }, - "MonitoringAppSpecification": { - "target": "com.amazonaws.sagemaker#MonitoringAppSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configures the monitoring job to run a specified Docker container image.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition", - "traits": { - "smithy.api#documentation": "Specifies a time limit for how long the monitoring job is allowed to run.
" - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", - "traits": { - "smithy.api#documentation": "Sets the environment variables in the Docker container.
" - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#NetworkConfig", - "traits": { - "smithy.api#documentation": "Specifies networking options for an monitoring job.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringJobDefinitionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#MonitoringJobDefinitionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#MonitoringJobDefinitionSummary": { - "type": "structure", - "members": { - "MonitoringJobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the monitoring job.
", - "smithy.api#required": {} - } - }, - "MonitoringJobDefinitionArn": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time that the monitoring job was created.
", - "smithy.api#required": {} - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint that the job monitors.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Summary information about a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummary" - } - }, - "com.amazonaws.sagemaker#MonitoringJsonDatasetFormat": { - "type": "structure", - "members": { - "Line": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Indicates if the file should be read as a JSON object per line.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the JSON dataset format used when running a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 86400 - } - } - }, - "com.amazonaws.sagemaker#MonitoringNetworkConfig": { - "type": "structure", - "members": { - "EnableInterContainerTrafficEncryption": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Whether to encrypt all communications between the instances used for the monitoring\n jobs. Choose True to encrypt communications. Encryption provides greater\n security for distributed jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for\n the monitoring job.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig" - } - }, - "traits": { - "smithy.api#documentation": "The networking configuration for the monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringOutput": { - "type": "structure", - "members": { - "S3Output": { - "target": "com.amazonaws.sagemaker#MonitoringS3Output", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 storage location where the results of a monitoring job are\n saved.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The output object for a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringOutputConfig": { - "type": "structure", - "members": { - "MonitoringOutputs": { - "target": "com.amazonaws.sagemaker#MonitoringOutputs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Monitoring outputs for monitoring jobs. This is where the output of the periodic\n monitoring jobs is uploaded.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker AI uses to\n encrypt the model artifacts at rest using Amazon S3 server-side encryption.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output configuration for monitoring jobs.
" - } - }, - "com.amazonaws.sagemaker#MonitoringOutputs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MonitoringOutput" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#MonitoringParquetDatasetFormat": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Represents the Parquet dataset format used when running a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringProblemType": { - "type": "enum", - "members": { - "BINARY_CLASSIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BinaryClassification" - } - }, - "MULTICLASS_CLASSIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MulticlassClassification" - } - }, - "REGRESSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Regression" - } - } - } - }, - "com.amazonaws.sagemaker#MonitoringResources": { - "type": "structure", - "members": { - "ClusterConfig": { - "target": "com.amazonaws.sagemaker#MonitoringClusterConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration for the cluster resources used to run the processing job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Identifies the resources to deploy for a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringS3Output": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#MonitoringS3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker AI\n saves the results of a monitoring job.
", - "smithy.api#required": {} - } - }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#ProcessingLocalPath", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The local path to the Amazon S3 storage location where Amazon SageMaker AI\n saves the results of a monitoring job. LocalPath is an absolute path for the output\n data.
", - "smithy.api#required": {} - } - }, - "S3UploadMode": { - "target": "com.amazonaws.sagemaker#ProcessingS3UploadMode", - "traits": { - "smithy.api#documentation": "Whether to upload the results of the monitoring job continuously or after the job\n completes.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about where and how you want to store the results of a monitoring\n job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringS3Uri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" - } - }, - "com.amazonaws.sagemaker#MonitoringSchedule": { - "type": "structure", - "members": { - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
" - } - }, - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#documentation": "The name of the monitoring schedule.
" - } - }, - "MonitoringScheduleStatus": { - "target": "com.amazonaws.sagemaker#ScheduleStatus", - "traits": { - "smithy.api#documentation": "The status of the monitoring schedule. This can be one of the following values.
\n\n PENDING - The schedule is pending being created.
\n FAILED - The schedule failed.
\n SCHEDULED - The schedule was successfully created.
\n STOPPED - The schedule was stopped.
The type of the monitoring job definition to schedule.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the monitoring schedule failed, the reason it failed.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the monitoring schedule was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The last time the monitoring schedule was changed.
" - } - }, - "MonitoringScheduleConfig": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig" - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "The endpoint that hosts the model being monitored.
" - } - }, - "LastMonitoringExecutionSummary": { - "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A schedule for a model monitoring job. For information about model monitor, see\n Amazon SageMaker Model\n Monitor.
" - } - }, - "com.amazonaws.sagemaker#MonitoringScheduleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#MonitoringScheduleConfig": { - "type": "structure", - "members": { - "ScheduleConfig": { - "target": "com.amazonaws.sagemaker#ScheduleConfig", - "traits": { - "smithy.api#documentation": "Configures the monitoring schedule.
" - } - }, - "MonitoringJobDefinition": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinition", - "traits": { - "smithy.api#documentation": "Defines the monitoring job.
" - } - }, - "MonitoringJobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#documentation": "The name of the monitoring job definition to schedule.
" - } - }, - "MonitoringType": { - "target": "com.amazonaws.sagemaker#MonitoringType", - "traits": { - "smithy.api#documentation": "The type of the monitoring job definition to schedule.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configures the monitoring schedule and defines the monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringScheduleList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MonitoringSchedule" - } - }, - "com.amazonaws.sagemaker#MonitoringScheduleName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#MonitoringScheduleSortKey": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - } - } - }, - "com.amazonaws.sagemaker#MonitoringScheduleSummary": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the monitoring schedule.
", - "smithy.api#required": {} - } - }, - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The creation time of the monitoring schedule.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The last time the monitoring schedule was modified.
", - "smithy.api#required": {} - } - }, - "MonitoringScheduleStatus": { - "target": "com.amazonaws.sagemaker#ScheduleStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the monitoring schedule.
", - "smithy.api#required": {} - } - }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", - "traits": { - "smithy.api#documentation": "The name of the endpoint using the monitoring schedule.
" - } - }, - "MonitoringJobDefinitionName": { - "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", - "traits": { - "smithy.api#documentation": "The name of the monitoring job definition that the schedule is for.
" - } - }, - "MonitoringType": { - "target": "com.amazonaws.sagemaker#MonitoringType", - "traits": { - "smithy.api#documentation": "The type of the monitoring job definition that the schedule is for.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summarizes the monitoring schedule.
" - } - }, - "com.amazonaws.sagemaker#MonitoringScheduleSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleSummary" - } - }, - "com.amazonaws.sagemaker#MonitoringStatisticsResource": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI for the statistics resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The statistics resource for a monitoring job.
" - } - }, - "com.amazonaws.sagemaker#MonitoringStoppingCondition": { - "type": "structure", - "members": { - "MaxRuntimeInSeconds": { - "target": "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum runtime allowed in seconds.
\nThe MaxRuntimeInSeconds cannot exceed the frequency of the job. For data\n quality and model explainability, this can be up to 3600 seconds for an hourly schedule.\n For model bias and model quality hourly schedules, this can be up to 1800\n seconds.
A time limit for how long the monitoring job is allowed to run before stopping.
" - } - }, - "com.amazonaws.sagemaker#MonitoringTimeOffsetString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 15 - }, - "smithy.api#pattern": "^.?P" - } - }, - "com.amazonaws.sagemaker#MonitoringType": { - "type": "enum", - "members": { - "DATA_QUALITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DataQuality" - } - }, - "MODEL_QUALITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelQuality" - } - }, - "MODEL_BIAS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelBias" - } - }, - "MODEL_EXPLAINABILITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelExplainability" - } - } - } - }, - "com.amazonaws.sagemaker#MountPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^\\/" - } - }, - "com.amazonaws.sagemaker#MultiModelConfig": { - "type": "structure", - "members": { - "ModelCacheSetting": { - "target": "com.amazonaws.sagemaker#ModelCacheSetting", - "traits": { - "smithy.api#documentation": "Whether to cache models for a multi-model endpoint. By default, multi-model endpoints\n cache models so that a model does not have to be loaded into memory each time it is\n invoked. Some use cases do not benefit from model caching. For example, if an endpoint\n hosts a large number of models that are each invoked infrequently, the endpoint might\n perform better if you disable model caching. To disable model caching, set the value of\n this parameter to Disabled.
Specifies additional configuration for hosting multi-model endpoints.
" - } - }, - "com.amazonaws.sagemaker#NameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" - } - }, - "com.amazonaws.sagemaker#NeoVpcConfig": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#NeoVpcSecurityGroupIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the\n security groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC that you want to connect the compilation job to for\n accessing the model in Amazon S3.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The VpcConfig configuration object that specifies the VPC that you want the\n compilation jobs to connect to. For more information on controlling access to your Amazon S3\n buckets used for compilation job, see Give Amazon SageMaker AI Compilation Jobs Access to\n Resources in Your Amazon VPC.
" - } - }, - "com.amazonaws.sagemaker#NeoVpcSecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.sagemaker#NeoVpcSecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#NeoVpcSecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#NeoVpcSubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.sagemaker#NeoVpcSubnets": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#NeoVpcSubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.sagemaker#NestedFilters": { - "type": "structure", - "members": { - "NestedPropertyName": { - "target": "com.amazonaws.sagemaker#ResourcePropertyName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the property to use in the nested filters. The value must match a listed property name,\n such as InputDataConfig.
A list of filters. Each filter acts on a property. Filters must contain at least one\n Filters value. For example, a NestedFilters call might\n include a filter on the PropertyName parameter of the\n InputDataConfig property:\n InputDataConfig.DataSource.S3DataSource.S3Uri.
A list of nested Filter objects. A resource must satisfy the conditions\n of all filters to be included in the results returned from the Search API.
\nFor example, to filter on a training job's InputDataConfig property with a\n specific channel name and S3Uri prefix, define the following filters:
\n '{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"Equals\", \"Value\":\"train\"}',\n
\n '{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"Contains\",\n \"Value\":\"mybucket/catdata\"}'\n
Whether to encrypt all communications between distributed processing jobs. Choose\n True to encrypt communications. Encryption provides greater security for distributed\n processing jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for\n the processing job.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig" - } - }, - "traits": { - "smithy.api#documentation": "Networking options for a job, such as network traffic encryption between containers,\n whether to allow inbound and outbound network calls to and from containers, and the VPC\n subnets and security groups to use for VPC-enabled jobs.
" - } - }, - "com.amazonaws.sagemaker#NetworkInterfaceId": { - "type": "string" - }, - "com.amazonaws.sagemaker#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 8192 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#NonEmptyString256": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^(?!\\s*$).+$" - } - }, - "com.amazonaws.sagemaker#NonEmptyString64": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^(?!\\s*$).+$" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceAcceleratorType": { - "type": "enum", - "members": { - "ML_EIA1_MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia1.medium" - } - }, - "ML_EIA1_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia1.large" - } - }, - "ML_EIA1_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia1.xlarge" - } - }, - "ML_EIA2_MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia2.medium" - } - }, - "ML_EIA2_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia2.large" - } - }, - "ML_EIA2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia2.xlarge" - } - } - } - }, - "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorType" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigContent": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16384 - }, - "smithy.api#pattern": "^[\\S\\s]+$" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleHook" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortKey": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "LAST_MODIFIED_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastModifiedTime" - } - } - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummary": { - "type": "structure", - "members": { - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the lifecycle configuration.
", - "smithy.api#required": {} - } - }, - "NotebookInstanceLifecycleConfigArn": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle configuration.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A timestamp that tells when the lifecycle configuration was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A timestamp that tells when the lifecycle configuration was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides a summary of a notebook instance lifecycle configuration.
" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummary" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceLifecycleHook": { - "type": "structure", - "members": { - "Content": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigContent", - "traits": { - "smithy.api#documentation": "A base64-encoded string that contains a shell script for a notebook instance lifecycle\n configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the notebook instance lifecycle configuration script.
\nEach lifecycle configuration script has a limit of 16384 characters.
\nThe value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log\n group /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceNameContains": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceSortKey": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - } - } - }, - "com.amazonaws.sagemaker#NotebookInstanceSortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.sagemaker#NotebookInstanceStatus": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "InService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "Stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "Stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "Updating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - } - } - }, - "com.amazonaws.sagemaker#NotebookInstanceSummary": { - "type": "structure", - "members": { - "NotebookInstanceName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the notebook instance that you want a summary for.
", - "smithy.api#required": {} - } - }, - "NotebookInstanceArn": { - "target": "com.amazonaws.sagemaker#NotebookInstanceArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the notebook instance.
", - "smithy.api#required": {} - } - }, - "NotebookInstanceStatus": { - "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", - "traits": { - "smithy.api#documentation": "The status of the notebook instance.
" - } - }, - "Url": { - "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", - "traits": { - "smithy.api#documentation": "The URL that you use to connect to the Jupyter notebook running in your notebook\n instance.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#InstanceType", - "traits": { - "smithy.api#documentation": "The type of ML compute instance that the notebook instance is running on.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the notebook instance was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the notebook instance was last modified.
" - } - }, - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#documentation": "The name of a notebook instance lifecycle configuration associated with this notebook\n instance.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" - } - }, - "DefaultCodeRepository": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", - "traits": { - "smithy.api#documentation": "The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" - } - }, - "AdditionalCodeRepositories": { - "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", - "traits": { - "smithy.api#documentation": "An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides summary information for an SageMaker AI notebook instance.
" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#NotebookInstanceSummary" - } - }, - "com.amazonaws.sagemaker#NotebookInstanceUrl": { - "type": "string" - }, - "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 5, - "max": 16384 - } - } - }, - "com.amazonaws.sagemaker#NotebookOutputOption": { - "type": "enum", - "members": { - "Allowed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Allowed" - } - }, - "Disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - } - } - }, - "com.amazonaws.sagemaker#NotificationConfiguration": { - "type": "structure", - "members": { - "NotificationTopicArn": { - "target": "com.amazonaws.sagemaker#NotificationTopicArn", - "traits": { - "smithy.api#documentation": "The ARN for the Amazon SNS topic to which notifications should be published.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configures Amazon SNS notifications of available or expiring work items for work\n teams.
" - } - }, - "com.amazonaws.sagemaker#NotificationTopicArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*$" - } - }, - "com.amazonaws.sagemaker#NumberOfAcceleratorDevices": { - "type": "float", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#NumberOfCpuCores": { - "type": "float", - "traits": { - "smithy.api#range": { - "min": 0.25 - } - } - }, - "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 9 - } - } - }, - "com.amazonaws.sagemaker#NumberOfSteps": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#ObjectiveStatus": { - "type": "enum", - "members": { - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Succeeded" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.sagemaker#ObjectiveStatusCounter": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#ObjectiveStatusCounters": { - "type": "structure", - "members": { - "Succeeded": { - "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", - "traits": { - "smithy.api#documentation": "The number of training jobs whose final objective metric was evaluated by the\n hyperparameter tuning job and used in the hyperparameter tuning process.
" - } - }, - "Pending": { - "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", - "traits": { - "smithy.api#documentation": "The number of training jobs that are in progress and pending evaluation of their final\n objective metric.
" - } - }, - "Failed": { - "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", - "traits": { - "smithy.api#documentation": "The number of training jobs whose final objective metric was not evaluated and used in\n the hyperparameter tuning process. This typically occurs when the training job failed or\n did not emit an objective metric.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the number of training jobs that this hyperparameter tuning job launched,\n categorized by the status of their objective metric. The objective metric status shows\n whether the\n final\n objective metric for the training job has been evaluated by the\n tuning job and used in the hyperparameter tuning process.
" - } - }, - "com.amazonaws.sagemaker#OfflineStoreConfig": { - "type": "structure", - "members": { - "S3StorageConfig": { - "target": "com.amazonaws.sagemaker#S3StorageConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Simple Storage (Amazon S3) location of OfflineStore.
Set to True to disable the automatic creation of an Amazon Web Services Glue\n table when configuring an OfflineStore. If set to False, Feature\n Store will name the OfflineStore Glue table following Athena's\n naming recommendations.
The default value is False.
The meta data of the Glue table that is autogenerated when an OfflineStore\n is created.
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of an OfflineStore.
Provide an OfflineStoreConfig in a request to\n CreateFeatureGroup to create an OfflineStore.
To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in\n S3StorageConfig.
An OfflineStore status.
The justification for why the OfflineStoreStatus is Blocked (if applicable).
" - } - } - }, - "traits": { - "smithy.api#documentation": "The status of OfflineStore.
The OIDC IdP client ID used to configure your private workforce.
", - "smithy.api#required": {} - } - }, - "ClientSecret": { - "target": "com.amazonaws.sagemaker#ClientSecret", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The OIDC IdP client secret used to configure your private workforce.
", - "smithy.api#required": {} - } - }, - "Issuer": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The OIDC IdP issuer used to configure your private workforce.
", - "smithy.api#required": {} - } - }, - "AuthorizationEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The OIDC IdP authorization endpoint used to configure your private workforce.
", - "smithy.api#required": {} - } - }, - "TokenEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The OIDC IdP token endpoint used to configure your private workforce.
", - "smithy.api#required": {} - } - }, - "UserInfoEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The OIDC IdP user information endpoint used to configure your private workforce.
", - "smithy.api#required": {} - } - }, - "LogoutEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The OIDC IdP logout endpoint used to configure your private workforce.
", - "smithy.api#required": {} - } - }, - "JwksUri": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.sagemaker#Scope", - "traits": { - "smithy.api#documentation": "An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
" - } - }, - "AuthenticationRequestExtraParams": { - "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParams", - "traits": { - "smithy.api#documentation": "A string to string map of identifiers specific to the custom identity provider (IdP) being used.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Use this parameter to configure your OIDC Identity Provider (IdP).
" - } - }, - "com.amazonaws.sagemaker#OidcConfigForResponse": { - "type": "structure", - "members": { - "ClientId": { - "target": "com.amazonaws.sagemaker#ClientId", - "traits": { - "smithy.api#documentation": "The OIDC IdP client ID used to configure your private workforce.
" - } - }, - "Issuer": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "The OIDC IdP issuer used to configure your private workforce.
" - } - }, - "AuthorizationEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "The OIDC IdP authorization endpoint used to configure your private workforce.
" - } - }, - "TokenEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "The OIDC IdP token endpoint used to configure your private workforce.
" - } - }, - "UserInfoEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "The OIDC IdP user information endpoint used to configure your private workforce.
" - } - }, - "LogoutEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "The OIDC IdP logout endpoint used to configure your private workforce.
" - } - }, - "JwksUri": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
" - } - }, - "Scope": { - "target": "com.amazonaws.sagemaker#Scope", - "traits": { - "smithy.api#documentation": "An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
" - } - }, - "AuthenticationRequestExtraParams": { - "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParams", - "traits": { - "smithy.api#documentation": "A string to string map of identifiers specific to the custom identity provider (IdP) being used.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Your OIDC IdP workforce configuration.
" - } - }, - "com.amazonaws.sagemaker#OidcEndpoint": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - }, - "smithy.api#pattern": "^https://\\S+$" - } - }, - "com.amazonaws.sagemaker#OidcMemberDefinition": { - "type": "structure", - "members": { - "Groups": { - "target": "com.amazonaws.sagemaker#Groups", - "traits": { - "smithy.api#documentation": "A list of comma seperated strings that identifies\n user groups in your OIDC IdP. Each user group is\n made up of a group of private workers.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A list of user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.
Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your\n OnlineStore.
Turn OnlineStore off by specifying False for the\n EnableOnlineStore flag. Turn OnlineStore on by specifying\n True for the EnableOnlineStore flag.
The default value is False.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Option for different tiers of low latency storage for real-time data retrieval.
\n\n Standard: A managed low latency data store for feature groups.
\n InMemory: A managed data store for feature groups that supports very\n low latency retrieval.
Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or\n KMSKeyId, for at rest data encryption. You can turn\n OnlineStore on or off by specifying the EnableOnlineStore flag\n at General Assembly.
The default value is False.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Updates the feature group online store configuration.
" - } - }, - "com.amazonaws.sagemaker#OnlineStoreSecurityConfig": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store\n uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side\n encryption.
\nThe caller (either user or IAM role) of CreateFeatureGroup must have below\n permissions to the OnlineStore\n KmsKeyId:
\n \"kms:Encrypt\"\n
\n \"kms:Decrypt\"\n
\n \"kms:DescribeKey\"\n
\n \"kms:CreateGrant\"\n
\n \"kms:RetireGrant\"\n
\n \"kms:ReEncryptFrom\"\n
\n \"kms:ReEncryptTo\"\n
\n \"kms:GenerateDataKey\"\n
\n \"kms:ListAliases\"\n
\n \"kms:ListGrants\"\n
\n \"kms:RevokeGrant\"\n
The caller (either user or IAM role) to all DataPlane operations\n (PutRecord, GetRecord, DeleteRecord) must have the\n following permissions to the KmsKeyId:
\n \"kms:Decrypt\"\n
The security configuration for OnlineStore.
Settings for the model quantization technique that's applied by a model optimization job.
" - } - }, - "ModelCompilationConfig": { - "target": "com.amazonaws.sagemaker#ModelCompilationConfig", - "traits": { - "smithy.api#documentation": "Settings for the model compilation technique that's applied by a model optimization job.
" - } - }, - "ModelShardingConfig": { - "target": "com.amazonaws.sagemaker#ModelShardingConfig", - "traits": { - "smithy.api#documentation": "Settings for the model sharding technique that's applied by a model optimization job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for an optimization technique that you apply with a model optimization\n job.
" - } - }, - "com.amazonaws.sagemaker#OptimizationConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#OptimizationConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#OptimizationContainerImage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.sagemaker#OptimizationJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:optimization-job/" - } - }, - "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType": { - "type": "enum", - "members": { - "ML_P4D_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4d.24xlarge" - } - }, - "ML_P4DE_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4de.24xlarge" - } - }, - "ML_P5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p5.48xlarge" - } - }, - "ML_G5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.xlarge" - } - }, - "ML_G5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.2xlarge" - } - }, - "ML_G5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.4xlarge" - } - }, - "ML_G5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.8xlarge" - } - }, - "ML_G5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.12xlarge" - } - }, - "ML_G5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.16xlarge" - } - }, - "ML_G5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.24xlarge" - } - }, - "ML_G5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.48xlarge" - } - }, - "ML_G6_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.xlarge" - } - }, - "ML_G6_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.2xlarge" - } - }, - "ML_G6_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.4xlarge" - } - }, - "ML_G6_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.8xlarge" - } - }, - "ML_G6_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.12xlarge" - } - }, - "ML_G6_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.16xlarge" - } - }, - "ML_G6_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.24xlarge" - } - }, - "ML_G6_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.48xlarge" - } - }, - "ML_INF2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.xlarge" - } - }, - "ML_INF2_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.8xlarge" - } - }, - "ML_INF2_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.24xlarge" - } - }, - "ML_INF2_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.48xlarge" - } - }, - "ML_TRN1_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.2xlarge" - } - }, - "ML_TRN1_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.32xlarge" - } - }, - "ML_TRN1N_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1n.32xlarge" - } - } - } - }, - "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#NonEmptyString256" - }, - "value": { - "target": "com.amazonaws.sagemaker#String256" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.sagemaker#OptimizationJobModelSource": { - "type": "structure", - "members": { - "S3": { - "target": "com.amazonaws.sagemaker#OptimizationJobModelSourceS3", - "traits": { - "smithy.api#documentation": "The Amazon S3 location of a source model to optimize with an optimization job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The location of the source model to optimize with an optimization job.
" - } - }, - "com.amazonaws.sagemaker#OptimizationJobModelSourceS3": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "An Amazon S3 URI that locates a source model to optimize with an optimization job.
" - } - }, - "ModelAccessConfig": { - "target": "com.amazonaws.sagemaker#OptimizationModelAccessConfig", - "traits": { - "smithy.api#documentation": "The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon S3 location of a source model to optimize with an optimization job.
" - } - }, - "com.amazonaws.sagemaker#OptimizationJobOutputConfig": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the\n optimized model when SageMaker uploads the model to Amazon S3.
" - } - }, - "S3OutputLocation": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 URI for where to store the optimized model that you create with an optimization\n job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Details for where to store the optimized model that you create with the optimization job.
" - } - }, - "com.amazonaws.sagemaker#OptimizationJobStatus": { - "type": "enum", - "members": { - "INPROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INPROGRESS" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.sagemaker#OptimizationJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#OptimizationJobSummary" - } - }, - "com.amazonaws.sagemaker#OptimizationJobSummary": { - "type": "structure", - "members": { - "OptimizationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name that you assigned to the optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationJobArn": { - "target": "com.amazonaws.sagemaker#OptimizationJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the optimization job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time when you created the optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationJobStatus": { - "target": "com.amazonaws.sagemaker#OptimizationJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the optimization job started.
" - } - }, - "OptimizationEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the optimization job finished processing.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "The time when the optimization job was last updated.
" - } - }, - "DeploymentInstanceType": { - "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of instance that hosts the optimized model that you create with the optimization job.
", - "smithy.api#required": {} - } - }, - "OptimizationTypes": { - "target": "com.amazonaws.sagemaker#OptimizationTypes", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The optimization techniques that are applied by the optimization job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Summarizes an optimization job by providing some of its key properties.
" - } - }, - "com.amazonaws.sagemaker#OptimizationModelAcceptEula": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#OptimizationModelAccessConfig": { - "type": "structure", - "members": { - "AcceptEula": { - "target": "com.amazonaws.sagemaker#OptimizationModelAcceptEula", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies agreement to the model end-user license agreement (EULA). The\n AcceptEula value must be explicitly defined as True in order\n to accept the EULA that this model requires. You are responsible for reviewing and\n complying with any applicable license terms and making sure they are acceptable for your\n use case before downloading or using a model.
The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
" - } - }, - "com.amazonaws.sagemaker#OptimizationOutput": { - "type": "structure", - "members": { - "RecommendedInferenceImage": { - "target": "com.amazonaws.sagemaker#OptimizationContainerImage", - "traits": { - "smithy.api#documentation": "The image that SageMaker recommends that you use to host the optimized model that you created\n with an optimization job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Output values produced by an optimization job.
" - } - }, - "com.amazonaws.sagemaker#OptimizationType": { - "type": "string" - }, - "com.amazonaws.sagemaker#OptimizationTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#OptimizationType" - } - }, - "com.amazonaws.sagemaker#OptimizationVpcConfig": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your optimized\n model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization\n job. You can control access to and from your resources by configuring a VPC. For more\n information, see Give SageMaker Access to Resources in your Amazon VPC.
" - } - }, - "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#OptimizationVpcSubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.sagemaker#OptimizationVpcSubnets": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#OptimizationVpcSubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.sagemaker#OptionalDouble": { - "type": "double" - }, - "com.amazonaws.sagemaker#OptionalInteger": { - "type": "integer" - }, - "com.amazonaws.sagemaker#OptionalVolumeSizeInGB": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#OrderKey": { - "type": "enum", - "members": { - "Ascending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "Descending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.sagemaker#OutputCompressionType": { - "type": "enum", - "members": { - "GZIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GZIP" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.sagemaker#OutputConfig": { - "type": "structure", - "members": { - "S3OutputLocation": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the S3 bucket where you want Amazon SageMaker AI to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.
Identifies the target device or the machine learning instance that you want to run\n your model on after the compilation has completed. Alternatively, you can specify OS,\n architecture, and accelerator using TargetPlatform\n fields. It can be used instead of TargetPlatform.
Currently ml_trn1 is available only in US East (N. Virginia) Region,\n and ml_inf2 is available only in US East (Ohio) Region.
Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.
The following examples show how to configure the TargetPlatform and\n CompilerOptions JSON strings for popular target platforms:
Raspberry Pi 3 Model B+
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},\n
\n \"CompilerOptions\": {'mattr': ['+neon']}\n
Jetson TX2
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"NVIDIA\"},\n
\n \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1',\n 'cuda-ver': '10.0'}\n
EC2 m5.2xlarge instance OS
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\":\n \"NVIDIA\"},\n
\n \"CompilerOptions\": {'mcpu': 'skylake-avx512'}\n
RK3399
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"MALI\"}\n
ARMv7 phone (CPU)
\n\n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},\n
\n \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr':\n ['+neon']}\n
ARMv8 phone (CPU)
\n\n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},\n
\n \"CompilerOptions\": {'ANDROID_PLATFORM': 29}\n
Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA accelerators\n and highly recommended for CPU compilations. For any other cases, it is optional to\n specify CompilerOptions.\n
\n DTYPE: Specifies the data type for the input. When compiling for\n ml_* (except for ml_inf) instances using PyTorch\n framework, provide the data type (dtype) of the model's input.\n \"float32\" is used if \"DTYPE\" is not specified.\n Options for data type are:
float32: Use either \"float\" or\n \"float32\".
int64: Use either \"int64\" or \"long\".
For example, {\"dtype\" : \"float32\"}.
\n CPU: Compilation for CPU supports the following compiler\n options.
\n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n
\n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n
\n ARM: Details of ARM CPU compilations.
\n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.
For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.
\n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.
\n gpu_code: Specifies the targeted architecture.
\n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.
\n cuda-ver: Specifies the CUDA version in x.y\n format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n
\n ANDROID: Compilation for the Android OS supports the following\n compiler options:
\n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.
\n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.
\n INFERENTIA: Compilation for target ml_inf1 uses compiler options\n passed in as a JSON string. For example, \"CompilerOptions\": \"\\\"--verbose 1\n --num-neuroncores 2 -O2\\\"\".
For information about supported compiler options, see Neuron Compiler CLI Reference Guide.
\n\n CoreML: Compilation for the CoreML OutputConfig\n TargetDevice supports the following compiler options:
\n class_labels: Specifies the classification labels file\n name inside input tar.gz file. For example, {\"class_labels\":\n \"imagenet_labels_1000.txt\"}. Labels inside the txt file\n should be separated by newlines.
The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker AI\n uses to encrypt your output models with Amazon S3 server-side encryption after compilation\n job. If you don't provide a KMS key ID, Amazon SageMaker AI uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer\n Guide.\n
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
Contains information about the output location for the compiled model and the target\n device that the model runs on. TargetDevice and TargetPlatform\n are mutually exclusive, so you need to choose one between the two to specify your target\n device or platform. If you cannot find your device you want to use from the\n TargetDevice list, use TargetPlatform to describe the\n platform of your edge device and CompilerOptions if there are specific\n settings that are required or recommended to use for particular TargetPlatform.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account.\n \n For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide. If the output\n data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3\n managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services\n Key Management Service Developer Guide.
Identifies the S3 path where you want SageMaker to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.
The model output compression type. Select None to output an uncompressed\n model, recommended for large model outputs. Defaults to gzip.
Provides information about how to store model training results (model\n artifacts).
" - } - }, - "com.amazonaws.sagemaker#OutputParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the output parameter.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The value of the output parameter.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "An output parameter of a pipeline step.
" - } - }, - "com.amazonaws.sagemaker#OutputParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#OutputParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#OwnershipSettings": { - "type": "structure", - "members": { - "OwnerUserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The user profile who is the owner of the space.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The collection of ownership settings for a space.
" - } - }, - "com.amazonaws.sagemaker#OwnershipSettingsSummary": { - "type": "structure", - "members": { - "OwnerUserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "The user profile who is the owner of the space.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies summary information about the ownership settings.
" - } - }, - "com.amazonaws.sagemaker#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 8192 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ParallelismConfiguration": { - "type": "structure", - "members": { - "MaxParallelExecutionSteps": { - "target": "com.amazonaws.sagemaker#MaxParallelExecutionSteps", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The max number of steps that can be executed in parallel.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration that controls the parallelism of the pipeline. \n By default, the parallelism configuration specified applies to all \n executions of the pipeline unless overridden.
" - } - }, - "com.amazonaws.sagemaker#Parameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#PipelineParameterName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the parameter to assign a value to. This \n parameter name must match a named parameter in the \n pipeline definition.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The literal value for the parameter.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Assigns a value to a named Pipeline parameter.
" - } - }, - "com.amazonaws.sagemaker#ParameterKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Parameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.sagemaker#ParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" - } - }, - "com.amazonaws.sagemaker#ParameterRange": { - "type": "structure", - "members": { - "IntegerParameterRangeSpecification": { - "target": "com.amazonaws.sagemaker#IntegerParameterRangeSpecification", - "traits": { - "smithy.api#documentation": "A IntegerParameterRangeSpecification object that defines the possible\n values for an integer hyperparameter.
A ContinuousParameterRangeSpecification object that defines the possible\n values for a continuous hyperparameter.
A CategoricalParameterRangeSpecification object that defines the possible\n values for a categorical hyperparameter.
Defines the possible values for categorical, continuous, and integer hyperparameters\n to be used by an algorithm.
" - } - }, - "com.amazonaws.sagemaker#ParameterRanges": { - "type": "structure", - "members": { - "IntegerParameterRanges": { - "target": "com.amazonaws.sagemaker#IntegerParameterRanges", - "traits": { - "smithy.api#documentation": "The array of IntegerParameterRange objects that specify ranges of integer\n hyperparameters that a hyperparameter tuning job searches.
" - } - }, - "ContinuousParameterRanges": { - "target": "com.amazonaws.sagemaker#ContinuousParameterRanges", - "traits": { - "smithy.api#documentation": "The array of ContinuousParameterRange objects that specify ranges of continuous\n hyperparameters that a hyperparameter tuning job searches.
" - } - }, - "CategoricalParameterRanges": { - "target": "com.amazonaws.sagemaker#CategoricalParameterRanges", - "traits": { - "smithy.api#documentation": "The array of CategoricalParameterRange objects that specify ranges of categorical\n hyperparameters that a hyperparameter tuning job searches.
" - } - }, - "AutoParameters": { - "target": "com.amazonaws.sagemaker#AutoParameters", - "traits": { - "smithy.api#documentation": "A list containing hyperparameter names and example values to be used by Autotune to\n determine optimal ranges for your tuning job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.
\nThe maximum number of items specified for Array Members refers to the\n maximum number of hyperparameters for each range and also the maximum for the\n hyperparameter tuning job itself. That is, the sum of the number of hyperparameters\n for all the ranges can't exceed the maximum number specified.
The name of the trial.
" - } - }, - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The trial that a trial component is associated with and the experiment the trial is part\n of. A component might not be associated with a trial. A component can be associated with\n multiple trials.
" - } - }, - "com.amazonaws.sagemaker#ParentHyperParameterTuningJob": { - "type": "structure", - "members": { - "HyperParameterTuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", - "traits": { - "smithy.api#documentation": "The name of the hyperparameter tuning job to be used as a starting point for a new\n hyperparameter tuning job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A previously completed or stopped hyperparameter tuning job to be used as a starting\n point for a new hyperparameter tuning job.
" - } - }, - "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJob" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#Parents": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Parent" - } - }, - "com.amazonaws.sagemaker#PartnerAppAdminUserList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#NonEmptyString256" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#PartnerAppArguments": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#NonEmptyString256" - }, - "value": { - "target": "com.amazonaws.sagemaker#String1024" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#PartnerAppArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:partner-app\\/app-[A-Z0-9]{12}$" - } - }, - "com.amazonaws.sagemaker#PartnerAppAuthType": { - "type": "enum", - "members": { - "IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM" - } - } - } - }, - "com.amazonaws.sagemaker#PartnerAppConfig": { - "type": "structure", - "members": { - "AdminUsers": { - "target": "com.amazonaws.sagemaker#PartnerAppAdminUserList", - "traits": { - "smithy.api#documentation": "The list of users that are given admin access to the SageMaker Partner AI App.
" - } - }, - "Arguments": { - "target": "com.amazonaws.sagemaker#PartnerAppArguments", - "traits": { - "smithy.api#documentation": "This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" - } - }, - "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig": { - "type": "structure", - "members": { - "MaintenanceWindowStart": { - "target": "com.amazonaws.sagemaker#WeeklyScheduleTimeFormat", - "traits": { - "smithy.api#documentation": "The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.
Maintenance configuration settings for the SageMaker Partner AI App.
" - } - }, - "com.amazonaws.sagemaker#PartnerAppName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.sagemaker#PartnerAppStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Available" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateFailed" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleted" - } - } - } - }, - "com.amazonaws.sagemaker#PartnerAppSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#PartnerAppSummary" - } - }, - "com.amazonaws.sagemaker#PartnerAppSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#PartnerAppArn", - "traits": { - "smithy.api#documentation": "The ARN of the SageMaker Partner AI App.
" - } - }, - "Name": { - "target": "com.amazonaws.sagemaker#PartnerAppName", - "traits": { - "smithy.api#documentation": "The name of the SageMaker Partner AI App.
" - } - }, - "Type": { - "target": "com.amazonaws.sagemaker#PartnerAppType", - "traits": { - "smithy.api#documentation": "The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The status of the SageMaker Partner AI App.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the SageMaker Partner AI App.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A subset of information related to a SageMaker Partner AI App. This information is used as part of the ListPartnerApps API response.
The name of the endpoint configuration used in the deployment.
", - "smithy.api#required": {} - } - }, - "ProductionVariants": { - "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", - "traits": { - "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint for the in-progress deployment.
" - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The start time of the deployment.
" - } - }, - "ShadowProductionVariants": { - "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", - "traits": { - "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint in shadow mode with production traffic replicated from the model specified\n on ProductionVariants for the in-progress deployment.
The summary of an in-progress deployment when an endpoint is creating or updating with\n a new endpoint configuration.
" - } - }, - "com.amazonaws.sagemaker#PendingProductionVariantSummary": { - "type": "structure", - "members": { - "VariantName": { - "target": "com.amazonaws.sagemaker#VariantName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the variant.
", - "smithy.api#required": {} - } - }, - "DeployedImages": { - "target": "com.amazonaws.sagemaker#DeployedImages", - "traits": { - "smithy.api#documentation": "An array of DeployedImage objects that specify the Amazon EC2 Container\n Registry paths of the inference images deployed on instances of this\n ProductionVariant.
The weight associated with the variant.
" - } - }, - "DesiredWeight": { - "target": "com.amazonaws.sagemaker#VariantWeight", - "traits": { - "smithy.api#documentation": "The requested weight for the variant in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
" - } - }, - "CurrentInstanceCount": { - "target": "com.amazonaws.sagemaker#TaskCount", - "traits": { - "smithy.api#documentation": "The number of instances associated with the variant.
" - } - }, - "DesiredInstanceCount": { - "target": "com.amazonaws.sagemaker#TaskCount", - "traits": { - "smithy.api#documentation": "The number of instances requested in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", - "traits": { - "smithy.api#documentation": "The type of instances associated with the variant.
" - } - }, - "AcceleratorType": { - "target": "com.amazonaws.sagemaker#ProductionVariantAcceleratorType", - "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify the size of the EI instance to use for the\n production variant.
" - } - }, - "VariantStatus": { - "target": "com.amazonaws.sagemaker#ProductionVariantStatusList", - "traits": { - "smithy.api#documentation": "The endpoint variant status which describes the current deployment stage status or\n operational status.
" - } - }, - "CurrentServerlessConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", - "traits": { - "smithy.api#documentation": "The serverless configuration for the endpoint.
" - } - }, - "DesiredServerlessConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", - "traits": { - "smithy.api#documentation": "The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.
" - } - }, - "ManagedInstanceScaling": { - "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", - "traits": { - "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" - } - }, - "RoutingConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", - "traits": { - "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The production variant summary for a deployment when an endpoint is creating or\n updating with the CreateEndpoint\n or UpdateEndpoint\n operations. Describes the VariantStatus , weight and capacity for a\n production variant associated with an endpoint.
Specifies how many concurrent users to start with. The value should be between 1 and 3.
" - } - }, - "SpawnRate": { - "target": "com.amazonaws.sagemaker#SpawnRate", - "traits": { - "smithy.api#documentation": "Specified how many new users to spawn in a minute.
" - } - }, - "DurationInSeconds": { - "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", - "traits": { - "smithy.api#documentation": "Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600.\n This value should not exceed JobDurationInSeconds.
Defines the traffic pattern.
" - } - }, - "com.amazonaws.sagemaker#Phases": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Phase" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#Pipeline": { - "type": "structure", - "members": { - "PipelineArn": { - "target": "com.amazonaws.sagemaker#PipelineArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" - } - }, - "PipelineName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#documentation": "The name of the pipeline.
" - } - }, - "PipelineDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline.
" - } - }, - "PipelineDescription": { - "target": "com.amazonaws.sagemaker#PipelineDescription", - "traits": { - "smithy.api#documentation": "The description of the pipeline.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that created the pipeline.
" - } - }, - "PipelineStatus": { - "target": "com.amazonaws.sagemaker#PipelineStatus", - "traits": { - "smithy.api#documentation": "The status of the pipeline.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the pipeline.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the pipeline was last modified.
" - } - }, - "LastRunTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the pipeline was last run.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "ParallelismConfiguration": { - "target": "com.amazonaws.sagemaker#ParallelismConfiguration", - "traits": { - "smithy.api#documentation": "The parallelism configuration applied to the pipeline.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags that apply to the pipeline.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A SageMaker Model Building Pipeline instance.
" - } - }, - "com.amazonaws.sagemaker#PipelineArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/" - } - }, - "com.amazonaws.sagemaker#PipelineDefinition": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1048576 - }, - "smithy.api#pattern": "(?:[ \\r\\n\\t].*)*$" - } - }, - "com.amazonaws.sagemaker#PipelineDefinitionS3Location": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.sagemaker#BucketName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the S3 bucket.
", - "smithy.api#required": {} - } - }, - "ObjectKey": { - "target": "com.amazonaws.sagemaker#Key", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The object key (or key name) uniquely identifies the \n object in an S3 bucket.
", - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.sagemaker#VersionId", - "traits": { - "smithy.api#documentation": "Version Id of the pipeline definition file. If not specified, Amazon SageMaker \n will retrieve the latest version.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3.
" - } - }, - "com.amazonaws.sagemaker#PipelineDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3072 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#PipelineExecution": { - "type": "structure", - "members": { - "PipelineArn": { - "target": "com.amazonaws.sagemaker#PipelineArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline that was executed.
" - } - }, - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" - } - }, - "PipelineExecutionDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineExecutionName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline execution.
" - } - }, - "PipelineExecutionStatus": { - "target": "com.amazonaws.sagemaker#PipelineExecutionStatus", - "traits": { - "smithy.api#documentation": "The status of the pipeline status.
" - } - }, - "PipelineExecutionDescription": { - "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", - "traits": { - "smithy.api#documentation": "The description of the pipeline execution.
" - } - }, - "PipelineExperimentConfig": { - "target": "com.amazonaws.sagemaker#PipelineExperimentConfig" - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#PipelineExecutionFailureReason", - "traits": { - "smithy.api#documentation": "If the execution failed, a message describing why.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the pipeline execution.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the pipeline execution was last modified.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "ParallelismConfiguration": { - "target": "com.amazonaws.sagemaker#ParallelismConfiguration", - "traits": { - "smithy.api#documentation": "The parallelism configuration applied to the pipeline execution.
" - } - }, - "SelectiveExecutionConfig": { - "target": "com.amazonaws.sagemaker#SelectiveExecutionConfig", - "traits": { - "smithy.api#documentation": "The selective execution configuration applied to the pipeline run.
" - } - }, - "PipelineParameters": { - "target": "com.amazonaws.sagemaker#ParameterList", - "traits": { - "smithy.api#documentation": "Contains a list of pipeline parameters. This list can be empty.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An execution of a pipeline.
" - } - }, - "com.amazonaws.sagemaker#PipelineExecutionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$" - } - }, - "com.amazonaws.sagemaker#PipelineExecutionDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3072 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#PipelineExecutionFailureReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1300 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#PipelineExecutionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 82 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}$" - } - }, - "com.amazonaws.sagemaker#PipelineExecutionStatus": { - "type": "enum", - "members": { - "EXECUTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Executing" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Succeeded" - } - } - } - }, - "com.amazonaws.sagemaker#PipelineExecutionStep": { - "type": "structure", - "members": { - "StepName": { - "target": "com.amazonaws.sagemaker#StepName", - "traits": { - "smithy.api#documentation": "The name of the step that is executed.
" - } - }, - "StepDisplayName": { - "target": "com.amazonaws.sagemaker#StepDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the step.
" - } - }, - "StepDescription": { - "target": "com.amazonaws.sagemaker#StepDescription", - "traits": { - "smithy.api#documentation": "The description of the step.
" - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the step started executing.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the step stopped executing.
" - } - }, - "StepStatus": { - "target": "com.amazonaws.sagemaker#StepStatus", - "traits": { - "smithy.api#documentation": "The status of the step execution.
" - } - }, - "CacheHitResult": { - "target": "com.amazonaws.sagemaker#CacheHitResult", - "traits": { - "smithy.api#documentation": "If this pipeline execution step was cached, details on the cache hit.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "The reason why the step failed execution. This is only returned if the step failed its execution.
" - } - }, - "Metadata": { - "target": "com.amazonaws.sagemaker#PipelineExecutionStepMetadata", - "traits": { - "smithy.api#documentation": "Metadata to run the pipeline step.
" - } - }, - "AttemptCount": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
" - } - }, - "SelectiveExecutionResult": { - "target": "com.amazonaws.sagemaker#SelectiveExecutionResult", - "traits": { - "smithy.api#documentation": "The ARN from an execution of the current pipeline from which\n results are reused for this step.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An execution of a step in a pipeline.
" - } - }, - "com.amazonaws.sagemaker#PipelineExecutionStepList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#PipelineExecutionStep" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#PipelineExecutionStepMetadata": { - "type": "structure", - "members": { - "TrainingJob": { - "target": "com.amazonaws.sagemaker#TrainingJobStepMetadata", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job that was run by this step execution.
" - } - }, - "ProcessingJob": { - "target": "com.amazonaws.sagemaker#ProcessingJobStepMetadata", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
" - } - }, - "TransformJob": { - "target": "com.amazonaws.sagemaker#TransformJobStepMetadata", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
" - } - }, - "TuningJob": { - "target": "com.amazonaws.sagemaker#TuningJobStepMetaData", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
" - } - }, - "Model": { - "target": "com.amazonaws.sagemaker#ModelStepMetadata", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model that was created by this step execution.
" - } - }, - "RegisterModel": { - "target": "com.amazonaws.sagemaker#RegisterModelStepMetadata", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
" - } - }, - "Condition": { - "target": "com.amazonaws.sagemaker#ConditionStepMetadata", - "traits": { - "smithy.api#documentation": "The outcome of the condition evaluation that was run by this step execution.
" - } - }, - "Callback": { - "target": "com.amazonaws.sagemaker#CallbackStepMetadata", - "traits": { - "smithy.api#documentation": "The URL of the Amazon SQS queue used by this step execution, the pipeline generated token,\n and a list of output parameters.
" - } - }, - "Lambda": { - "target": "com.amazonaws.sagemaker#LambdaStepMetadata", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of\n output parameters.
" - } - }, - "EMR": { - "target": "com.amazonaws.sagemaker#EMRStepMetadata", - "traits": { - "smithy.api#documentation": "The configurations and outcomes of an Amazon EMR step execution.
" - } - }, - "QualityCheck": { - "target": "com.amazonaws.sagemaker#QualityCheckStepMetadata", - "traits": { - "smithy.api#documentation": "The configurations and outcomes of the check step execution. This includes:
\nThe type of the check conducted.
\nThe Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
\nThe Amazon S3 URIs of newly calculated baseline constraints and statistics.
\nThe model package group name provided.
\nThe Amazon S3 URI of the violation report if violations detected.
\nThe Amazon Resource Name (ARN) of check processing job initiated by the step execution.
\nThe Boolean flags indicating if the drift check is skipped.
\nIf step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.
Container for the metadata for a Clarify check step. The configurations \n and outcomes of the check step execution. This includes:
\nThe type of the check conducted,
\nThe Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
\nThe Amazon S3 URIs of newly calculated baseline constraints and statistics.
\nThe model package group name provided.
\nThe Amazon S3 URI of the violation report if violations detected.
\nThe Amazon Resource Name (ARN) of check processing job initiated by the step execution.
\nThe boolean flags indicating if the drift check is skipped.
\nIf step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.
The configurations and outcomes of a Fail step execution.
" - } - }, - "AutoMLJob": { - "target": "com.amazonaws.sagemaker#AutoMLJobStepMetadata", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
" - } - }, - "Endpoint": { - "target": "com.amazonaws.sagemaker#EndpointStepMetadata", - "traits": { - "smithy.api#documentation": "The endpoint that was invoked during this step execution.
" - } - }, - "EndpointConfig": { - "target": "com.amazonaws.sagemaker#EndpointConfigStepMetadata", - "traits": { - "smithy.api#documentation": "The endpoint configuration used to create an endpoint during this step execution.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for a step execution.
" - } - }, - "com.amazonaws.sagemaker#PipelineExecutionSummary": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The start time of the pipeline execution.
" - } - }, - "PipelineExecutionStatus": { - "target": "com.amazonaws.sagemaker#PipelineExecutionStatus", - "traits": { - "smithy.api#documentation": "The status of the pipeline execution.
" - } - }, - "PipelineExecutionDescription": { - "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", - "traits": { - "smithy.api#documentation": "The description of the pipeline execution.
" - } - }, - "PipelineExecutionDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineExecutionName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline execution.
" - } - }, - "PipelineExecutionFailureReason": { - "target": "com.amazonaws.sagemaker#String3072", - "traits": { - "smithy.api#documentation": "A message generated by SageMaker Pipelines describing why the pipeline execution failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A pipeline execution summary.
" - } - }, - "com.amazonaws.sagemaker#PipelineExecutionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#PipelineExecutionSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#PipelineExperimentConfig": { - "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment.
" - } - }, - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the names of the experiment and trial created by a pipeline.
" - } - }, - "com.amazonaws.sagemaker#PipelineName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$" - } - }, - "com.amazonaws.sagemaker#PipelineNameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})$" - } - }, - "com.amazonaws.sagemaker#PipelineParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9\\-_]*$" - } - }, - "com.amazonaws.sagemaker#PipelineStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.sagemaker#PipelineSummary": { - "type": "structure", - "members": { - "PipelineArn": { - "target": "com.amazonaws.sagemaker#PipelineArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" - } - }, - "PipelineName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#documentation": "The name of the pipeline.
" - } - }, - "PipelineDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline.
" - } - }, - "PipelineDescription": { - "target": "com.amazonaws.sagemaker#PipelineDescription", - "traits": { - "smithy.api#documentation": "The description of the pipeline.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that the pipeline used to execute.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the pipeline.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the pipeline was last modified.
" - } - }, - "LastExecutionTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that a pipeline execution began.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of a pipeline.
" - } - }, - "com.amazonaws.sagemaker#PipelineSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#PipelineSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#PlatformIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 15 - }, - "smithy.api#pattern": "^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3)$" - } - }, - "com.amazonaws.sagemaker#PolicyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20480 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#PredefinedMetricSpecification": { - "type": "structure", - "members": { - "PredefinedMetricType": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The metric type. You can only apply SageMaker metric types to SageMaker endpoints.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A specification for a predefined metric.
" - } - }, - "com.amazonaws.sagemaker#PreemptTeamTasks": { - "type": "enum", - "members": { - "NEVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Never" - } - }, - "LOWERPRIORITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LowerPriority" - } - } - } - }, - "com.amazonaws.sagemaker#PresignedDomainUrl": { - "type": "string" - }, - "com.amazonaws.sagemaker#PriorityClass": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerPriorityClassName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Name of the priority class.
", - "smithy.api#required": {} - } - }, - "Weight": { - "target": "com.amazonaws.sagemaker#PriorityWeight", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Weight of the priority class. The value is within a range from 0 to 100, where 0 is the\n default.
\nA weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Priority class configuration. When included in PriorityClasses, these class\n configurations define how tasks are queued.
The number of ML compute instances to use in the processing job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProcessingInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ML compute instance type for the processing job.
", - "smithy.api#required": {} - } - }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.
\nCertain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts\n the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.
For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.
\nThe Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the\n storage volume attached to the ML compute instance(s) that run the processing job.\n
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nConfiguration for the cluster used to run a processing job.
" - } - }, - "com.amazonaws.sagemaker#ProcessingEnvironmentKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" - } - }, - "com.amazonaws.sagemaker#ProcessingEnvironmentMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#ProcessingEnvironmentValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[\\S\\s]*$" - } - }, - "com.amazonaws.sagemaker#ProcessingFeatureStoreOutput": { - "type": "structure", - "members": { - "FeatureGroupName": { - "target": "com.amazonaws.sagemaker#FeatureGroupName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your \n processing script is responsible for putting records into your Feature Store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration for processing job outputs in Amazon SageMaker Feature Store.
" - } - }, - "com.amazonaws.sagemaker#ProcessingInput": { - "type": "structure", - "members": { - "InputName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name for the processing job input.
", - "smithy.api#required": {} - } - }, - "AppManaged": { - "target": "com.amazonaws.sagemaker#AppManaged", - "traits": { - "smithy.api#documentation": "When True, input operations such as data download are managed natively by the\n processing job application. When False (default), input operations are managed by Amazon SageMaker.
Configuration for downloading input data from Amazon S3 into the processing container.
" - } - }, - "DatasetDefinition": { - "target": "com.amazonaws.sagemaker#DatasetDefinition", - "traits": { - "smithy.api#documentation": "Configuration for a Dataset Definition input.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The inputs for a processing job. The processing input must specify exactly one of either\n S3Input or DatasetDefinition types.
List of input configurations for the processing job.
" - } - }, - "ProcessingOutputConfig": { - "target": "com.amazonaws.sagemaker#ProcessingOutputConfig" - }, - "ProcessingJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#documentation": "The name of the processing job.
" - } - }, - "ProcessingResources": { - "target": "com.amazonaws.sagemaker#ProcessingResources" - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition" - }, - "AppSpecification": { - "target": "com.amazonaws.sagemaker#AppSpecification" - }, - "Environment": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", - "traits": { - "smithy.api#documentation": "Sets the environment variables in the Docker container.
" - } - }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#NetworkConfig" - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The ARN of the role used to create the processing job.
" - } - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - }, - "ProcessingJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#documentation": "The ARN of the processing job.
" - } - }, - "ProcessingJobStatus": { - "target": "com.amazonaws.sagemaker#ProcessingJobStatus", - "traits": { - "smithy.api#documentation": "The status of the processing job.
" - } - }, - "ExitMessage": { - "target": "com.amazonaws.sagemaker#ExitMessage", - "traits": { - "smithy.api#documentation": "A string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.
" - } - }, - "ProcessingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the processing job ended.
" - } - }, - "ProcessingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the processing job started.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time the processing job was last modified.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time the processing job was created.
" - } - }, - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#documentation": "The ARN of a monitoring schedule for an endpoint associated with this processing\n job.
" - } - }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
" - } - }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", - "traits": { - "smithy.api#documentation": "The ARN of the training job associated with this processing job.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information,\n see Process\n Data and Evaluate Models.
" - } - }, - "com.amazonaws.sagemaker#ProcessingJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/" - } - }, - "com.amazonaws.sagemaker#ProcessingJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#ProcessingJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#ProcessingJobStepMetadata": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for a processing job step.
" - } - }, - "com.amazonaws.sagemaker#ProcessingJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ProcessingJobSummary" - } - }, - "com.amazonaws.sagemaker#ProcessingJobSummary": { - "type": "structure", - "members": { - "ProcessingJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the processing job.
", - "smithy.api#required": {} - } - }, - "ProcessingJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job..
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time at which the processing job was created.
", - "smithy.api#required": {} - } - }, - "ProcessingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the processing job completed.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that indicates the last time the processing job was modified.
" - } - }, - "ProcessingJobStatus": { - "target": "com.amazonaws.sagemaker#ProcessingJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the processing job.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.
" - } - }, - "ExitMessage": { - "target": "com.amazonaws.sagemaker#ExitMessage", - "traits": { - "smithy.api#documentation": "An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summary of information about a processing job.
" - } - }, - "com.amazonaws.sagemaker#ProcessingLocalPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ProcessingMaxRuntimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 777600 - } - } - }, - "com.amazonaws.sagemaker#ProcessingOutput": { - "type": "structure", - "members": { - "OutputName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name for the processing job output.
", - "smithy.api#required": {} - } - }, - "S3Output": { - "target": "com.amazonaws.sagemaker#ProcessingS3Output", - "traits": { - "smithy.api#documentation": "Configuration for processing job outputs in Amazon S3.
" - } - }, - "FeatureStoreOutput": { - "target": "com.amazonaws.sagemaker#ProcessingFeatureStoreOutput", - "traits": { - "smithy.api#documentation": "Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output\n type is only supported when AppManaged is specified.
When True, output operations such as data upload are managed natively by the\n processing job application. When False (default), output operations are managed by\n Amazon SageMaker.
Describes the results of a processing job. The processing output must specify exactly one of\n either S3Output or FeatureStoreOutput types.
An array of outputs configuring the data to upload from the processing container.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing\n job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of\n a KMS key, or alias of a KMS key. The KmsKeyId is applied to all\n outputs.
Configuration for uploading output from the processing container.
" - } - }, - "com.amazonaws.sagemaker#ProcessingOutputs": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ProcessingOutput" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#ProcessingResources": { - "type": "structure", - "members": { - "ClusterConfig": { - "target": "com.amazonaws.sagemaker#ProcessingClusterConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration for the resources in a cluster used to run the processing\n job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.
" - } - }, - "com.amazonaws.sagemaker#ProcessingS3CompressionType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - }, - "GZIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gzip" - } - } - } - }, - "com.amazonaws.sagemaker#ProcessingS3DataDistributionType": { - "type": "enum", - "members": { - "FULLYREPLICATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FullyReplicated" - } - }, - "SHARDEDBYS3KEY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ShardedByS3Key" - } - } - } - }, - "com.amazonaws.sagemaker#ProcessingS3DataType": { - "type": "enum", - "members": { - "MANIFEST_FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManifestFile" - } - }, - "S3_PREFIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3Prefix" - } - } - } - }, - "com.amazonaws.sagemaker#ProcessingS3Input": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
", - "smithy.api#required": {} - } - }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#ProcessingLocalPath", - "traits": { - "smithy.api#documentation": "The local path in your container where you want Amazon SageMaker to write input data to. \n LocalPath is an absolute path to the input data and must begin with \n /opt/ml/processing/. LocalPath is a required \n parameter when AppManaged is False (default).
Whether you use an S3Prefix or a ManifestFile for\n the data type. If you choose S3Prefix, S3Uri identifies a key\n name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing\n job. If you choose ManifestFile, S3Uri identifies an object\n that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for\n the processing job.
Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data \n from the input source onto the local ML storage volume before starting your processing \n container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker \n streams input data from the source directly to your processing container into named \n pipes without using the ML storage volume.
Whether to distribute the data from Amazon S3 to all processing instances with \n FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, \n downloading one shard of data to each processing instance.
Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing \n container. Gzip can only be used when Pipe mode is \n specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input \n data from the source directly to your container without using the EBS volume.
Configuration for downloading input data from Amazon S3 into the processing container.
" - } - }, - "com.amazonaws.sagemaker#ProcessingS3InputMode": { - "type": "enum", - "members": { - "PIPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pipe" - } - }, - "FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "File" - } - } - } - }, - "com.amazonaws.sagemaker#ProcessingS3Output": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of\n a processing job.
", - "smithy.api#required": {} - } - }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#ProcessingLocalPath", - "traits": { - "smithy.api#documentation": "The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. \n LocalPath is an absolute path to a directory containing output files. \n This directory will be created by the platform and exist when your container's \n entrypoint is invoked.
Whether to upload the results of the processing job continuously or after the job\n completes.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration for uploading output data to Amazon S3 from the processing container.
" - } - }, - "com.amazonaws.sagemaker#ProcessingS3UploadMode": { - "type": "enum", - "members": { - "CONTINUOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Continuous" - } - }, - "END_OF_JOB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EndOfJob" - } - } - } - }, - "com.amazonaws.sagemaker#ProcessingStoppingCondition": { - "type": "structure", - "members": { - "MaxRuntimeInSeconds": { - "target": "com.amazonaws.sagemaker#ProcessingMaxRuntimeInSeconds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the maximum runtime in seconds.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configures conditions under which the processing job should be stopped, such as how long \n the processing job has been running. After the condition is met, the processing job is stopped.
" - } - }, - "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 16384 - } - } - }, - "com.amazonaws.sagemaker#Processor": { - "type": "enum", - "members": { - "CPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPU" - } - }, - "GPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GPU" - } - } - } - }, - "com.amazonaws.sagemaker#ProductId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" - } - }, - "com.amazonaws.sagemaker#ProductListings": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#String" - } - }, - "com.amazonaws.sagemaker#ProductionVariant": { - "type": "structure", - "members": { - "VariantName": { - "target": "com.amazonaws.sagemaker#VariantName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the production variant.
", - "smithy.api#required": {} - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "The name of the model that you want to host. This is the name that you specified\n when creating the model.
" - } - }, - "InitialInstanceCount": { - "target": "com.amazonaws.sagemaker#InitialTaskCount", - "traits": { - "smithy.api#documentation": "Number of instances to launch initially.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", - "traits": { - "smithy.api#documentation": "The ML compute instance type.
" - } - }, - "InitialVariantWeight": { - "target": "com.amazonaws.sagemaker#VariantWeight", - "traits": { - "smithy.api#documentation": "Determines initial traffic distribution among all of the models that you specify in\n the endpoint configuration. The traffic to a production variant is determined by the\n ratio of the VariantWeight to the sum of all VariantWeight\n values across all ProductionVariants. If unspecified, it defaults to 1.0.\n
This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify the size of the EI instance to use for the\n production variant.
" - } - }, - "CoreDumpConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantCoreDumpConfig", - "traits": { - "smithy.api#documentation": "Specifies configuration for a core dump from the model container when the process\n crashes.
" - } - }, - "ServerlessConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", - "traits": { - "smithy.api#documentation": "The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
" - } - }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#ProductionVariantVolumeSizeInGB", - "traits": { - "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to individual inference instance\n associated with the production variant. Currently only Amazon EBS gp2 storage volumes are\n supported.
" - } - }, - "ModelDataDownloadTimeoutInSeconds": { - "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this production\n variant.
" - } - }, - "ContainerStartupHealthCheckTimeoutInSeconds": { - "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "The timeout value, in seconds, for your inference container to pass health check by\n SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
" - } - }, - "EnableSSMAccess": { - "target": "com.amazonaws.sagemaker#ProductionVariantSSMAccess", - "traits": { - "smithy.api#documentation": " You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM)\n access for a production variant behind an endpoint. By default, SSM access is disabled\n for all production variants behind an endpoint. You can turn on or turn off SSM access\n for a production variant behind an existing endpoint by creating a new endpoint\n configuration and calling UpdateEndpoint.
Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" - } - }, - "RoutingConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", - "traits": { - "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" - } - }, - "InferenceAmiVersion": { - "target": "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion", - "traits": { - "smithy.api#documentation": "Specifies an option from a collection of preconfigured Amazon Machine Image (AMI)\n images. Each image is configured by Amazon Web Services with a set of software and driver\n versions. Amazon Web Services optimizes these configurations for different machine\n learning workloads.
\nBy selecting an AMI version, you can ensure that your inference environment is\n compatible with specific software requirements, such as CUDA driver versions, Linux\n kernel versions, or Amazon Web Services Neuron driver versions.
\nThe AMI version names, and their configurations, are the following:
\nAccelerator: GPU
\nNVIDIA driver version: 535.54.03
\nCUDA driver version: 12.2
\nSupported instance types: ml.g4dn.*, ml.g5.*, ml.g6.*, ml.p3.*,\n ml.p4d.*, ml.p4de.*, ml.p5.*
\nIdentifies a model that you want to host and the resources chosen to deploy for\n hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic\n among the models by specifying variant weights. For more information on production\n variants, check Production variants.\n
" - } - }, - "com.amazonaws.sagemaker#ProductionVariantAcceleratorType": { - "type": "enum", - "members": { - "ML_EIA1_MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia1.medium" - } - }, - "ML_EIA1_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia1.large" - } - }, - "ML_EIA1_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia1.xlarge" - } - }, - "ML_EIA2_MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia2.medium" - } - }, - "ML_EIA2_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia2.large" - } - }, - "ML_EIA2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.eia2.xlarge" - } - } - } - }, - "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 3600 - } - } - }, - "com.amazonaws.sagemaker#ProductionVariantCoreDumpConfig": { - "type": "structure", - "members": { - "DestinationS3Uri": { - "target": "com.amazonaws.sagemaker#DestinationS3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 bucket to send the core dump to.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management\n Service Developer Guide.
Specifies configuration for a core dump from the model container when the process\n crashes.
" - } - }, - "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion": { - "type": "enum", - "members": { - "AL2_GPU_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "al2-ami-sagemaker-inference-gpu-2" - } - } - } - }, - "com.amazonaws.sagemaker#ProductionVariantInstanceType": { - "type": "enum", - "members": { - "ML_T2_MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t2.medium" - } - }, - "ML_T2_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t2.large" - } - }, - "ML_T2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t2.xlarge" - } - }, - "ML_T2_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.t2.2xlarge" - } - }, - "ML_M4_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.xlarge" - } - }, - "ML_M4_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.2xlarge" - } - }, - "ML_M4_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.4xlarge" - } - }, - "ML_M4_10XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.10xlarge" - } - }, - "ML_M4_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.16xlarge" - } - }, - "ML_M5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.large" - } - }, - "ML_M5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.xlarge" - } - }, - "ML_M5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.2xlarge" - } - }, - "ML_M5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.4xlarge" - } - }, - "ML_M5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.12xlarge" - } - }, - "ML_M5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.24xlarge" - } - }, - "ML_M5D_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.large" - } - }, - "ML_M5D_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.xlarge" - } - }, - "ML_M5D_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.2xlarge" - } - }, - "ML_M5D_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.4xlarge" - } - }, - "ML_M5D_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.12xlarge" - } - }, - "ML_M5D_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5d.24xlarge" - } - }, - "ML_C4_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.large" - } - }, - "ML_C4_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.xlarge" - } - }, - "ML_C4_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.2xlarge" - } - }, - "ML_C4_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.4xlarge" - } - }, - "ML_C4_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.8xlarge" - } - }, - "ML_P2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p2.xlarge" - } - }, - "ML_P2_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p2.8xlarge" - } - }, - "ML_P2_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p2.16xlarge" - } - }, - "ML_P3_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.2xlarge" - } - }, - "ML_P3_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.8xlarge" - } - }, - "ML_P3_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.16xlarge" - } - }, - "ML_C5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.large" - } - }, - "ML_C5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.xlarge" - } - }, - "ML_C5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.2xlarge" - } - }, - "ML_C5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.4xlarge" - } - }, - "ML_C5_9XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.9xlarge" - } - }, - "ML_C5_18XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.18xlarge" - } - }, - "ML_C5D_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.large" - } - }, - "ML_C5D_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.xlarge" - } - }, - "ML_C5D_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.2xlarge" - } - }, - "ML_C5D_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.4xlarge" - } - }, - "ML_C5D_9XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.9xlarge" - } - }, - "ML_C5D_18XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5d.18xlarge" - } - }, - "ML_G4DN_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.xlarge" - } - }, - "ML_G4DN_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.2xlarge" - } - }, - "ML_G4DN_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.4xlarge" - } - }, - "ML_G4DN_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.8xlarge" - } - }, - "ML_G4DN_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.12xlarge" - } - }, - "ML_G4DN_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.16xlarge" - } - }, - "ML_R5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.large" - } - }, - "ML_R5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.xlarge" - } - }, - "ML_R5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.2xlarge" - } - }, - "ML_R5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.4xlarge" - } - }, - "ML_R5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.12xlarge" - } - }, - "ML_R5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5.24xlarge" - } - }, - "ML_R5D_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5d.large" - } - }, - "ML_R5D_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5d.xlarge" - } - }, - "ML_R5D_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5d.2xlarge" - } - }, - "ML_R5D_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5d.4xlarge" - } - }, - "ML_R5D_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5d.12xlarge" - } - }, - "ML_R5D_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r5d.24xlarge" - } - }, - "ML_INF1_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf1.xlarge" - } - }, - "ML_INF1_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf1.2xlarge" - } - }, - "ML_INF1_6XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf1.6xlarge" - } - }, - "ML_INF1_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf1.24xlarge" - } - }, - "ML_DL1_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.dl1.24xlarge" - } - }, - "ML_C6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.large" - } - }, - "ML_C6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.xlarge" - } - }, - "ML_C6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.2xlarge" - } - }, - "ML_C6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.4xlarge" - } - }, - "ML_C6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.8xlarge" - } - }, - "ML_C6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.12xlarge" - } - }, - "ML_C6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.16xlarge" - } - }, - "ML_C6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.24xlarge" - } - }, - "ML_C6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.32xlarge" - } - }, - "ML_M6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.large" - } - }, - "ML_M6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.xlarge" - } - }, - "ML_M6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.2xlarge" - } - }, - "ML_M6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.4xlarge" - } - }, - "ML_M6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.8xlarge" - } - }, - "ML_M6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.12xlarge" - } - }, - "ML_M6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.16xlarge" - } - }, - "ML_M6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.24xlarge" - } - }, - "ML_M6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.32xlarge" - } - }, - "ML_R6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.large" - } - }, - "ML_R6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.xlarge" - } - }, - "ML_R6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.2xlarge" - } - }, - "ML_R6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.4xlarge" - } - }, - "ML_R6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.8xlarge" - } - }, - "ML_R6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.12xlarge" - } - }, - "ML_R6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.16xlarge" - } - }, - "ML_R6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.24xlarge" - } - }, - "ML_R6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.32xlarge" - } - }, - "ML_G5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.xlarge" - } - }, - "ML_G5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.2xlarge" - } - }, - "ML_G5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.4xlarge" - } - }, - "ML_G5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.8xlarge" - } - }, - "ML_G5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.12xlarge" - } - }, - "ML_G5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.16xlarge" - } - }, - "ML_G5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.24xlarge" - } - }, - "ML_G5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.48xlarge" - } - }, - "ML_G6_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.xlarge" - } - }, - "ML_G6_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.2xlarge" - } - }, - "ML_G6_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.4xlarge" - } - }, - "ML_G6_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.8xlarge" - } - }, - "ML_G6_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.12xlarge" - } - }, - "ML_G6_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.16xlarge" - } - }, - "ML_G6_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.24xlarge" - } - }, - "ML_G6_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6.48xlarge" - } - }, - "ML_G6E_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.xlarge" - } - }, - "ML_G6E_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.2xlarge" - } - }, - "ML_G6E_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.4xlarge" - } - }, - "ML_G6E_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.8xlarge" - } - }, - "ML_G6E_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.12xlarge" - } - }, - "ML_G6E_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.16xlarge" - } - }, - "ML_G6E_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.24xlarge" - } - }, - "ML_G6E_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g6e.48xlarge" - } - }, - "ML_P4D_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4d.24xlarge" - } - }, - "ML_C7G_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7g.large" - } - }, - "ML_C7G_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7g.xlarge" - } - }, - "ML_C7G_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7g.2xlarge" - } - }, - "ML_C7G_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7g.4xlarge" - } - }, - "ML_C7G_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7g.8xlarge" - } - }, - "ML_C7G_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7g.12xlarge" - } - }, - "ML_C7G_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7g.16xlarge" - } - }, - "ML_M6G_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6g.large" - } - }, - "ML_M6G_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6g.xlarge" - } - }, - "ML_M6G_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6g.2xlarge" - } - }, - "ML_M6G_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6g.4xlarge" - } - }, - "ML_M6G_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6g.8xlarge" - } - }, - "ML_M6G_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6g.12xlarge" - } - }, - "ML_M6G_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6g.16xlarge" - } - }, - "ML_M6GD_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6gd.large" - } - }, - "ML_M6GD_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6gd.xlarge" - } - }, - "ML_M6GD_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6gd.2xlarge" - } - }, - "ML_M6GD_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6gd.4xlarge" - } - }, - "ML_M6GD_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6gd.8xlarge" - } - }, - "ML_M6GD_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6gd.12xlarge" - } - }, - "ML_M6GD_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6gd.16xlarge" - } - }, - "ML_C6G_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6g.large" - } - }, - "ML_C6G_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6g.xlarge" - } - }, - "ML_C6G_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6g.2xlarge" - } - }, - "ML_C6G_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6g.4xlarge" - } - }, - "ML_C6G_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6g.8xlarge" - } - }, - "ML_C6G_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6g.12xlarge" - } - }, - "ML_C6G_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6g.16xlarge" - } - }, - "ML_C6GD_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gd.large" - } - }, - "ML_C6GD_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gd.xlarge" - } - }, - "ML_C6GD_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gd.2xlarge" - } - }, - "ML_C6GD_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gd.4xlarge" - } - }, - "ML_C6GD_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gd.8xlarge" - } - }, - "ML_C6GD_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gd.12xlarge" - } - }, - "ML_C6GD_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gd.16xlarge" - } - }, - "ML_C6GN_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gn.large" - } - }, - "ML_C6GN_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gn.xlarge" - } - }, - "ML_C6GN_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gn.2xlarge" - } - }, - "ML_C6GN_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gn.4xlarge" - } - }, - "ML_C6GN_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gn.8xlarge" - } - }, - "ML_C6GN_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gn.12xlarge" - } - }, - "ML_C6GN_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6gn.16xlarge" - } - }, - "ML_R6G_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6g.large" - } - }, - "ML_R6G_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6g.xlarge" - } - }, - "ML_R6G_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6g.2xlarge" - } - }, - "ML_R6G_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6g.4xlarge" - } - }, - "ML_R6G_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6g.8xlarge" - } - }, - "ML_R6G_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6g.12xlarge" - } - }, - "ML_R6G_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6g.16xlarge" - } - }, - "ML_R6GD_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6gd.large" - } - }, - "ML_R6GD_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6gd.xlarge" - } - }, - "ML_R6GD_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6gd.2xlarge" - } - }, - "ML_R6GD_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6gd.4xlarge" - } - }, - "ML_R6GD_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6gd.8xlarge" - } - }, - "ML_R6GD_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6gd.12xlarge" - } - }, - "ML_R6GD_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6gd.16xlarge" - } - }, - "ML_P4DE_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p4de.24xlarge" - } - }, - "ML_TRN1_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.2xlarge" - } - }, - "ML_TRN1_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.32xlarge" - } - }, - "ML_TRN1N_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1n.32xlarge" - } - }, - "ML_TRN2_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn2.48xlarge" - } - }, - "ML_INF2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.xlarge" - } - }, - "ML_INF2_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.8xlarge" - } - }, - "ML_INF2_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.24xlarge" - } - }, - "ML_INF2_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.48xlarge" - } - }, - "ML_P5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p5.48xlarge" - } - }, - "ML_P5E_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p5e.48xlarge" - } - }, - "ML_M7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.large" - } - }, - "ML_M7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.xlarge" - } - }, - "ML_M7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.2xlarge" - } - }, - "ML_M7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.4xlarge" - } - }, - "ML_M7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.8xlarge" - } - }, - "ML_M7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.12xlarge" - } - }, - "ML_M7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.16xlarge" - } - }, - "ML_M7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.24xlarge" - } - }, - "ML_M7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.48xlarge" - } - }, - "ML_C7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.large" - } - }, - "ML_C7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.xlarge" - } - }, - "ML_C7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.2xlarge" - } - }, - "ML_C7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.4xlarge" - } - }, - "ML_C7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.8xlarge" - } - }, - "ML_C7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.12xlarge" - } - }, - "ML_C7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.16xlarge" - } - }, - "ML_C7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.24xlarge" - } - }, - "ML_C7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.48xlarge" - } - }, - "ML_R7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.large" - } - }, - "ML_R7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.xlarge" - } - }, - "ML_R7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.2xlarge" - } - }, - "ML_R7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.4xlarge" - } - }, - "ML_R7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.8xlarge" - } - }, - "ML_R7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.12xlarge" - } - }, - "ML_R7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.16xlarge" - } - }, - "ML_R7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.24xlarge" - } - }, - "ML_R7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.48xlarge" - } - } - } - }, - "com.amazonaws.sagemaker#ProductionVariantList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ProductionVariant" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#ManagedInstanceScalingStatus", - "traits": { - "smithy.api#documentation": "Indicates whether managed instance scaling is enabled.
" - } - }, - "MinInstanceCount": { - "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount", - "traits": { - "smithy.api#documentation": "The minimum number of instances that the endpoint must retain when it scales down to\n accommodate a decrease in traffic.
" - } - }, - "MaxInstanceCount": { - "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount", - "traits": { - "smithy.api#documentation": "The maximum number of instances that the endpoint can provision when it scales up to\n accommodate an increase in traffic.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" - } - }, - "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 3600 - } - } - }, - "com.amazonaws.sagemaker#ProductionVariantRoutingConfig": { - "type": "structure", - "members": { - "RoutingStrategy": { - "target": "com.amazonaws.sagemaker#RoutingStrategy", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Sets how the endpoint routes incoming traffic:
\n\n LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the\n specific instances that have more capacity to process them.
\n RANDOM: The endpoint routes each request to a randomly chosen\n instance.
Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" - } - }, - "com.amazonaws.sagemaker#ProductionVariantSSMAccess": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#ProductionVariantServerlessConfig": { - "type": "structure", - "members": { - "MemorySizeInMB": { - "target": "com.amazonaws.sagemaker#ServerlessMemorySizeInMB", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.
", - "smithy.api#required": {} - } - }, - "MaxConcurrency": { - "target": "com.amazonaws.sagemaker#ServerlessMaxConcurrency", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum number of concurrent invocations your serverless endpoint can process.
", - "smithy.api#required": {} - } - }, - "ProvisionedConcurrency": { - "target": "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency", - "traits": { - "smithy.api#documentation": "The amount of provisioned concurrency to allocate for the serverless endpoint.\n Should be less than or equal to MaxConcurrency.
This field is not supported for serverless endpoint recommendations for Inference Recommender jobs.\n For more information about creating an Inference Recommender job, see\n CreateInferenceRecommendationsJobs.
\nSpecifies the serverless configuration for an endpoint variant.
" - } - }, - "com.amazonaws.sagemaker#ProductionVariantServerlessUpdateConfig": { - "type": "structure", - "members": { - "MaxConcurrency": { - "target": "com.amazonaws.sagemaker#ServerlessMaxConcurrency", - "traits": { - "smithy.api#documentation": "The updated maximum number of concurrent invocations your serverless endpoint can process.
" - } - }, - "ProvisionedConcurrency": { - "target": "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency", - "traits": { - "smithy.api#documentation": "The updated amount of provisioned concurrency to allocate for the serverless endpoint.\n Should be less than or equal to MaxConcurrency.
Specifies the serverless update concurrency configuration for an endpoint variant.
" - } - }, - "com.amazonaws.sagemaker#ProductionVariantStatus": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#VariantStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The endpoint variant status which describes the current deployment stage status or\n operational status.
\n\n Creating: Creating inference resources for the production\n variant.
\n Deleting: Terminating inference resources for the production\n variant.
\n Updating: Updating capacity for the production variant.
\n ActivatingTraffic: Turning on traffic for the production\n variant.
\n Baking: Waiting period to monitor the CloudWatch alarms in the\n automatic rollback configuration.
A message that describes the status of the production variant.
" - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The start time of the current status change.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the status of the production variant.
" - } - }, - "com.amazonaws.sagemaker#ProductionVariantStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ProductionVariantStatus" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#ProductionVariantSummary": { - "type": "structure", - "members": { - "VariantName": { - "target": "com.amazonaws.sagemaker#VariantName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the variant.
", - "smithy.api#required": {} - } - }, - "DeployedImages": { - "target": "com.amazonaws.sagemaker#DeployedImages", - "traits": { - "smithy.api#documentation": "An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the\n inference images deployed on instances of this ProductionVariant.
The weight associated with the variant.
" - } - }, - "DesiredWeight": { - "target": "com.amazonaws.sagemaker#VariantWeight", - "traits": { - "smithy.api#documentation": "The requested weight, as specified in the\n UpdateEndpointWeightsAndCapacities request.
The number of instances associated with the variant.
" - } - }, - "DesiredInstanceCount": { - "target": "com.amazonaws.sagemaker#TaskCount", - "traits": { - "smithy.api#documentation": "The number of instances requested in the\n UpdateEndpointWeightsAndCapacities request.
The endpoint variant status which describes the current deployment stage status or\n operational status.
" - } - }, - "CurrentServerlessConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", - "traits": { - "smithy.api#documentation": "The serverless configuration for the endpoint.
" - } - }, - "DesiredServerlessConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", - "traits": { - "smithy.api#documentation": "The serverless configuration requested for the endpoint update.
" - } - }, - "ManagedInstanceScaling": { - "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", - "traits": { - "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" - } - }, - "RoutingConfig": { - "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", - "traits": { - "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes weight and capacities for a production variant associated with an\n endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities\n API and the endpoint status is Updating, you get different desired and\n current values.
Path to Amazon S3 storage location for system and framework metrics.
" - } - }, - "ProfilingIntervalInMilliseconds": { - "target": "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds", - "traits": { - "smithy.api#documentation": "A time interval for capturing system metrics in milliseconds. Available values are\n 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" - } - }, - "ProfilingParameters": { - "target": "com.amazonaws.sagemaker#ProfilingParameters", - "traits": { - "smithy.api#documentation": "Configuration information for capturing framework metrics. Available key strings for different profiling options are\n DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.\n The following codes are configuration structures for the ProfilingParameters parameter. To learn more about\n how to configure the ProfilingParameters parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n
Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and\n storage paths.
" - } - }, - "com.amazonaws.sagemaker#ProfilerConfigForUpdate": { - "type": "structure", - "members": { - "S3OutputPath": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "Path to Amazon S3 storage location for system and framework metrics.
" - } - }, - "ProfilingIntervalInMilliseconds": { - "target": "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds", - "traits": { - "smithy.api#documentation": "A time interval for capturing system metrics in milliseconds. Available values are\n 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" - } - }, - "ProfilingParameters": { - "target": "com.amazonaws.sagemaker#ProfilingParameters", - "traits": { - "smithy.api#documentation": "Configuration information for capturing framework metrics. Available key strings for different profiling options are\n DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.\n The following codes are configuration structures for the ProfilingParameters parameter. To learn more about\n how to configure the ProfilingParameters parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n
To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.
Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and\n storage paths.
" - } - }, - "com.amazonaws.sagemaker#ProfilerRuleConfiguration": { - "type": "structure", - "members": { - "RuleConfigurationName": { - "target": "com.amazonaws.sagemaker#RuleConfigurationName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the rule configuration. It must be unique relative to other rule configuration names.
", - "smithy.api#required": {} - } - }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#DirectoryPath", - "traits": { - "smithy.api#documentation": "Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Path to Amazon S3 storage location for rules.
" - } - }, - "RuleEvaluatorImage": { - "target": "com.amazonaws.sagemaker#AlgorithmImage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Elastic Container Registry Image for the managed rule evaluation.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProcessingInstanceType", - "traits": { - "smithy.api#documentation": "The instance type to deploy a custom rule for profiling a training job.
" - } - }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", - "traits": { - "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to the processing instance.
" - } - }, - "RuleParameters": { - "target": "com.amazonaws.sagemaker#RuleParameters", - "traits": { - "smithy.api#documentation": "Runtime configuration for rule container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration information for profiling rules.
" - } - }, - "com.amazonaws.sagemaker#ProfilerRuleConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ProfilerRuleConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatus": { - "type": "structure", - "members": { - "RuleConfigurationName": { - "target": "com.amazonaws.sagemaker#RuleConfigurationName", - "traits": { - "smithy.api#documentation": "The name of the rule configuration.
" - } - }, - "RuleEvaluationJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule evaluation job.
" - } - }, - "RuleEvaluationStatus": { - "target": "com.amazonaws.sagemaker#RuleEvaluationStatus", - "traits": { - "smithy.api#documentation": "Status of the rule evaluation.
" - } - }, - "StatusDetails": { - "target": "com.amazonaws.sagemaker#StatusDetails", - "traits": { - "smithy.api#documentation": "Details from the rule evaluation.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Timestamp when the rule evaluation status was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the status of the rule evaluation.
" - } - }, - "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatuses": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatus" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds": { - "type": "long" - }, - "com.amazonaws.sagemaker#ProfilingParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#ConfigKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#ConfigValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#ProfilingStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - } - } - }, - "com.amazonaws.sagemaker#ProgrammingLang": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" - } - }, - "com.amazonaws.sagemaker#Project": { - "type": "structure", - "members": { - "ProjectArn": { - "target": "com.amazonaws.sagemaker#ProjectArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
" - } - }, - "ProjectName": { - "target": "com.amazonaws.sagemaker#ProjectEntityName", - "traits": { - "smithy.api#documentation": "The name of the project.
" - } - }, - "ProjectId": { - "target": "com.amazonaws.sagemaker#ProjectId", - "traits": { - "smithy.api#documentation": "The ID of the project.
" - } - }, - "ProjectDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "The description of the project.
" - } - }, - "ServiceCatalogProvisioningDetails": { - "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails" - }, - "ServiceCatalogProvisionedProductDetails": { - "target": "com.amazonaws.sagemaker#ServiceCatalogProvisionedProductDetails" - }, - "ProjectStatus": { - "target": "com.amazonaws.sagemaker#ProjectStatus", - "traits": { - "smithy.api#documentation": "The status of the project.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who created the project.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp specifying when the project was created.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp container for when the project was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - } - }, - "traits": { - "smithy.api#documentation": "The properties of a project as returned by the Search API.
" - } - }, - "com.amazonaws.sagemaker#ProjectArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}$" - } - }, - "com.amazonaws.sagemaker#ProjectEntityName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$" - } - }, - "com.amazonaws.sagemaker#ProjectId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" - } - }, - "com.amazonaws.sagemaker#ProjectSortBy": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.sagemaker#ProjectSortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.sagemaker#ProjectStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "CREATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateInProgress" - } - }, - "CREATE_COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateCompleted" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateFailed" - } - }, - "DELETE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteInProgress" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteFailed" - } - }, - "DELETE_COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteCompleted" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateInProgress" - } - }, - "UPDATE_COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateCompleted" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateFailed" - } - } - } - }, - "com.amazonaws.sagemaker#ProjectSummary": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.sagemaker#ProjectEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the project.
", - "smithy.api#required": {} - } - }, - "ProjectDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "The description of the project.
" - } - }, - "ProjectArn": { - "target": "com.amazonaws.sagemaker#ProjectArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
", - "smithy.api#required": {} - } - }, - "ProjectId": { - "target": "com.amazonaws.sagemaker#ProjectId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the project.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time that the project was created.
", - "smithy.api#required": {} - } - }, - "ProjectStatus": { - "target": "com.amazonaws.sagemaker#ProjectStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the project.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Information about a project.
" - } - }, - "com.amazonaws.sagemaker#ProjectSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ProjectSummary" - } - }, - "com.amazonaws.sagemaker#PropertyNameHint": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#PropertyNameQuery": { - "type": "structure", - "members": { - "PropertyNameHint": { - "target": "com.amazonaws.sagemaker#PropertyNameHint", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Text that begins a property's name.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Part of the SuggestionQuery type. Specifies a hint for retrieving property\n names that begin with the specified text.
A suggested property name based on what you entered in the search textbox in the SageMaker\n console.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A property name returned from a GetSearchSuggestions call that specifies\n a value in the PropertyNameQuery field.
The key that identifies a provisioning parameter.
" - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#ProvisioningParameterValue", - "traits": { - "smithy.api#documentation": "The value of the provisioning parameter.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A key value pair used when you provision a project as a service catalog product. For\n information, see What is Amazon Web Services Service\n Catalog.
" - } - }, - "com.amazonaws.sagemaker#ProvisioningParameterKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ProvisioningParameterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4096 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ProvisioningParameters": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ProvisioningParameter" - } - }, - "com.amazonaws.sagemaker#PublicWorkforceTaskPrice": { - "type": "structure", - "members": { - "AmountInUsd": { - "target": "com.amazonaws.sagemaker#USD", - "traits": { - "smithy.api#documentation": "Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.
\nUse one of the following prices for bounding box tasks. Prices are in US dollars and\n should be based on the complexity of the task; the longer it takes in your initial\n testing, the more you should offer.
\n0.036
\n0.048
\n0.060
\n0.072
\n0.120
\n0.240
\n0.360
\n0.480
\n0.600
\n0.720
\n0.840
\n0.960
\n1.080
\n1.200
\nUse one of the following prices for image classification, text classification, and\n custom tasks. Prices are in US dollars.
\n0.012
\n0.024
\n0.036
\n0.048
\n0.060
\n0.072
\n0.120
\n0.240
\n0.360
\n0.480
\n0.600
\n0.720
\n0.840
\n0.960
\n1.080
\n1.200
\nUse one of the following prices for semantic segmentation tasks. Prices are in US\n dollars.
\n0.840
\n0.960
\n1.080
\n1.200
\nUse one of the following prices for Textract AnalyzeDocument Important Form Key Amazon\n Augmented AI review tasks. Prices are in US dollars.
\n2.400
\n2.280
\n2.160
\n2.040
\n1.920
\n1.800
\n1.680
\n1.560
\n1.440
\n1.320
\n1.200
\n1.080
\n0.960
\n0.840
\n0.720
\n0.600
\n0.480
\n0.360
\n0.240
\n0.120
\n0.072
\n0.060
\n0.048
\n0.036
\n0.024
\n0.012
\nUse one of the following prices for Rekognition DetectModerationLabels Amazon\n Augmented AI review tasks. Prices are in US dollars.
\n1.200
\n1.080
\n0.960
\n0.840
\n0.720
\n0.600
\n0.480
\n0.360
\n0.240
\n0.120
\n0.072
\n0.060
\n0.048
\n0.036
\n0.024
\n0.012
\nUse one of the following prices for Amazon Augmented AI custom human review tasks.\n Prices are in US dollars.
\n1.200
\n1.080
\n0.960
\n0.840
\n0.720
\n0.600
\n0.480
\n0.360
\n0.240
\n0.120
\n0.072
\n0.060
\n0.048
\n0.036
\n0.024
\n0.012
\nAdds a resouce policy to control access to a model group. For information about\n resoure policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
" - } - }, - "com.amazonaws.sagemaker#PutModelPackageGroupPolicyInput": { - "type": "structure", - "members": { - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model group to add a resource policy to.
", - "smithy.api#required": {} - } - }, - "ResourcePolicy": { - "target": "com.amazonaws.sagemaker#PolicyString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The resource policy for the model group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#PutModelPackageGroupPolicyOutput": { - "type": "structure", - "members": { - "ModelPackageGroupArn": { - "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#QProfileArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:[-.a-z0-9]{1,63}:codewhisperer:([-.a-z0-9]{0,63}:){2}([a-zA-Z0-9-_:/]){1,1023}$" - } - }, - "com.amazonaws.sagemaker#QualityCheckStepMetadata": { - "type": "structure", - "members": { - "CheckType": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The type of the Quality check step.
" - } - }, - "BaselineUsedForDriftCheckStatistics": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI of the baseline statistics file used for the drift check.
" - } - }, - "BaselineUsedForDriftCheckConstraints": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI of the baseline constraints file used for the drift check.
" - } - }, - "CalculatedBaselineStatistics": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI of the newly calculated baseline statistics file.
" - } - }, - "CalculatedBaselineConstraints": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI of the newly calculated baseline constraints file.
" - } - }, - "ModelPackageGroupName": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The model package group name.
" - } - }, - "ViolationReport": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI of violation report if violations are detected.
" - } - }, - "CheckJobArn": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
" - } - }, - "SkipCheck": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints and \n BaselineUsedForDriftCheckStatistics properties.
Container for the metadata for a Quality check step. For more information, see \n the topic on QualityCheck step in the Amazon SageMaker Developer Guide.\n
" - } - }, - "com.amazonaws.sagemaker#QueryFilters": { - "type": "structure", - "members": { - "Types": { - "target": "com.amazonaws.sagemaker#QueryTypes", - "traits": { - "smithy.api#documentation": "Filter the lineage entities connected to the StartArn by type. For example: DataSet, \n Model, Endpoint, or ModelDeployment.
Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.
Filter the lineage entities connected to the StartArn(s) by created date.
Filter the lineage entities connected to the StartArn(s) after the create date.
Filter the lineage entities connected to the StartArn(s) before the last modified date.
Filter the lineage entities connected to the StartArn(s) after the last modified date.
Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. \n If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.
A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the \n QueryLineage API action.
Use this action to inspect your lineage and discover relationships between entities. \n For more information, see \n Querying Lineage Entities in the Amazon SageMaker Developer Guide.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.sagemaker#QueryLineageMaxDepth": { - "type": "integer", - "traits": { - "smithy.api#range": { - "max": 10 - } - } - }, - "com.amazonaws.sagemaker#QueryLineageMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#QueryLineageRequest": { - "type": "structure", - "members": { - "StartArns": { - "target": "com.amazonaws.sagemaker#QueryLineageStartArns", - "traits": { - "smithy.api#documentation": "A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
" - } - }, - "Direction": { - "target": "com.amazonaws.sagemaker#Direction", - "traits": { - "smithy.api#documentation": "Associations between lineage entities have a direction. This parameter determines the direction from the \n StartArn(s) that the query traverses.
" - } - }, - "IncludeEdges": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": " Setting this value to True retrieves not only the entities of interest but also the \n Associations and \n lineage entities on the path. Set to False to only return lineage entities that match your query.
A set of filtering parameters that allow you to specify which entities should be returned.
\nProperties - Key-value pairs to match on the lineage entities' properties.
\nLineageTypes - A set of lineage entity types to match on. For example: TrialComponent, \n Artifact, or Context.
CreatedBefore - Filter entities created before this date.
\nModifiedBefore - Filter entities modified before this date.
\nModifiedAfter - Filter entities modified after this date.
\nThe maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number \n of Associations from the StartArn entity to the matched results.
Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.
Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.
A list of vertices connected to the start entity(ies) in the lineage graph.
" - } - }, - "Edges": { - "target": "com.amazonaws.sagemaker#Edges", - "traits": { - "smithy.api#documentation": "A list of edges that connect vertices in the response.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#String8192", - "traits": { - "smithy.api#documentation": "Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.
A list of custom SageMaker AI images that are configured to run as a RSession\n app.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of settings that apply to an RSessionGateway app.
Indicates whether the current user has access to the RStudioServerPro\n app.
The level of permissions that the user has within the RStudioServerPro app.\n This value defaults to `User`. The `Admin` value allows the user access to the RStudio\n Administrative Dashboard.
A collection of settings that configure user interaction with the\n RStudioServerPro app.
The ARN of the execution role for the RStudioServerPro Domain-level\n app.
A URL pointing to an RStudio Connect server.
" - } - }, - "RStudioPackageManagerUrl": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "A URL pointing to an RStudio Package Manager server.
" - } - }, - "DefaultResourceSpec": { - "target": "com.amazonaws.sagemaker#ResourceSpec" - } - }, - "traits": { - "smithy.api#documentation": "A collection of settings that configure the RStudioServerPro Domain-level\n app.
The execution role for the RStudioServerPro Domain-level app.
A URL pointing to an RStudio Connect server.
" - } - }, - "RStudioPackageManagerUrl": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "A URL pointing to an RStudio Package Manager server.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of settings that update the current configuration for the\n RStudioServerPro Domain-level app.
The instance type the model is deployed to.
", - "smithy.api#required": {} - } - }, - "InstanceCount": { - "target": "com.amazonaws.sagemaker#TaskCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of instances of the type specified by InstanceType.
The infrastructure configuration for deploying the model to a real-time inference endpoint.
" - } - }, - "com.amazonaws.sagemaker#RealTimeInferenceRecommendation": { - "type": "structure", - "members": { - "RecommendationId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The recommendation ID which uniquely identifies each recommendation.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The recommended instance type for Real-Time Inference.
", - "smithy.api#required": {} - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#EnvironmentMap", - "traits": { - "smithy.api#documentation": "The recommended environment variables to set in the model container for Real-Time Inference.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The recommended configuration to use for Real-Time Inference.
" - } - }, - "com.amazonaws.sagemaker#RealTimeInferenceRecommendations": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#RealTimeInferenceRecommendation" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType" - } - }, - "com.amazonaws.sagemaker#RecommendationFailureReason": { - "type": "string" - }, - "com.amazonaws.sagemaker#RecommendationJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/" - } - }, - "com.amazonaws.sagemaker#RecommendationJobCompilationJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#RecommendationJobCompiledOutputConfig": { - "type": "structure", - "members": { - "S3OutputUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "Identifies the Amazon S3 bucket where you want SageMaker to store the \n compiled model artifacts.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about the output configuration for the compiled \n model.
" - } - }, - "com.amazonaws.sagemaker#RecommendationJobContainerConfig": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The machine learning domain of the model and its components.
\nValid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING |\n MACHINE_LEARNING\n
The machine learning task that the model accomplishes.
\nValid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION\n | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION |\n REGRESSION | OTHER\n
The machine learning framework of the container image.
\nValid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN\n
The framework version of the container image.
" - } - }, - "PayloadConfig": { - "target": "com.amazonaws.sagemaker#RecommendationJobPayloadConfig", - "traits": { - "smithy.api#documentation": "Specifies the SamplePayloadUrl and all other sample payload-related fields.
The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.
\nValid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn |\n densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet\n
A list of the instance types that are used to generate inferences in real-time.
" - } - }, - "SupportedEndpointType": { - "target": "com.amazonaws.sagemaker#RecommendationJobSupportedEndpointType", - "traits": { - "smithy.api#documentation": "The endpoint type to receive recommendations for. By default this is null, and the results of \n the inference recommendation job return a combined list of both real-time and serverless benchmarks.\n By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
" - } - }, - "DataInputConfig": { - "target": "com.amazonaws.sagemaker#RecommendationJobDataInputConfig", - "traits": { - "smithy.api#documentation": "Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form.\n This field is used for optimizing your model using SageMaker Neo. For more information, see\n DataInputConfig.
" - } - }, - "SupportedResponseMIMETypes": { - "target": "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMETypes", - "traits": { - "smithy.api#documentation": "The supported MIME types for the output data.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies mandatory fields for running an Inference Recommender job directly in the\n CreateInferenceRecommendationsJob\n API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use\n ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.
The reason why a benchmark failed.
" - } - }, - "InvocationEndTime": { - "target": "com.amazonaws.sagemaker#InvocationEndTime", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the benchmark completed.
" - } - }, - "InvocationStartTime": { - "target": "com.amazonaws.sagemaker#InvocationStartTime", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the benchmark started.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details for a specific benchmark from an Inference Recommender job.
" - } - }, - "com.amazonaws.sagemaker#RecommendationJobInputConfig": { - "type": "structure", - "members": { - "ModelPackageVersionArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a versioned model package.
" - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "The name of the created model.
" - } - }, - "JobDurationInSeconds": { - "target": "com.amazonaws.sagemaker#JobDurationInSeconds", - "traits": { - "smithy.api#documentation": "Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.
" - } - }, - "TrafficPattern": { - "target": "com.amazonaws.sagemaker#TrafficPattern", - "traits": { - "smithy.api#documentation": "Specifies the traffic pattern of the job.
" - } - }, - "ResourceLimit": { - "target": "com.amazonaws.sagemaker#RecommendationJobResourceLimit", - "traits": { - "smithy.api#documentation": "Defines the resource limit of the job.
" - } - }, - "EndpointConfigurations": { - "target": "com.amazonaws.sagemaker#EndpointInputConfigurations", - "traits": { - "smithy.api#documentation": "Specifies the endpoint configuration to use for a job.
" - } - }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. \n This key will be passed to SageMaker Hosting for endpoint creation.
\nThe SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage \n volume of the endpoints created for inference recommendation. The inference recommendation job will fail \n asynchronously during endpoint configuration creation if the role passed does not have \n kms:CreateGrant permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:\n
For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
" - } - }, - "ContainerConfig": { - "target": "com.amazonaws.sagemaker#RecommendationJobContainerConfig", - "traits": { - "smithy.api#documentation": "Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig\n override the corresponding fields in the model package.
Existing customer endpoints on which to run an Inference Recommender job.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#RecommendationJobVpcConfig", - "traits": { - "smithy.api#documentation": "Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input configuration of the recommendation job.
" - } - }, - "com.amazonaws.sagemaker#RecommendationJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" - } - }, - "com.amazonaws.sagemaker#RecommendationJobOutputConfig": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. \n The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:\n
For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
" - } - }, - "CompiledOutputConfig": { - "target": "com.amazonaws.sagemaker#RecommendationJobCompiledOutputConfig", - "traits": { - "smithy.api#documentation": "Provides information about the output configuration for the compiled \n model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about the output configuration for the compiled model.
" - } - }, - "com.amazonaws.sagemaker#RecommendationJobPayloadConfig": { - "type": "structure", - "members": { - "SamplePayloadUrl": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
" - } - }, - "SupportedContentTypes": { - "target": "com.amazonaws.sagemaker#RecommendationJobSupportedContentTypes", - "traits": { - "smithy.api#documentation": "The supported MIME types for the input data.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for the payload for a recommendation job.
" - } - }, - "com.amazonaws.sagemaker#RecommendationJobResourceLimit": { - "type": "structure", - "members": { - "MaxNumberOfTests": { - "target": "com.amazonaws.sagemaker#MaxNumberOfTests", - "traits": { - "smithy.api#documentation": "Defines the maximum number of load tests.
" - } - }, - "MaxParallelOfTests": { - "target": "com.amazonaws.sagemaker#MaxParallelOfTests", - "traits": { - "smithy.api#documentation": "Defines the maximum number of parallel load tests.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the maximum number of jobs that can run in parallel \n and the maximum number of jobs that can run.
" - } - }, - "com.amazonaws.sagemaker#RecommendationJobStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.sagemaker#RecommendationJobStoppingConditions": { - "type": "structure", - "members": { - "MaxInvocations": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of requests per minute expected for the endpoint.
" - } - }, - "ModelLatencyThresholds": { - "target": "com.amazonaws.sagemaker#ModelLatencyThresholds", - "traits": { - "smithy.api#documentation": "The interval of time taken by a model to respond as viewed from SageMaker. \n The interval includes the local communication time taken to send the request \n and to fetch the response from the container of a model and the time taken to \n complete the inference in the container.
" - } - }, - "FlatInvocations": { - "target": "com.amazonaws.sagemaker#FlatInvocations", - "traits": { - "smithy.api#documentation": "Stops a load test when the number of invocations (TPS) peaks and flattens,\n which means that the instance has reached capacity. The default value is Stop.\n If you want the load test to continue after invocations have flattened, set the value to Continue.
Specifies conditions for stopping a job. When a job reaches a \n stopping condition limit, SageMaker ends the job.
" - } - }, - "com.amazonaws.sagemaker#RecommendationJobSupportedContentType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#RecommendationJobSupportedContentTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#RecommendationJobSupportedContentType" - } - }, - "com.amazonaws.sagemaker#RecommendationJobSupportedEndpointType": { - "type": "enum", - "members": { - "REALTIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RealTime" - } - }, - "SERVERLESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Serverless" - } - } - } - }, - "com.amazonaws.sagemaker#RecommendationJobSupportedInstanceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#String" - } - }, - "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMEType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[-\\w]+\\/.+$" - } - }, - "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMETypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMEType" - } - }, - "com.amazonaws.sagemaker#RecommendationJobType": { - "type": "enum", - "members": { - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Default" - } - }, - "ADVANCED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Advanced" - } - } - } - }, - "com.amazonaws.sagemaker#RecommendationJobVpcConfig": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The VPC security group IDs. IDs have the form of sg-xxxxxxxx.\n Specify the security groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
" - } - }, - "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#RecommendationJobVpcSubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.sagemaker#RecommendationJobVpcSubnets": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#RecommendationJobVpcSubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.sagemaker#RecommendationMetrics": { - "type": "structure", - "members": { - "CostPerHour": { - "target": "com.amazonaws.sagemaker#Float", - "traits": { - "smithy.api#documentation": "Defines the cost per hour for the instance.
" - } - }, - "CostPerInference": { - "target": "com.amazonaws.sagemaker#Float", - "traits": { - "smithy.api#documentation": "Defines the cost per inference for the instance .
" - } - }, - "MaxInvocations": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The expected maximum number of requests per minute for the instance.
" - } - }, - "ModelLatency": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The expected model latency at maximum invocation per minute for the instance.
" - } - }, - "CpuUtilization": { - "target": "com.amazonaws.sagemaker#UtilizationMetric", - "traits": { - "smithy.api#documentation": "The expected CPU utilization at maximum invocations per minute for the instance.
\n\n NaN indicates that the value is not available.
The expected memory utilization at maximum invocations per minute for the instance.
\n\n NaN indicates that the value is not available.
The time it takes to launch new compute resources for a serverless endpoint.\n The time can vary depending on the model size, how long it takes to download the\n model, and the start-up time of the container.
\n\n NaN indicates that the value is not available.
The metrics of recommendations.
" - } - }, - "com.amazonaws.sagemaker#RecommendationStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "NOT_APPLICABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_APPLICABLE" - } - } - } - }, - "com.amazonaws.sagemaker#RecommendationStepType": { - "type": "enum", - "members": { - "BENCHMARK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BENCHMARK" - } - } - } - }, - "com.amazonaws.sagemaker#RecordWrapper": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - }, - "RECORDIO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RecordIO" - } - } - } - }, - "com.amazonaws.sagemaker#RedshiftClusterId": { - "type": "string", - "traits": { - "smithy.api#documentation": "The Redshift cluster Identifier.
", - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#RedshiftDatabase": { - "type": "string", - "traits": { - "smithy.api#documentation": "The name of the Redshift database used in Redshift query execution.
", - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#RedshiftDatasetDefinition": { - "type": "structure", - "members": { - "ClusterId": { - "target": "com.amazonaws.sagemaker#RedshiftClusterId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.sagemaker#RedshiftDatabase", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "DbUser": { - "target": "com.amazonaws.sagemaker#RedshiftUserName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "QueryString": { - "target": "com.amazonaws.sagemaker#RedshiftQueryString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "ClusterRoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
", - "smithy.api#required": {} - } - }, - "OutputS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location in Amazon S3 where the Redshift query results are stored.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a\n Redshift execution.
" - } - }, - "OutputFormat": { - "target": "com.amazonaws.sagemaker#RedshiftResultFormat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "OutputCompression": { - "target": "com.amazonaws.sagemaker#RedshiftResultCompressionType" - } - }, - "traits": { - "smithy.api#documentation": "Configuration for Redshift Dataset Definition input.
" - } - }, - "com.amazonaws.sagemaker#RedshiftQueryString": { - "type": "string", - "traits": { - "smithy.api#documentation": "The SQL query statements to be executed.
", - "smithy.api#length": { - "min": 1, - "max": 4096 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.sagemaker#RedshiftResultCompressionType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - }, - "GZIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GZIP" - } - }, - "BZIP2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BZIP2" - } - }, - "ZSTD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ZSTD" - } - }, - "SNAPPY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNAPPY" - } - } - }, - "traits": { - "smithy.api#documentation": "The compression used for Redshift query results.
" - } - }, - "com.amazonaws.sagemaker#RedshiftResultFormat": { - "type": "enum", - "members": { - "PARQUET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARQUET" - } - }, - "CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CSV" - } - } - }, - "traits": { - "smithy.api#documentation": "The data storage format for Redshift query results.
" - } - }, - "com.amazonaws.sagemaker#RedshiftUserName": { - "type": "string", - "traits": { - "smithy.api#documentation": "The database user name used in Redshift query execution.
", - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#ReferenceMinVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 14 - }, - "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" - } - }, - "com.amazonaws.sagemaker#RegisterDevices": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#RegisterDevicesRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Register devices.
" - } - }, - "com.amazonaws.sagemaker#RegisterDevicesRequest": { - "type": "structure", - "members": { - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "Devices": { - "target": "com.amazonaws.sagemaker#Devices", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of devices to register with SageMaker Edge Manager.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "The tags associated with devices.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#RegisterModelStepMetadata": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for a register model job step.
" - } - }, - "com.amazonaws.sagemaker#ReleaseNotes": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#RemoteDebugConfig": { - "type": "structure", - "members": { - "EnableRemoteDebug": { - "target": "com.amazonaws.sagemaker#EnableRemoteDebug", - "traits": { - "smithy.api#documentation": "If set to True, enables remote debugging.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" - } - }, - "com.amazonaws.sagemaker#RemoteDebugConfigForUpdate": { - "type": "structure", - "members": { - "EnableRemoteDebug": { - "target": "com.amazonaws.sagemaker#EnableRemoteDebug", - "traits": { - "smithy.api#documentation": "If set to True, enables remote debugging.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" - } - }, - "com.amazonaws.sagemaker#RenderUiTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#RenderUiTemplateRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#RenderUiTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Renders the UI template so that you can preview the worker's experience.
" - } - }, - "com.amazonaws.sagemaker#RenderUiTemplateRequest": { - "type": "structure", - "members": { - "UiTemplate": { - "target": "com.amazonaws.sagemaker#UiTemplate", - "traits": { - "smithy.api#documentation": "A Template object containing the worker UI template to render.
A RenderableTask object containing a representative task to\n render.
The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the\n template.
", - "smithy.api#required": {} - } - }, - "HumanTaskUiArn": { - "target": "com.amazonaws.sagemaker#HumanTaskUiArn", - "traits": { - "smithy.api#documentation": "The HumanTaskUiArn of the worker UI that you want to render. Do not\n provide a HumanTaskUiArn if you use the UiTemplate\n parameter.
See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#RenderUiTemplateResponse": { - "type": "structure", - "members": { - "RenderedContent": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A Liquid template that renders the HTML for the worker UI.
", - "smithy.api#required": {} - } - }, - "Errors": { - "target": "com.amazonaws.sagemaker#RenderingErrorList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of one or more RenderingError objects if any were encountered\n while rendering the template. If there were no errors, the list is empty.
A JSON object that contains values for the variables defined in the template. It is\n made available to the template under the substitution variable task.input.\n For example, if you define a variable task.input.text in your template, you\n can supply the variable in the JSON object as \"text\": \"sample text\".
Contains input values for a task.
" - } - }, - "com.amazonaws.sagemaker#RenderingError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique identifier for a specific class of errors.
", - "smithy.api#required": {} - } - }, - "Message": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A human-readable message describing the error.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A description of an error that occurred while rendering the template.
" - } - }, - "com.amazonaws.sagemaker#RenderingErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#RenderingError" - } - }, - "com.amazonaws.sagemaker#RepositoryAccessMode": { - "type": "enum", - "members": { - "PLATFORM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Platform" - } - }, - "VPC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Vpc" - } - } - } - }, - "com.amazonaws.sagemaker#RepositoryAuthConfig": { - "type": "structure", - "members": { - "RepositoryCredentialsProviderArn": { - "target": "com.amazonaws.sagemaker#RepositoryCredentialsProviderArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides\n credentials to authenticate to the private Docker registry where your model image is\n hosted. For information about how to create an Amazon Web Services Lambda function, see\n Create a Lambda function\n with the console in the Amazon Web Services Lambda Developer\n Guide.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies an authentication configuration for the private docker registry where your\n model image is hosted. Specify a value for this property only if you specified\n Vpc as the value for the RepositoryAccessMode field of the\n ImageConfig object that you passed to a call to\n CreateModel and the private Docker registry where the model image is\n hosted requires authentication.
The instance type for the reserved capacity offering.
", - "smithy.api#required": {} - } - }, - "InstanceCount": { - "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of instances in the reserved capacity offering.
", - "smithy.api#required": {} - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.sagemaker#AvailabilityZone", - "traits": { - "smithy.api#documentation": "The availability zone for the reserved capacity offering.
" - } - }, - "DurationHours": { - "target": "com.amazonaws.sagemaker#ReservedCapacityDurationHours", - "traits": { - "smithy.api#documentation": "The number of whole hours in the total duration for this reserved capacity\n offering.
" - } - }, - "DurationMinutes": { - "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", - "traits": { - "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this reserved\n capacity offering.
" - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The start time of the reserved capacity offering.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The end time of the reserved capacity offering.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about a reserved capacity offering for a training plan offering.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the reserved capacity.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The instance type for the reserved capacity.
", - "smithy.api#required": {} - } - }, - "TotalInstanceCount": { - "target": "com.amazonaws.sagemaker#TotalInstanceCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The total number of instances in the reserved capacity.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#ReservedCapacityStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the reserved capacity.
", - "smithy.api#required": {} - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.sagemaker#AvailabilityZone", - "traits": { - "smithy.api#documentation": "The availability zone for the reserved capacity.
" - } - }, - "DurationHours": { - "target": "com.amazonaws.sagemaker#ReservedCapacityDurationHours", - "traits": { - "smithy.api#documentation": "The number of whole hours in the total duration for this reserved capacity.
" - } - }, - "DurationMinutes": { - "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", - "traits": { - "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this reserved\n capacity.
" - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The start time of the reserved capacity.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The end time of the reserved capacity.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details of a reserved capacity for the training plan.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The problem type.
" - } - }, - "CompletionCriteria": { - "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" - } - }, - "traits": { - "smithy.api#documentation": "The resolved attributes.
" - } - }, - "com.amazonaws.sagemaker#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+$" - } - }, - "com.amazonaws.sagemaker#ResourceCatalog": { - "type": "structure", - "members": { - "ResourceCatalogArn": { - "target": "com.amazonaws.sagemaker#ResourceCatalogArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": " The Amazon Resource Name (ARN) of the ResourceCatalog.
The name of the ResourceCatalog.
A free form description of the ResourceCatalog.
The time the ResourceCatalog was created.
A resource catalog containing all of the resources of a specific resource type within\n a resource owner account. For an example on sharing the Amazon SageMaker Feature Store\n DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.\n
The ML compute instance type.
\nSageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting\n December 9th, 2022.
\n\n Amazon EC2 P4de instances\n (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance\n HBM2e GPU memory, which accelerate the speed of training ML models that need to be\n trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker\n supports ML training jobs on P4de instances (ml.p4de.24xlarge) to\n reduce model training time. The ml.p4de.24xlarge instances are\n available in the following Amazon Web Services Regions.
US East (N. Virginia) (us-east-1)
\nUS West (Oregon) (us-west-2)
\nTo request quota limit increase and start using P4de instances, contact the SageMaker\n Training service team through your account team.
\nThe number of ML compute instances to use. For distributed training, provide a\n value greater than 1.
" - } - }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#VolumeSizeInGB", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size of the ML storage volume that you want to provision.
\nML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.
When using an ML instance with NVMe SSD\n volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage.\n Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures\n storage paths for training datasets, checkpoints, model artifacts, and outputs to use\n the entire capacity of the instance storage. For example, ML instance families with the\n NVMe-type instance storage include ml.p4d, ml.g4dn, and\n ml.g5.
When using an ML instance with the EBS-only storage option and without instance\n storage, you must define the size of EBS volume through VolumeSizeInGB in\n the ResourceConfig API. For example, ML instance families that use EBS\n volumes include ml.c5 and ml.p2.
To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
\nTo find the default local paths defined by the SageMaker training platform, see Amazon SageMaker\n Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and\n Outputs.
", - "smithy.api#required": {} - } - }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training job.
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nThe VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The duration of time in seconds to retain configured resources in a warm pool for\n subsequent training jobs.
" - } - }, - "InstanceGroups": { - "target": "com.amazonaws.sagemaker#InstanceGroups", - "traits": { - "smithy.api#documentation": "The configuration of a heterogeneous cluster in JSON format.
" - } - }, - "TrainingPlanArn": { - "target": "com.amazonaws.sagemaker#TrainingPlanArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to use for this resource configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the resources, including machine learning (ML) compute instances and ML\n storage volumes, to use for model training.
" - } - }, - "com.amazonaws.sagemaker#ResourceConfigForUpdate": { - "type": "structure", - "members": { - "KeepAlivePeriodInSeconds": { - "target": "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The KeepAlivePeriodInSeconds value specified in the\n ResourceConfig to update.
The ResourceConfig to update KeepAlivePeriodInSeconds. Other\n fields in the ResourceConfig cannot be updated.
Resource being accessed is in use.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.sagemaker#ResourceLimitExceeded": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.sagemaker#FailureReason" - } - }, - "traits": { - "smithy.api#documentation": "You have exceeded an SageMaker resource limit. For example, you might have too many\n training jobs created.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.sagemaker#ResourceLimits": { - "type": "structure", - "members": { - "MaxNumberOfTrainingJobs": { - "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs", - "traits": { - "smithy.api#documentation": "The maximum number of training jobs that a hyperparameter tuning job can\n launch.
" - } - }, - "MaxParallelTrainingJobs": { - "target": "com.amazonaws.sagemaker#MaxParallelTrainingJobs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum number of concurrent training jobs that a hyperparameter tuning job can\n launch.
", - "smithy.api#required": {} - } - }, - "MaxRuntimeInSeconds": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningMaxRuntimeInSeconds", - "traits": { - "smithy.api#documentation": "The maximum time in seconds that a hyperparameter tuning job can run.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the maximum number of training jobs and parallel training jobs that a\n hyperparameter tuning job can launch.
" - } - }, - "com.amazonaws.sagemaker#ResourceNotFound": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.sagemaker#FailureReason" - } - }, - "traits": { - "smithy.api#documentation": "Resource being access is not found.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.sagemaker#ResourcePolicyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20480 - }, - "smithy.api#pattern": "(?:[ \\r\\n\\t].*)*$" - } - }, - "com.amazonaws.sagemaker#ResourcePropertyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.sagemaker#ResourceRetainedBillableTimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#documentation": "Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after\n resource reaches ResourceReused or ResourceReleased state.", - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#ResourceSharingConfig": { - "type": "structure", - "members": { - "Strategy": { - "target": "com.amazonaws.sagemaker#ResourceSharingStrategy", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The strategy of how idle compute is shared within the cluster. The following are the\n options of strategies.
\n\n DontLend: entities do not lend idle compute.
\n Lend: entities can lend idle compute to entities that can\n borrow.
\n LendandBorrow: entities can lend idle compute and borrow idle compute\n from other entities.
Default is LendandBorrow.
The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of\n idle compute that the team is allowed to borrow.
\nDefault is 50.
Resource sharing configuration.
" - } - }, - "com.amazonaws.sagemaker#ResourceSharingStrategy": { - "type": "enum", - "members": { - "LEND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Lend" - } - }, - "DONTLEND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DontLend" - } - }, - "LENDANDBORROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LendAndBorrow" - } - } - } - }, - "com.amazonaws.sagemaker#ResourceSpec": { - "type": "structure", - "members": { - "SageMakerImageArn": { - "target": "com.amazonaws.sagemaker#ImageArn", - "traits": { - "smithy.api#documentation": "The ARN of the SageMaker AI image that the image version belongs to.
" - } - }, - "SageMakerImageVersionArn": { - "target": "com.amazonaws.sagemaker#ImageVersionArn", - "traits": { - "smithy.api#documentation": "The ARN of the image version created on the instance.
" - } - }, - "SageMakerImageVersionAlias": { - "target": "com.amazonaws.sagemaker#ImageVersionAlias", - "traits": { - "smithy.api#documentation": "The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#AppInstanceType", - "traits": { - "smithy.api#documentation": "The instance type that the image version runs on.
\n\n JupyterServer apps only support the system value.
For KernelGateway apps, the system\n value is translated to ml.t3.medium. KernelGateway apps also support all other values for available\n instance types.
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the\n Resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that\n the version runs on.
" - } - }, - "com.amazonaws.sagemaker#ResourceType": { - "type": "enum", - "members": { - "TRAINING_JOB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TrainingJob" - } - }, - "EXPERIMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Experiment" - } - }, - "EXPERIMENT_TRIAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExperimentTrial" - } - }, - "EXPERIMENT_TRIAL_COMPONENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExperimentTrialComponent" - } - }, - "ENDPOINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Endpoint" - } - }, - "MODEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Model" - } - }, - "MODEL_PACKAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelPackage" - } - }, - "MODEL_PACKAGE_GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelPackageGroup" - } - }, - "PIPELINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pipeline" - } - }, - "PIPELINE_EXECUTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PipelineExecution" - } - }, - "FEATURE_GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FeatureGroup" - } - }, - "FEATURE_METADATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FeatureMetadata" - } - }, - "IMAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Image" - } - }, - "IMAGE_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ImageVersion" - } - }, - "PROJECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Project" - } - }, - "HYPER_PARAMETER_TUNING_JOB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HyperParameterTuningJob" - } - }, - "MODEL_CARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ModelCard" - } - } - } - }, - "com.amazonaws.sagemaker#ResponseMIMEType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[-\\w]+\\/.+$" - } - }, - "com.amazonaws.sagemaker#ResponseMIMETypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ResponseMIMEType" - } - }, - "com.amazonaws.sagemaker#RetentionPolicy": { - "type": "structure", - "members": { - "HomeEfsFileSystem": { - "target": "com.amazonaws.sagemaker#RetentionType", - "traits": { - "smithy.api#documentation": "The default is Retain, which specifies to keep the data stored on the\n Amazon EFS volume.
Specify Delete to delete the data stored on the Amazon EFS\n volume.
The retention policy for data stored on an Amazon Elastic File System volume.
" - } - }, - "com.amazonaws.sagemaker#RetentionType": { - "type": "enum", - "members": { - "Retain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Retain" - } - }, - "Delete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Delete" - } - } - } - }, - "com.amazonaws.sagemaker#RetryPipelineExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#RetryPipelineExecutionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#RetryPipelineExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Retry the execution of the pipeline.
" - } - }, - "com.amazonaws.sagemaker#RetryPipelineExecutionRequest": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.sagemaker#IdempotencyToken", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "ParallelismConfiguration": { - "target": "com.amazonaws.sagemaker#ParallelismConfiguration", - "traits": { - "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#RetryPipelineExecutionResponse": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#RetryStrategy": { - "type": "structure", - "members": { - "MaximumRetryAttempts": { - "target": "com.amazonaws.sagemaker#MaximumRetryAttempts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of times to retry the job. When the job is retried, it's\n SecondaryStatus is changed to STARTING.
The retry strategy to use when a training job fails due to an\n InternalServerError. RetryStrategy is specified as part of\n the CreateTrainingJob and CreateHyperParameterTuningJob\n requests. You can add the StoppingCondition parameter to the request to\n limit the training time for the complete job.
Batch size for each rolling step to provision capacity and turn on traffic on the new\n endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between\n 5% to 50% of the variant's total instance count.
", - "smithy.api#required": {} - } - }, - "WaitIntervalInSeconds": { - "target": "com.amazonaws.sagemaker#WaitIntervalInSeconds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The length of the baking period, during which SageMaker monitors alarms for each batch on\n the new fleet.
", - "smithy.api#required": {} - } - }, - "MaximumExecutionTimeoutInSeconds": { - "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "The time limit for the total deployment. Exceeding this limit causes a timeout.
" - } - }, - "RollbackMaximumBatchSize": { - "target": "com.amazonaws.sagemaker#CapacitySize", - "traits": { - "smithy.api#documentation": "Batch size for rollback to the old endpoint fleet. Each rolling step to provision\n capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the\n new endpoint fleet. If this field is absent, the default value will be set to 100% of\n total capacity which means to bring up the whole capacity of the old fleet at once\n during rollback.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a rolling deployment strategy for updating a SageMaker endpoint.
" - } - }, - "com.amazonaws.sagemaker#RootAccess": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - } - } - }, - "com.amazonaws.sagemaker#RoutingStrategy": { - "type": "enum", - "members": { - "LEAST_OUTSTANDING_REQUESTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEAST_OUTSTANDING_REQUESTS" - } - }, - "RANDOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RANDOM" - } - } - } - }, - "com.amazonaws.sagemaker#RuleConfigurationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#RuleEvaluationStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "NO_ISSUES_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NoIssuesFound" - } - }, - "ISSUES_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IssuesFound" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Error" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#RuleParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#ConfigKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#ConfigValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#S3DataDistribution": { - "type": "enum", - "members": { - "FULLY_REPLICATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FullyReplicated" - } - }, - "SHARDED_BY_S3_KEY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ShardedByS3Key" - } - } - } - }, - "com.amazonaws.sagemaker#S3DataSource": { - "type": "structure", - "members": { - "S3DataType": { - "target": "com.amazonaws.sagemaker#S3DataType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want SageMaker to use for model\n training.
If you choose AugmentedManifestFile, S3Uri identifies an object that is\n an augmented manifest file in JSON lines format. This file contains the data you want to\n use for model training. AugmentedManifestFile can only be used if the\n Channel's input mode is Pipe.
Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:
A key name prefix might look like this:\n s3://bucketname/exampleprefix/\n
A manifest might look like this:\n s3://bucketname/example.manifest\n
A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set of\n S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
This JSON is equivalent to the following S3Uri\n list:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.
Your input bucket must be located in same Amazon Web Services region as your\n training job.
", - "smithy.api#required": {} - } - }, - "S3DataDistributionType": { - "target": "com.amazonaws.sagemaker#S3DataDistribution", - "traits": { - "smithy.api#documentation": "If you want SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.
If you want SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.
\nIn distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.
A list of one or more attribute names to use that are found in a specified augmented\n manifest file.
" - } - }, - "InstanceGroupNames": { - "target": "com.amazonaws.sagemaker#InstanceGroupNames", - "traits": { - "smithy.api#documentation": "A list of names of instance groups that get data from the S3 data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the S3 data source.
\nYour input bucket must be in the same Amazon Web Services region as your training\n job.
" - } - }, - "com.amazonaws.sagemaker#S3DataType": { - "type": "enum", - "members": { - "MANIFEST_FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManifestFile" - } - }, - "S3_PREFIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3Prefix" - } - }, - "AUGMENTED_MANIFEST_FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AugmentedManifestFile" - } - } - } - }, - "com.amazonaws.sagemaker#S3ModelDataSource": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3ModelUri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the S3 path of ML model data to deploy.
", - "smithy.api#required": {} - } - }, - "S3DataType": { - "target": "com.amazonaws.sagemaker#S3ModelDataType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the type of ML model data to deploy.
\nIf you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix as part of the ML model\n data to deploy. A valid key name prefix identified by S3Uri always ends\n with a forward slash (/).
If you choose S3Object, S3Uri identifies an object that is\n the ML model data to deploy.
Specifies how the ML model data is prepared.
\nIf you choose Gzip and choose S3Object as the value of\n S3DataType, S3Uri identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during\n model deployment.
If you choose None and chooose S3Object as the value of\n S3DataType, S3Uri identifies an object that represents an\n uncompressed ML model to deploy.
If you choose None and choose S3Prefix as the value of\n S3DataType, S3Uri identifies a key name prefix, under\n which all objects represents the uncompressed ML model to deploy.
If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:
\nIf you choose S3Object as the value of S3DataType,\n then SageMaker will split the key of the S3 object referenced by S3Uri\n by slash (/), and use the last part as the filename of the file holding the\n content of the S3 object.
If you choose S3Prefix as the value of S3DataType,\n then for each S3 object under the key name pefix referenced by\n S3Uri, SageMaker will trim its key by the prefix, and use the\n remainder as the path (relative to /opt/ml/model) of the file\n holding the content of the S3 object. SageMaker will split the remainder by slash\n (/), using intermediate parts as directory names and the last part as filename\n of the file holding the content of the S3 object.
Do not use any of the following as file names or directory names:
\nAn empty or blank string
\nA string which contains null bytes
\nA string longer than 255 bytes
\nA single dot (.)
A double dot (..)
Ambiguous file names will result in model deployment failure. For example, if\n your uncompressed ML model consists of two S3 objects\n s3://mybucket/model/weights and\n s3://mybucket/model/weights/part1 and you specify\n s3://mybucket/model/ as the value of S3Uri and\n S3Prefix as the value of S3DataType, then it will\n result in name clash between /opt/ml/model/weights (a regular file)\n and /opt/ml/model/weights/ (a directory).
Do not organize the model artifacts in S3 console using\n folders. When you create a folder in S3 console, S3 creates a 0-byte\n object with a key set to the folder name you provide. They key of the 0-byte\n object ends with a slash (/) which violates SageMaker restrictions on model artifact\n file names, leading to model deployment failure.
\nSpecifies the access configuration file for the ML model. You can explicitly accept the\n model end-user license agreement (EULA) within the ModelAccessConfig. You are\n responsible for reviewing and complying with any applicable license terms and making sure\n they are acceptable for your use case before downloading or using a model.
Configuration information for hub access.
" - } - }, - "ManifestS3Uri": { - "target": "com.amazonaws.sagemaker#S3ModelUri", - "traits": { - "smithy.api#documentation": "The Amazon S3 URI of the manifest file. The manifest file is a CSV file that stores the\n artifact locations.
" - } - }, - "ETag": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The ETag associated with S3 URI.
" - } - }, - "ManifestEtag": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The ETag associated with Manifest S3 URI.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the S3 location of ML model data to deploy.
" - } - }, - "com.amazonaws.sagemaker#S3ModelDataType": { - "type": "enum", - "members": { - "S3Prefix": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3Prefix" - } - }, - "S3Object": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3Object" - } - } - } - }, - "com.amazonaws.sagemaker#S3ModelUri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" - } - }, - "com.amazonaws.sagemaker#S3OutputPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" - } - }, - "com.amazonaws.sagemaker#S3Presign": { - "type": "structure", - "members": { - "IamPolicyConstraints": { - "target": "com.amazonaws.sagemaker#IamPolicyConstraints", - "traits": { - "smithy.api#documentation": "Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp.
This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.
To learn more about how custom templates are created, see Create custom worker task templates.
" - } - }, - "com.amazonaws.sagemaker#S3StorageConfig": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following:\n s3://example-bucket/prefix/.
The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt\n any objects written into the OfflineStore S3 location.
The IAM roleARN that is passed as a parameter to\n CreateFeatureGroup must have below permissions to the\n KmsKeyId:
\n \"kms:GenerateDataKey\"\n
The S3 path where offline records are written.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon Simple Storage (Amazon S3) location and security configuration for\n OfflineStore.
Provides APIs for creating and managing SageMaker resources.
\nOther Resources:
\nA target tracking scaling policy. Includes support for predefined or customized metrics.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object containing a recommended scaling policy.
" - } - }, - "com.amazonaws.sagemaker#ScalingPolicyMetric": { - "type": "structure", - "members": { - "InvocationsPerInstance": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The number of invocations sent to a model, normalized by InstanceCount\n in each ProductionVariant. 1/numberOfInstances is sent as the value on each\n request, where numberOfInstances is the number of active instances for the\n ProductionVariant behind the endpoint at the time of the request.
The interval of time taken by a model to respond as viewed from SageMaker.\n This interval includes the local communication times taken to send the request\n and to fetch the response from the container of a model and the time taken to\n complete the inference in the container.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The metric for a scaling policy.
" - } - }, - "com.amazonaws.sagemaker#ScalingPolicyObjective": { - "type": "structure", - "members": { - "MinInvocationsPerMinute": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The minimum number of expected requests to your endpoint per minute.
" - } - }, - "MaxInvocationsPerMinute": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of expected requests to your endpoint per minute.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object where you specify the anticipated traffic pattern for an endpoint.
" - } - }, - "com.amazonaws.sagemaker#ScheduleConfig": { - "type": "structure", - "members": { - "ScheduleExpression": { - "target": "com.amazonaws.sagemaker#ScheduleExpression", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A cron expression that describes details about the monitoring schedule.
\nThe supported cron expressions are:
\nIf you want to set the job to start every hour, use the following:
\n\n Hourly: cron(0 * ? * * *)\n
If you want to start the job daily:
\n\n cron(0 [00-23] ? * * *)\n
If you want to run the job one time, immediately, use the following\n keyword:
\n\n NOW\n
For example, the following are valid cron expressions:
\nDaily at noon UTC: cron(0 12 ? * * *)\n
Daily at midnight UTC: cron(0 0 ? * * *)\n
To support running every 6, 12 hours, the following are also supported:
\n\n cron(0 [00-23]/[01-24] ? * * *)\n
For example, the following are valid cron expressions:
\nEvery 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)\n
Every two hours starting at midnight: cron(0 0/2 ? * * *)\n
Even though the cron expression is set to start at 5PM UTC, note that there\n could be a delay of 0-20 minutes from the actual requested time to run the\n execution.
\nWe recommend that if you would like a daily schedule, you do not provide this\n parameter. Amazon SageMaker AI will pick a time for running every day.
\nYou can also specify the keyword NOW to run the monitoring job immediately,\n one time, without recurring.
Sets the start time for a monitoring job window. Express this time as an offset to the\n times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the\n ScheduleExpression parameter. Specify this offset in ISO 8601 duration\n format. For example, if you want to monitor the five hours of data in your dataset that\n precede the start of each monitoring job, you would specify: \"-PT5H\".
The start time that you specify must not precede the end time that you specify by more\n than 24 hours. You specify the end time with the DataAnalysisEndTime\n parameter.
If you set ScheduleExpression to NOW, this parameter is\n required.
Sets the end time for a monitoring job window. Express this time as an offset to the\n times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the\n ScheduleExpression parameter. Specify this offset in ISO 8601 duration\n format. For example, if you want to end the window one hour before the start of each\n monitoring job, you would specify: \"-PT1H\".
The end time that you specify must not follow the start time that you specify by more\n than 24 hours. You specify the start time with the DataAnalysisStartTime\n parameter.
If you set ScheduleExpression to NOW, this parameter is\n required.
Configuration details about the monitoring schedule.
" - } - }, - "com.amazonaws.sagemaker#ScheduleExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#ScheduleStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Scheduled" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#SchedulerConfig": { - "type": "structure", - "members": { - "PriorityClasses": { - "target": "com.amazonaws.sagemaker#PriorityClassList", - "traits": { - "smithy.api#documentation": "List of the priority classes, PriorityClass, of the cluster policy. When\n specified, these class configurations define how tasks are queued.
When enabled, entities borrow idle compute based on their assigned\n FairShareWeight.
When disabled, entities borrow idle compute based on a first-come first-serve\n basis.
\nDefault is Enabled.
Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.
" - } - }, - "com.amazonaws.sagemaker#SchedulerResourceStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateFailed" - } - }, - "CREATE_ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateRollbackFailed" - } - }, - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Created" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateFailed" - } - }, - "UPDATE_ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateRollbackFailed" - } - }, - "UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updated" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteFailed" - } - }, - "DELETE_ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteRollbackFailed" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleted" - } - } - } - }, - "com.amazonaws.sagemaker#Scope": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[!#-\\[\\]-~]+( [!#-\\[\\]-~]+)*$" - } - }, - "com.amazonaws.sagemaker#Search": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#SearchRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#SearchResponse" - }, - "traits": { - "smithy.api#documentation": "Finds SageMaker resources that match a search query. Matching resources are returned\n as a list of SearchRecord objects in the response. You can sort the search\n results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and\n timestamp.
\nThe Search API may provide access to otherwise restricted data. See Amazon SageMaker \n API Permissions: Actions, Permissions, and Resources Reference for more\n information.
\nA list of filter objects.
" - } - }, - "NestedFilters": { - "target": "com.amazonaws.sagemaker#NestedFiltersList", - "traits": { - "smithy.api#documentation": "A list of nested filter objects.
" - } - }, - "SubExpressions": { - "target": "com.amazonaws.sagemaker#SearchExpressionList", - "traits": { - "smithy.api#documentation": "A list of search expression objects.
" - } - }, - "Operator": { - "target": "com.amazonaws.sagemaker#BooleanOperator", - "traits": { - "smithy.api#documentation": "A Boolean operator used to evaluate the search expression. If you want every\n conditional statement in all lists to be satisfied for the entire search expression to\n be true, specify And. If only a single conditional statement needs to be\n true for the entire search expression to be true, specify Or. The default\n value is And.
A multi-expression that searches for the specified resource or resources in a search. All resource\n objects that satisfy the expression's condition are included in the search results. You must specify at\n least one subexpression, filter, or nested filter. A SearchExpression can contain up to\n twenty elements.
A SearchExpression contains the following components:
A list of Filter objects. Each filter defines a simple Boolean\n expression comprised of a resource property name, Boolean operator, and\n value.
A list of NestedFilter objects. Each nested filter defines a list\n of Boolean expressions using a list of resource properties. A nested filter is\n satisfied if a single object in the list satisfies all Boolean\n expressions.
A list of SearchExpression objects. A search expression object\n can be nested in a list of search expression objects.
A Boolean operator: And or Or.
The properties of a training job.
" - } - }, - "Experiment": { - "target": "com.amazonaws.sagemaker#Experiment", - "traits": { - "smithy.api#documentation": "The properties of an experiment.
" - } - }, - "Trial": { - "target": "com.amazonaws.sagemaker#Trial", - "traits": { - "smithy.api#documentation": "The properties of a trial.
" - } - }, - "TrialComponent": { - "target": "com.amazonaws.sagemaker#TrialComponent", - "traits": { - "smithy.api#documentation": "The properties of a trial component.
" - } - }, - "Endpoint": { - "target": "com.amazonaws.sagemaker#Endpoint" - }, - "ModelPackage": { - "target": "com.amazonaws.sagemaker#ModelPackage" - }, - "ModelPackageGroup": { - "target": "com.amazonaws.sagemaker#ModelPackageGroup" - }, - "Pipeline": { - "target": "com.amazonaws.sagemaker#Pipeline" - }, - "PipelineExecution": { - "target": "com.amazonaws.sagemaker#PipelineExecution" - }, - "FeatureGroup": { - "target": "com.amazonaws.sagemaker#FeatureGroup" - }, - "FeatureMetadata": { - "target": "com.amazonaws.sagemaker#FeatureMetadata", - "traits": { - "smithy.api#documentation": "The feature metadata used to search through the features.
" - } - }, - "Project": { - "target": "com.amazonaws.sagemaker#Project", - "traits": { - "smithy.api#documentation": "The properties of a project.
" - } - }, - "HyperParameterTuningJob": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSearchEntity", - "traits": { - "smithy.api#documentation": "The properties of a hyperparameter tuning job.
" - } - }, - "ModelCard": { - "target": "com.amazonaws.sagemaker#ModelCard", - "traits": { - "smithy.api#documentation": "An Amazon SageMaker Model Card that documents details about a machine learning model.
" - } - }, - "Model": { - "target": "com.amazonaws.sagemaker#ModelDashboardModel" - } - }, - "traits": { - "smithy.api#documentation": "A single resource returned as part of the Search API response.
" - } - }, - "com.amazonaws.sagemaker#SearchRequest": { - "type": "structure", - "members": { - "Resource": { - "target": "com.amazonaws.sagemaker#ResourceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the SageMaker resource to search for.
", - "smithy.api#required": {} - } - }, - "SearchExpression": { - "target": "com.amazonaws.sagemaker#SearchExpression", - "traits": { - "smithy.api#documentation": "A Boolean conditional statement. Resources must satisfy this condition to be\n included in search results. You must provide at least one subexpression, filter, or\n nested filter. The maximum number of recursive SubExpressions,\n NestedFilters, and Filters that can be included in a\n SearchExpression object is 50.
The name of the resource property used to sort the SearchResults. The\n default is LastModifiedTime.
How SearchResults are ordered. Valid values are Ascending or\n Descending. The default is Descending.
If more than MaxResults resources match the specified\n SearchExpression, the response includes a\n NextToken. The NextToken can be passed to the next\n SearchRequest to continue retrieving results.
The maximum number of results to return.
" - } - }, - "CrossAccountFilterOption": { - "target": "com.amazonaws.sagemaker#CrossAccountFilterOption", - "traits": { - "smithy.api#documentation": "\n A cross account filter option. When the value is \"CrossAccount\" the \n search results will only include resources made discoverable to you from other \n accounts. When the value is \"SameAccount\" or null the \n search results will only include resources from your account. Default is \n null. For more information on searching for resources made \n discoverable to your account, see \n Search discoverable resources in the SageMaker Developer Guide.\n The maximum number of ResourceCatalogs viewable is 1000.\n
\n Limits the results of your search request to the resources that you can access.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#SearchResponse": { - "type": "structure", - "members": { - "Results": { - "target": "com.amazonaws.sagemaker#SearchResultsList", - "traits": { - "smithy.api#documentation": "A list of SearchRecord objects.
If the result of the previous Search request was truncated, the response\n includes a NextToken. To retrieve the next set of results, use the token in the next\n request.
Searches for available training plan offerings based on specified criteria.
\nUsers search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration).
\nAnd then, they create a plan that best matches their needs using the ID of the\n plan offering they want to use.
\nFor more information about how to reserve GPU capacity for your SageMaker training jobs or\n SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see \n CreateTrainingPlan\n .
The type of instance you want to search for in the available training plan offerings.\n This field allows you to filter the search results based on the specific compute resources\n you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training\n plan offerings, specifying the instance type helps you find Reserved Instances that match\n your computational needs.
", - "smithy.api#required": {} - } - }, - "InstanceCount": { - "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of instances you want to reserve in the training plan offerings. This allows\n you to specify the quantity of compute resources needed for your SageMaker training jobs or\n SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your\n requirements.
", - "smithy.api#required": {} - } - }, - "StartTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter to search for training plan offerings with a start time after a specified\n date.
" - } - }, - "EndTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A filter to search for reserved capacity offerings with an end time before a specified\n date.
" - } - }, - "DurationHours": { - "target": "com.amazonaws.sagemaker#TrainingPlanDurationHoursInput", - "traits": { - "smithy.api#documentation": "The desired duration in hours for the training plan offerings.
" - } - }, - "TargetResources": { - "target": "com.amazonaws.sagemaker#SageMakerResourceNames", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the\n offerings.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nA list of training plan offerings that match the search criteria.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#SecondaryStatus": { - "type": "enum", - "members": { - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Starting" - } - }, - "LAUNCHING_ML_INSTANCES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LaunchingMLInstances" - } - }, - "PREPARING_TRAINING_STACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PreparingTrainingStack" - } - }, - "DOWNLOADING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Downloading" - } - }, - "DOWNLOADING_TRAINING_IMAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DownloadingTrainingImage" - } - }, - "TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Training" - } - }, - "UPLOADING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Uploading" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - }, - "MAX_RUNTIME_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MaxRuntimeExceeded" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "INTERRUPTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Interrupted" - } - }, - "MAX_WAIT_TIME_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MaxWaitTimeExceeded" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "RESTARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Restarting" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - } - } - }, - "com.amazonaws.sagemaker#SecondaryStatusTransition": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#SecondaryStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Contains a secondary status information from a training\n job.
\nStatus might be one of the following secondary statuses:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTrainingStack\n
\n DownloadingTrainingImage\n
A timestamp that shows when the training job transitioned to the current secondary\n status state.
", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the training job transitioned out of this secondary status\n state into another secondary status state or when the training job has ended.
" - } - }, - "StatusMessage": { - "target": "com.amazonaws.sagemaker#StatusMessage", - "traits": { - "smithy.api#documentation": "A detailed description of the progress within a secondary status.\n
\nSageMaker provides secondary statuses and status messages that apply to each of\n them:
\nStarting the training job.
\nLaunching requested ML\n instances.
\nInsufficient\n capacity error from EC2 while launching instances,\n retrying!
\nLaunched\n instance was unhealthy, replacing it!
\nPreparing the instances for training.
\nTraining\n image download completed. Training in\n progress.
\nStatus messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.
\nTo have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example,\n at the start of a training job, you might see the following:
\n TrainingJobStatus - InProgress
\n SecondaryStatus - Training
\n StatusMessage - Downloading the training image
An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the\n training job has transitioned through. A training job can be in one of several states,\n for example, starting, downloading, training, or uploading. Within each state, there are\n a number of intermediate states. For example, within the starting state, SageMaker could be\n starting the training job or launching the ML instances. These transitional states are\n referred to as the job's secondary\n status.\n
The name of the pipeline step.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A step selected to run in selective execution mode.
" - } - }, - "com.amazonaws.sagemaker#SelectedStepList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#SelectedStep" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#SelectiveExecutionConfig": { - "type": "structure", - "members": { - "SourcePipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either Failed\n or Success.
This field is required if the steps you specify for\n SelectedSteps depend on output collaterals from any non-specified pipeline\n steps. For more information, see Selective\n Execution for Pipeline Steps.
A list of pipeline steps to run. All step(s) in all path(s) between\n two selected steps should be included.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The selective execution configuration applied to the pipeline run.
" - } - }, - "com.amazonaws.sagemaker#SelectiveExecutionResult": { - "type": "structure", - "members": { - "SourcePipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The ARN from an execution of the current pipeline.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The ARN from an execution of the current pipeline.
" - } - }, - "com.amazonaws.sagemaker#SendPipelineExecutionStepFailure": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Notifies the pipeline that the execution of a callback step failed, along with a\n message describing why. When a callback step is run, the pipeline generates a callback\n token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" - } - }, - "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureRequest": { - "type": "structure", - "members": { - "CallbackToken": { - "target": "com.amazonaws.sagemaker#CallbackToken", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The pipeline generated token from the Amazon SQS queue.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "A message describing why the step failed.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.sagemaker#IdempotencyToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureResponse": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Notifies the pipeline that the execution of a callback step succeeded and provides a\n list of the step's output parameters. When a callback step is run, the pipeline generates\n a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" - } - }, - "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessRequest": { - "type": "structure", - "members": { - "CallbackToken": { - "target": "com.amazonaws.sagemaker#CallbackToken", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The pipeline generated token from the Amazon SQS queue.
", - "smithy.api#required": {} - } - }, - "OutputParameters": { - "target": "com.amazonaws.sagemaker#OutputParameterList", - "traits": { - "smithy.api#documentation": "A list of the output parameters of the callback step.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.sagemaker#IdempotencyToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessResponse": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#ServerlessMaxConcurrency": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.sagemaker#ServerlessMemorySizeInMB": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1024, - "max": 6144 - } - } - }, - "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.sagemaker#ServiceCatalogEntityId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-]*$" - } - }, - "com.amazonaws.sagemaker#ServiceCatalogProvisionedProductDetails": { - "type": "structure", - "members": { - "ProvisionedProductId": { - "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", - "traits": { - "smithy.api#documentation": "The ID of the provisioned product.
" - } - }, - "ProvisionedProductStatusMessage": { - "target": "com.amazonaws.sagemaker#ProvisionedProductStatusMessage", - "traits": { - "smithy.api#documentation": "The current status of the product.
\n\n AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
\n UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
\n TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
\n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
\n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
Details of a provisioned service catalog product. For information about service catalog,\n see What is Amazon Web Services Service\n Catalog.
" - } - }, - "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails": { - "type": "structure", - "members": { - "ProductId": { - "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the product to provision.
", - "smithy.api#required": {} - } - }, - "ProvisioningArtifactId": { - "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", - "traits": { - "smithy.api#documentation": "The ID of the provisioning artifact.
" - } - }, - "PathId": { - "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", - "traits": { - "smithy.api#documentation": "The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
" - } - }, - "ProvisioningParameters": { - "target": "com.amazonaws.sagemaker#ProvisioningParameters", - "traits": { - "smithy.api#documentation": "A list of key value pairs that you specify when you provision a product.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details that you specify to provision a service catalog product. For information about\n service catalog, see What is Amazon Web Services Service\n Catalog.
" - } - }, - "com.amazonaws.sagemaker#ServiceCatalogProvisioningUpdateDetails": { - "type": "structure", - "members": { - "ProvisioningArtifactId": { - "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", - "traits": { - "smithy.api#documentation": "The ID of the provisioning artifact.
" - } - }, - "ProvisioningParameters": { - "target": "com.amazonaws.sagemaker#ProvisioningParameters", - "traits": { - "smithy.api#documentation": "A list of key value pairs that you specify when you provision a product.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details that you specify to provision a service catalog product. \n For information about service catalog, see What is Amazon Web Services Service Catalog.\n
" - } - }, - "com.amazonaws.sagemaker#SessionChainingConfig": { - "type": "structure", - "members": { - "EnableSessionTagChaining": { - "target": "com.amazonaws.sagemaker#EnableSessionTagChaining", - "traits": { - "smithy.api#documentation": "Set to True to allow SageMaker to extract session tags from a training job\n creation role and reuse these tags when assuming the training job execution role.
Contains information about attribute-based access control (ABAC) for a training job.\n The session chaining configuration uses Amazon Security Token Service (STS) for your training job to\n request temporary, limited-privilege credentials to tenants. For more information, see\n Attribute-based access control (ABAC) for multi-tenancy training.
" - } - }, - "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1800, - "max": 43200 - } - } - }, - "com.amazonaws.sagemaker#ShadowModeConfig": { - "type": "structure", - "members": { - "SourceModelVariantName": { - "target": "com.amazonaws.sagemaker#ModelVariantName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The name of the production variant, which takes all the inference requests.\n
", - "smithy.api#required": {} - } - }, - "ShadowModelVariants": { - "target": "com.amazonaws.sagemaker#ShadowModelVariantConfigList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List of shadow variant configurations.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type, which specifies a production variant\n to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.\n
The name of the shadow variant.
", - "smithy.api#required": {} - } - }, - "SamplingPercentage": { - "target": "com.amazonaws.sagemaker#Percentage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The name and sampling percentage of a shadow variant.
" - } - }, - "com.amazonaws.sagemaker#ShadowModelVariantConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ShadowModelVariantConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#SharingSettings": { - "type": "structure", - "members": { - "NotebookOutputOption": { - "target": "com.amazonaws.sagemaker#NotebookOutputOption", - "traits": { - "smithy.api#documentation": "Whether to include the notebook cell output when sharing the notebook. The default is\n Disabled.
When NotebookOutputOption is Allowed, the Amazon S3\n bucket used to store the shared notebook snapshots.
When NotebookOutputOption is Allowed, the Amazon Web Services Key\n Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the\n Amazon S3 bucket.
Specifies options for sharing Amazon SageMaker AI Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain API\n is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing isn't\n allowed.
Determines the shuffling order in ShuffleConfig value.
A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, the results of the S3 key prefix\n matches are shuffled. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.
For Pipe input mode, when ShuffleConfig is specified shuffling is done at\n the start of every epoch. With large datasets, this ensures that the order of the\n training data is different for each epoch, and it helps reduce bias and possible\n overfitting. In a multi-node training job when ShuffleConfig is combined\n with S3DataDistributionType of ShardedByS3Key, the data is\n shuffled across nodes so that the content sent to a particular node on the first epoch\n might be sent to a different node on the second epoch.
The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services\n region as the algorithm.
\nSpecifies the location of ML model data to deploy during endpoint creation.
" - } - }, - "ModelDataETag": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The ETag associated with Model Data URL.
" - } - }, - "AlgorithmName": { - "target": "com.amazonaws.sagemaker#ArnOrName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
" - } - }, - "com.amazonaws.sagemaker#SourceAlgorithmList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#SourceAlgorithm" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.sagemaker#SourceAlgorithmSpecification": { - "type": "structure", - "members": { - "SourceAlgorithms": { - "target": "com.amazonaws.sagemaker#SourceAlgorithmList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of the algorithms that were used to create a model package.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A list of algorithms that were used to create a model package.
" - } - }, - "com.amazonaws.sagemaker#SourceIpConfig": { - "type": "structure", - "members": { - "Cidrs": { - "target": "com.amazonaws.sagemaker#Cidrs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of one to ten Classless Inter-Domain Routing (CIDR) values.
\nMaximum: Ten CIDR values
\nThe following Length Constraints apply to individual CIDR values in\n the CIDR value list.
\nA list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an\n IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
" - } - }, - "com.amazonaws.sagemaker#SourceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.sagemaker#SourceUri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#SpaceAppLifecycleManagement": { - "type": "structure", - "members": { - "IdleSettings": { - "target": "com.amazonaws.sagemaker#SpaceIdleSettings", - "traits": { - "smithy.api#documentation": "Settings related to idle shutdown of Studio applications.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications in a space.
" - } - }, - "com.amazonaws.sagemaker#SpaceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/" - } - }, - "com.amazonaws.sagemaker#SpaceCodeEditorAppSettings": { - "type": "structure", - "members": { - "DefaultResourceSpec": { - "target": "com.amazonaws.sagemaker#ResourceSpec" - }, - "AppLifecycleManagement": { - "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", - "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of CodeEditor applications in\n a space.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The application settings for a Code Editor space.
" - } - }, - "com.amazonaws.sagemaker#SpaceDetails": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "The ID of the associated domain.
" - } - }, - "SpaceName": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#documentation": "The name of the space.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#SpaceStatus", - "traits": { - "smithy.api#documentation": "The status.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "The creation time.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "The last modified time.
" - } - }, - "SpaceSettingsSummary": { - "target": "com.amazonaws.sagemaker#SpaceSettingsSummary", - "traits": { - "smithy.api#documentation": "Specifies summary information about the space settings.
" - } - }, - "SpaceSharingSettingsSummary": { - "target": "com.amazonaws.sagemaker#SpaceSharingSettingsSummary", - "traits": { - "smithy.api#documentation": "Specifies summary information about the space sharing settings.
" - } - }, - "OwnershipSettingsSummary": { - "target": "com.amazonaws.sagemaker#OwnershipSettingsSummary", - "traits": { - "smithy.api#documentation": "Specifies summary information about the ownership settings.
" - } - }, - "SpaceDisplayName": { - "target": "com.amazonaws.sagemaker#NonEmptyString64", - "traits": { - "smithy.api#documentation": "The name of the space that appears in the Studio UI.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The space's details.
" - } - }, - "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 5, - "max": 16384 - } - } - }, - "com.amazonaws.sagemaker#SpaceIdleSettings": { - "type": "structure", - "members": { - "IdleTimeoutInMinutes": { - "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", - "traits": { - "smithy.api#documentation": "The time that SageMaker waits after the application becomes idle before shutting it\n down.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings related to idle shutdown of Studio applications in a space.
" - } - }, - "com.amazonaws.sagemaker#SpaceJupyterLabAppSettings": { - "type": "structure", - "members": { - "DefaultResourceSpec": { - "target": "com.amazonaws.sagemaker#ResourceSpec" - }, - "CodeRepositories": { - "target": "com.amazonaws.sagemaker#CodeRepositories", - "traits": { - "smithy.api#documentation": "A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
" - } - }, - "AppLifecycleManagement": { - "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", - "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of JupyterLab applications in\n a space.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The settings for the JupyterLab application within a space.
" - } - }, - "com.amazonaws.sagemaker#SpaceList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#SpaceDetails" - } - }, - "com.amazonaws.sagemaker#SpaceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#SpaceSettings": { - "type": "structure", - "members": { - "JupyterServerAppSettings": { - "target": "com.amazonaws.sagemaker#JupyterServerAppSettings" - }, - "KernelGatewayAppSettings": { - "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings" - }, - "CodeEditorAppSettings": { - "target": "com.amazonaws.sagemaker#SpaceCodeEditorAppSettings", - "traits": { - "smithy.api#documentation": "The Code Editor application settings.
" - } - }, - "JupyterLabAppSettings": { - "target": "com.amazonaws.sagemaker#SpaceJupyterLabAppSettings", - "traits": { - "smithy.api#documentation": "The settings for the JupyterLab application.
" - } - }, - "AppType": { - "target": "com.amazonaws.sagemaker#AppType", - "traits": { - "smithy.api#documentation": "The type of app created within the space.
\nIf using the \n UpdateSpace API, you can't change the app type of your\n space by specifying a different value for this field.
" - } - }, - "SpaceStorageSettings": { - "target": "com.amazonaws.sagemaker#SpaceStorageSettings", - "traits": { - "smithy.api#documentation": "The storage settings for a space.
" - } - }, - "CustomFileSystems": { - "target": "com.amazonaws.sagemaker#CustomFileSystems", - "traits": { - "smithy.api#documentation": "A file system, created by you, that you assign to a space for an Amazon SageMaker AI\n Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of space settings.
" - } - }, - "com.amazonaws.sagemaker#SpaceSettingsSummary": { - "type": "structure", - "members": { - "AppType": { - "target": "com.amazonaws.sagemaker#AppType", - "traits": { - "smithy.api#documentation": "The type of app created within the space.
" - } - }, - "SpaceStorageSettings": { - "target": "com.amazonaws.sagemaker#SpaceStorageSettings", - "traits": { - "smithy.api#documentation": "The storage settings for a space.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies summary information about the space settings.
" - } - }, - "com.amazonaws.sagemaker#SpaceSharingSettings": { - "type": "structure", - "members": { - "SharingType": { - "target": "com.amazonaws.sagemaker#SharingType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the sharing type of the space.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of space sharing settings.
" - } - }, - "com.amazonaws.sagemaker#SpaceSharingSettingsSummary": { - "type": "structure", - "members": { - "SharingType": { - "target": "com.amazonaws.sagemaker#SharingType", - "traits": { - "smithy.api#documentation": "Specifies the sharing type of the space.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies summary information about the space sharing settings.
" - } - }, - "com.amazonaws.sagemaker#SpaceSortKey": { - "type": "enum", - "members": { - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "LastModifiedTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastModifiedTime" - } - } - } - }, - "com.amazonaws.sagemaker#SpaceStatus": { - "type": "enum", - "members": { - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "InService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Updating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "Update_Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Update_Failed" - } - }, - "Delete_Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Delete_Failed" - } - } - } - }, - "com.amazonaws.sagemaker#SpaceStorageSettings": { - "type": "structure", - "members": { - "EbsStorageSettings": { - "target": "com.amazonaws.sagemaker#EbsStorageSettings", - "traits": { - "smithy.api#documentation": "A collection of EBS storage settings for a space.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The storage settings for a space.
" - } - }, - "com.amazonaws.sagemaker#SpawnRate": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#SplitType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - }, - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Line" - } - }, - "RECORDIO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RecordIO" - } - }, - "TFRECORD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TFRecord" - } - } - } - }, - "com.amazonaws.sagemaker#StageDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^.{0,1024}$" - } - }, - "com.amazonaws.sagemaker#StageStatus": { - "type": "enum", - "members": { - "Creating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ReadyToDeploy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READYTODEPLOY" - } - }, - "Starting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INPROGRESS" - } - }, - "Deployed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEPLOYED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "Stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.sagemaker#Stairs": { - "type": "structure", - "members": { - "DurationInSeconds": { - "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", - "traits": { - "smithy.api#documentation": "Defines how long each traffic step should be.
" - } - }, - "NumberOfSteps": { - "target": "com.amazonaws.sagemaker#NumberOfSteps", - "traits": { - "smithy.api#documentation": "Specifies how many steps to perform during traffic.
" - } - }, - "UsersPerStep": { - "target": "com.amazonaws.sagemaker#UsersPerStep", - "traits": { - "smithy.api#documentation": "Specifies how many new users to spawn in each step.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the stairs traffic pattern for an Inference Recommender load test. This pattern\n type consists of multiple steps where the number of users increases at each step.
\nSpecify either the stairs or phases traffic pattern.
" - } - }, - "com.amazonaws.sagemaker#StartEdgeDeploymentStage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StartEdgeDeploymentStageRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Starts a stage in an edge deployment plan.
" - } - }, - "com.amazonaws.sagemaker#StartEdgeDeploymentStageRequest": { - "type": "structure", - "members": { - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan to start.
", - "smithy.api#required": {} - } - }, - "StageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stage to start.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StartInferenceExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StartInferenceExperimentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#StartInferenceExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Starts an inference experiment.
" - } - }, - "com.amazonaws.sagemaker#StartInferenceExperimentRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#InferenceExperimentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference experiment to start.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StartInferenceExperimentResponse": { - "type": "structure", - "members": { - "InferenceExperimentArn": { - "target": "com.amazonaws.sagemaker#InferenceExperimentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the started inference experiment to start.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#StartMlflowTrackingServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Programmatically start an MLflow Tracking Server.
" - } - }, - "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest": { - "type": "structure", - "members": { - "TrackingServerName": { - "target": "com.amazonaws.sagemaker#TrackingServerName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the tracking server to start.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse": { - "type": "structure", - "members": { - "TrackingServerArn": { - "target": "com.amazonaws.sagemaker#TrackingServerArn", - "traits": { - "smithy.api#documentation": "The ARN of the started tracking server.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#StartMonitoringSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StartMonitoringScheduleRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Starts a previously stopped monitoring schedule.
\nBy default, when you successfully create a new schedule, the status of a monitoring\n schedule is scheduled.
The name of the schedule to start.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StartNotebookInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StartNotebookInstanceInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Launches an ML compute instance with the latest version of the libraries and\n attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to InService. A notebook\n instance's status must be InService before you can connect to your Jupyter\n notebook.
The name of the notebook instance to start.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StartPipelineExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StartPipelineExecutionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#StartPipelineExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Starts a pipeline execution.
" - } - }, - "com.amazonaws.sagemaker#StartPipelineExecutionRequest": { - "type": "structure", - "members": { - "PipelineName": { - "target": "com.amazonaws.sagemaker#PipelineNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the pipeline.
", - "smithy.api#required": {} - } - }, - "PipelineExecutionDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineExecutionName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline execution.
" - } - }, - "PipelineParameters": { - "target": "com.amazonaws.sagemaker#ParameterList", - "traits": { - "smithy.api#documentation": "Contains a list of pipeline parameters. This list can be empty.
" - } - }, - "PipelineExecutionDescription": { - "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", - "traits": { - "smithy.api#documentation": "The description of the pipeline execution.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.sagemaker#IdempotencyToken", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "ParallelismConfiguration": { - "target": "com.amazonaws.sagemaker#ParallelismConfiguration", - "traits": { - "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.
" - } - }, - "SelectiveExecutionConfig": { - "target": "com.amazonaws.sagemaker#SelectiveExecutionConfig", - "traits": { - "smithy.api#documentation": "The selective execution configuration applied to the pipeline run.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StartPipelineExecutionResponse": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#Statistic": { - "type": "enum", - "members": { - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Average" - } - }, - "MINIMUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimum" - } - }, - "MAXIMUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximum" - } - }, - "SAMPLE_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SampleCount" - } - }, - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Sum" - } - } - } - }, - "com.amazonaws.sagemaker#StatusDetails": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#StatusMessage": { - "type": "string" - }, - "com.amazonaws.sagemaker#StepDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3072 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#StepDisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#StepName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[A-Za-z0-9\\-_]*$" - } - }, - "com.amazonaws.sagemaker#StepStatus": { - "type": "enum", - "members": { - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Starting" - } - }, - "EXECUTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Executing" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Succeeded" - } - } - } - }, - "com.amazonaws.sagemaker#StopAutoMLJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopAutoMLJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "A method for forcing a running job to shut down.
" - } - }, - "com.amazonaws.sagemaker#StopAutoMLJobRequest": { - "type": "structure", - "members": { - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the object you are requesting.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopCompilationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopCompilationJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops a model compilation job.
\nTo stop a job, Amazon SageMaker AI sends the algorithm the SIGTERM signal. This gracefully shuts the\n job down. If the job hasn't stopped, it sends the SIGKILL signal.
\nWhen it receives a StopCompilationJob request, Amazon SageMaker AI changes the\n CompilationJobStatus of the job to Stopping. After Amazon\n SageMaker stops the job, it sets the CompilationJobStatus to\n Stopped.
The name of the model compilation job to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopEdgeDeploymentStage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopEdgeDeploymentStageRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Stops a stage in an edge deployment plan.
" - } - }, - "com.amazonaws.sagemaker#StopEdgeDeploymentStageRequest": { - "type": "structure", - "members": { - "EdgeDeploymentPlanName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge deployment plan to stop.
", - "smithy.api#required": {} - } - }, - "StageName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stage to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopEdgePackagingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopEdgePackagingJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Request to stop an edge packaging job.
" - } - }, - "com.amazonaws.sagemaker#StopEdgePackagingJobRequest": { - "type": "structure", - "members": { - "EdgePackagingJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the edge packaging job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopHyperParameterTuningJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopHyperParameterTuningJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops a running hyperparameter tuning job and all running training jobs that the\n tuning job launched.
\nAll model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All\n data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the\n tuning job moves to the Stopped state, it releases all\n reserved\n resources for the tuning job.
The name of the tuning job to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopInferenceExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopInferenceExperimentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#StopInferenceExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops an inference experiment.
" - } - }, - "com.amazonaws.sagemaker#StopInferenceExperimentRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#InferenceExperimentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference experiment to stop.
", - "smithy.api#required": {} - } - }, - "ModelVariantActions": { - "target": "com.amazonaws.sagemaker#ModelVariantActionMap", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:\n
\n\n Promote - Promote the shadow variant to a production variant
\n Remove - Delete the variant
\n Retain - Keep the variant as it is
\n An array of ModelVariantConfig objects. There is one for each variant that you want to deploy\n after the inference experiment stops. Each ModelVariantConfig describes the infrastructure\n configuration for deploying the corresponding variant.\n
\n The desired state of the experiment after stopping. The possible states are the following:\n
\n\n Completed: The experiment completed successfully
\n Cancelled: The experiment was canceled
The reason for stopping the experiment.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopInferenceExperimentResponse": { - "type": "structure", - "members": { - "InferenceExperimentArn": { - "target": "com.amazonaws.sagemaker#InferenceExperimentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the stopped inference experiment.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#StopInferenceRecommendationsJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopInferenceRecommendationsJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops an Inference Recommender job.
" - } - }, - "com.amazonaws.sagemaker#StopInferenceRecommendationsJobRequest": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.sagemaker#RecommendationJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the job you want to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopLabelingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopLabelingJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops a running labeling job. A job that is stopped cannot be restarted. Any results\n obtained before the job is stopped are placed in the Amazon S3 output bucket.
" - } - }, - "com.amazonaws.sagemaker#StopLabelingJobRequest": { - "type": "structure", - "members": { - "LabelingJobName": { - "target": "com.amazonaws.sagemaker#LabelingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the labeling job to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopMlflowTrackingServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Programmatically stop an MLflow Tracking Server.
" - } - }, - "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest": { - "type": "structure", - "members": { - "TrackingServerName": { - "target": "com.amazonaws.sagemaker#TrackingServerName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the tracking server to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse": { - "type": "structure", - "members": { - "TrackingServerArn": { - "target": "com.amazonaws.sagemaker#TrackingServerArn", - "traits": { - "smithy.api#documentation": "The ARN of the stopped tracking server.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#StopMonitoringSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopMonitoringScheduleRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops a previously started monitoring schedule.
" - } - }, - "com.amazonaws.sagemaker#StopMonitoringScheduleRequest": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the schedule to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopNotebookInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopNotebookInstanceInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the\n ML storage volume. SageMaker AI stops charging you for the ML compute instance when\n you call StopNotebookInstance.
To access data on the ML storage volume for a notebook instance that has been\n terminated, call the StartNotebookInstance API.\n StartNotebookInstance launches another ML compute instance, configures\n it, and attaches the preserved ML storage volume so you can continue your work.\n
The name of the notebook instance to terminate.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopOptimizationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopOptimizationJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Ends a running inference optimization job.
" - } - }, - "com.amazonaws.sagemaker#StopOptimizationJobRequest": { - "type": "structure", - "members": { - "OptimizationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name that you assigned to the optimization job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopPipelineExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopPipelineExecutionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#StopPipelineExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops a pipeline execution.
\n\n Callback Step\n
\nA pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".
You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.
Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
\n\n Lambda Step\n
\nA pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.
The Amazon Resource Name (ARN) of the pipeline execution.
", - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.sagemaker#IdempotencyToken", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopPipelineExecutionResponse": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#StopProcessingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopProcessingJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops a processing job.
" - } - }, - "com.amazonaws.sagemaker#StopProcessingJobRequest": { - "type": "structure", - "members": { - "ProcessingJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the processing job to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopTrainingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopTrainingJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops a training job. To stop a job, SageMaker sends the algorithm the\n SIGTERM signal, which delays job termination for 120 seconds.\n Algorithms might use this 120-second window to save the model artifacts, so the results\n of the training is not lost.
When it receives a StopTrainingJob request, SageMaker changes the status of\n the job to Stopping. After SageMaker stops the job, it sets the status to\n Stopped.
The name of the training job to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StopTransformJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#StopTransformJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Stops a batch transform job.
\nWhen Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a batch transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
The name of the batch transform job to stop.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#StoppingCondition": { - "type": "structure", - "members": { - "MaxRuntimeInSeconds": { - "target": "com.amazonaws.sagemaker#MaxRuntimeInSeconds", - "traits": { - "smithy.api#documentation": "The maximum length of time, in seconds, that a training or compilation job can run\n before it is stopped.
\nFor compilation jobs, if the job does not complete during this time, a\n TimeOut error is generated. We recommend starting with 900 seconds and\n increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job.\n When RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is\n 28 days.
The maximum time that a TrainingJob can run in total, including any time\n spent publishing metrics or archiving and uploading models after it has been stopped, is\n 30 days.
The maximum length of time, in seconds, that a managed Spot training job has to\n complete. It is the amount of time spent waiting for Spot capacity plus the amount of\n time the job can run. It must be equal to or greater than\n MaxRuntimeInSeconds. If the job does not complete during this time,\n SageMaker ends the job.
When RetryStrategy is specified in the job request,\n MaxWaitTimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt.
The maximum length of time, in seconds, that a training or compilation job can be\n pending before it is stopped.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker\n ends the job. Use this API to cap costs.
\nTo stop a training job, SageMaker sends the algorithm the SIGTERM signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.
\nThe Amazon Resource Name (ARN) of the Lifecycle Configuration.
" - } - }, - "StudioLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", - "traits": { - "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle\n Configurations are immutable.
" - } - }, - "StudioLifecycleConfigAppType": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", - "traits": { - "smithy.api#documentation": "The App type to which the Lifecycle Configuration is attached.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details of the Amazon SageMaker AI Studio Lifecycle Configuration.
" - } - }, - "com.amazonaws.sagemaker#StudioLifecycleConfigName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#StudioLifecycleConfigSortKey": { - "type": "enum", - "members": { - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "LastModifiedTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastModifiedTime" - } - }, - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.sagemaker#StudioLifecycleConfigsList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#StudioLifecycleConfigDetails" - } - }, - "com.amazonaws.sagemaker#StudioWebPortal": { - "type": "enum", - "members": { - "Enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "Disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.sagemaker#StudioWebPortalSettings": { - "type": "structure", - "members": { - "HiddenMlTools": { - "target": "com.amazonaws.sagemaker#HiddenMlToolsList", - "traits": { - "smithy.api#documentation": "The machine learning tools that are hidden from the Studio left navigation pane.
" - } - }, - "HiddenAppTypes": { - "target": "com.amazonaws.sagemaker#HiddenAppTypesList", - "traits": { - "smithy.api#documentation": "The Applications supported in Studio that are hidden from the Studio left navigation\n pane.
" - } - }, - "HiddenInstanceTypes": { - "target": "com.amazonaws.sagemaker#HiddenInstanceTypesList", - "traits": { - "smithy.api#documentation": "The instance types you are hiding from the Studio user interface.
" - } - }, - "HiddenSageMakerImageVersionAliases": { - "target": "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList", - "traits": { - "smithy.api#documentation": "The version aliases you are hiding from the Studio user interface.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.
" - } - }, - "com.amazonaws.sagemaker#SubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.sagemaker#Subnets": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#SubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.sagemaker#SubscribedWorkteam": { - "type": "structure", - "members": { - "WorkteamArn": { - "target": "com.amazonaws.sagemaker#WorkteamArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vendor that you have subscribed.
", - "smithy.api#required": {} - } - }, - "MarketplaceTitle": { - "target": "com.amazonaws.sagemaker#String200", - "traits": { - "smithy.api#documentation": "The title of the service provided by the vendor in the Amazon Marketplace.
" - } - }, - "SellerName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The name of the vendor in the Amazon Marketplace.
" - } - }, - "MarketplaceDescription": { - "target": "com.amazonaws.sagemaker#String200", - "traits": { - "smithy.api#documentation": "The description of the vendor from the Amazon Marketplace.
" - } - }, - "ListingId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "Marketplace product listing ID.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a work team of a vendor that does the labelling job.
" - } - }, - "com.amazonaws.sagemaker#SubscribedWorkteams": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#SubscribedWorkteam" - } - }, - "com.amazonaws.sagemaker#Success": { - "type": "boolean" - }, - "com.amazonaws.sagemaker#SuggestionQuery": { - "type": "structure", - "members": { - "PropertyNameQuery": { - "target": "com.amazonaws.sagemaker#PropertyNameQuery", - "traits": { - "smithy.api#documentation": "Defines a property name hint. Only property\n names that begin with the specified hint are included in the response.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specified in the GetSearchSuggestions request.\n Limits the property names that are included in the response.
" - } - }, - "com.amazonaws.sagemaker#SynthesizedJsonHumanLoopActivationConditions": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10240 - }, - "smithy.api#mediaType": "application/json" - } - }, - "com.amazonaws.sagemaker#TableFormat": { - "type": "enum", - "members": { - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Default" - } - }, - "GLUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Glue" - } - }, - "ICEBERG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Iceberg" - } - } - } - }, - "com.amazonaws.sagemaker#TableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" - } - }, - "com.amazonaws.sagemaker#TabularJobConfig": { - "type": "structure", - "members": { - "CandidateGenerationConfig": { - "target": "com.amazonaws.sagemaker#CandidateGenerationConfig", - "traits": { - "smithy.api#documentation": "The configuration information of how model candidates are generated.
" - } - }, - "CompletionCriteria": { - "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" - }, - "FeatureSpecificationS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job V2. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
These column keys may not include the target column.
\nIn ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.
If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.
Generates possible candidates without training the models. A model candidate is a\n combination of data preprocessors, algorithms, and algorithm parameter settings.
" - } - }, - "ProblemType": { - "target": "com.amazonaws.sagemaker#ProblemType", - "traits": { - "smithy.api#documentation": "The type of supervised learning problem available for the model candidates of the AutoML\n job V2. For more information, see \n SageMaker Autopilot problem types.
\nYou must either specify the type of supervised learning problem in\n ProblemType and provide the AutoMLJobObjective metric, or none at all.
The name of the target variable in supervised learning, usually represented by\n 'y'.
", - "smithy.api#required": {} - } - }, - "SampleWeightAttributeName": { - "target": "com.amazonaws.sagemaker#SampleWeightAttributeName", - "traits": { - "smithy.api#documentation": "If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.
\nSample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.
\nSupport for sample weights is available in Ensembling\n mode only.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the tabular problem type.
" - } - }, - "com.amazonaws.sagemaker#TabularResolvedAttributes": { - "type": "structure", - "members": { - "ProblemType": { - "target": "com.amazonaws.sagemaker#ProblemType", - "traits": { - "smithy.api#documentation": "The type of supervised learning problem available for the model candidates of the AutoML\n job V2 (Binary Classification, Multiclass Classification, Regression). For more\n information, see \n SageMaker Autopilot problem types.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The resolved attributes specific to the tabular problem type.
" - } - }, - "com.amazonaws.sagemaker#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.sagemaker#TagKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The tag key. Tag keys must be unique per resource.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#TagValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The tag value.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A tag object that consists of a key and an optional value, used to manage metadata\n for SageMaker Amazon Web Services resources.
\nYou can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to SageMaker resources, see AddTags.
\nFor more information on adding metadata to your Amazon Web Services resources with\n tagging, see Tagging Amazon Web Services resources. For advice on best practices for\n managing Amazon Web Services resources with tagging, see Tagging\n Best Practices: Implement an Effective Amazon Web Services Resource Tagging\n Strategy.
" - } - }, - "com.amazonaws.sagemaker#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.sagemaker#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.sagemaker#TagPropagation": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.sagemaker#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.sagemaker#TargetAttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#TargetDevice": { - "type": "enum", - "members": { - "LAMBDA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lambda" - } - }, - "ML_M4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_m4" - } - }, - "ML_M5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_m5" - } - }, - "ML_M6G": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_m6g" - } - }, - "ML_C4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_c4" - } - }, - "ML_C5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_c5" - } - }, - "ML_C6G": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_c6g" - } - }, - "ML_P2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_p2" - } - }, - "ML_P3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_p3" - } - }, - "ML_G4DN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_g4dn" - } - }, - "ML_INF1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_inf1" - } - }, - "ML_INF2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_inf2" - } - }, - "ML_TRN1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_trn1" - } - }, - "ML_EIA2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml_eia2" - } - }, - "JETSON_TX1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "jetson_tx1" - } - }, - "JETSON_TX2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "jetson_tx2" - } - }, - "JETSON_NANO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "jetson_nano" - } - }, - "JETSON_XAVIER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "jetson_xavier" - } - }, - "RASP3B": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rasp3b" - } - }, - "RASP4B": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rasp4b" - } - }, - "IMX8QM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "imx8qm" - } - }, - "DEEPLENS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deeplens" - } - }, - "RK3399": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rk3399" - } - }, - "RK3288": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rk3288" - } - }, - "AISAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aisage" - } - }, - "SBE_C": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sbe_c" - } - }, - "QCS605": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "qcs605" - } - }, - "QCS603": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "qcs603" - } - }, - "SITARA_AM57X": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sitara_am57x" - } - }, - "AMBA_CV2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amba_cv2" - } - }, - "AMBA_CV22": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amba_cv22" - } - }, - "AMBA_CV25": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amba_cv25" - } - }, - "X86_WIN32": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x86_win32" - } - }, - "X86_WIN64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x86_win64" - } - }, - "COREML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "coreml" - } - }, - "JACINTO_TDA4VM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "jacinto_tda4vm" - } - }, - "IMX8MPLUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "imx8mplus" - } - } - } - }, - "com.amazonaws.sagemaker#TargetLabelColumn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#TargetObjectiveMetricValue": { - "type": "float" - }, - "com.amazonaws.sagemaker#TargetPlatform": { - "type": "structure", - "members": { - "Os": { - "target": "com.amazonaws.sagemaker#TargetPlatformOs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a target platform OS.
\n\n LINUX: Linux-based operating systems.
\n ANDROID: Android operating systems. Android API level can be\n specified using the ANDROID_PLATFORM compiler option. For example,\n \"CompilerOptions\": {'ANDROID_PLATFORM': 28}\n
Specifies a target platform architecture.
\n\n X86_64: 64-bit version of the x86 instruction set.
\n X86: 32-bit version of the x86 instruction set.
\n ARM64: ARMv8 64-bit CPU.
\n ARM_EABIHF: ARMv7 32-bit, Hard Float.
\n ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM\n platform.
Specifies a target platform accelerator (optional).
\n\n NVIDIA: Nvidia graphics processing unit. It also requires\n gpu-code, trt-ver, cuda-ver compiler\n options
\n MALI: ARM Mali graphics processor
\n INTEL_GRAPHICS: Integrated Intel graphics
Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.
An object containing information about a metric.
" - } - }, - "TargetValue": { - "target": "com.amazonaws.sagemaker#Double", - "traits": { - "smithy.api#documentation": "The recommended target value to specify for the metric when creating a scaling policy.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A target tracking scaling policy. Includes support for predefined or customized metrics.
\nWhen using the PutScalingPolicy API,\n this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker AI\n image created on the instance.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The TensorBoard app settings.
" - } - }, - "com.amazonaws.sagemaker#TensorBoardOutputConfig": { - "type": "structure", - "members": { - "LocalPath": { - "target": "com.amazonaws.sagemaker#DirectoryPath", - "traits": { - "smithy.api#documentation": "Path to local storage location for tensorBoard output. Defaults to\n /opt/ml/output/tensorboard.
Path to Amazon S3 storage location for TensorBoard output.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
" - } - }, - "com.amazonaws.sagemaker#TenthFractionsOfACent": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 9 - } - } - }, - "com.amazonaws.sagemaker#TerminationWaitInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 3600 - } - } - }, - "com.amazonaws.sagemaker#TextClassificationJobConfig": { - "type": "structure", - "members": { - "CompletionCriteria": { - "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", - "traits": { - "smithy.api#documentation": "How long a job is allowed to run, or how many candidates a job is allowed to\n generate.
" - } - }, - "ContentColumn": { - "target": "com.amazonaws.sagemaker#ContentColumn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column used to provide the sentences to be classified. It should not be\n the same as the target column.
", - "smithy.api#required": {} - } - }, - "TargetLabelColumn": { - "target": "com.amazonaws.sagemaker#TargetLabelColumn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column used to provide the class labels. It should not be same as the\n content column.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the text classification problem\n type.
" - } - }, - "com.amazonaws.sagemaker#TextGenerationHyperParameterKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" - } - }, - "com.amazonaws.sagemaker#TextGenerationHyperParameterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 16 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" - } - }, - "com.amazonaws.sagemaker#TextGenerationHyperParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.sagemaker#TextGenerationJobConfig": { - "type": "structure", - "members": { - "CompletionCriteria": { - "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", - "traits": { - "smithy.api#documentation": "How long a fine-tuning job is allowed to run. For TextGenerationJobConfig\n problem types, the MaxRuntimePerTrainingJobInSeconds attribute of\n AutoMLJobCompletionCriteria defaults to 72h (259200s).
The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon7BInstruct.
The hyperparameters used to configure and optimize the learning process of the base\n model. You can set any combination of the following hyperparameters for all base models.\n For more information on each supported hyperparameter, see Optimize\n the learning process of your text generation models with hyperparameters.
\n\n \"epochCount\": The number of times the model goes through the entire\n training dataset. Its value should be a string containing an integer value within the\n range of \"1\" to \"10\".
\n \"batchSize\": The number of data samples used in each iteration of\n training. Its value should be a string containing an integer value within the range\n of \"1\" to \"64\".
\n \"learningRate\": The step size at which a model's parameters are\n updated during training. Its value should be a string containing a floating-point\n value within the range of \"0\" to \"1\".
\n \"learningRateWarmupSteps\": The number of training steps during which\n the learning rate gradually increases before reaching its target or maximum value.\n Its value should be a string containing an integer value within the range of \"0\" to\n \"250\".
Here is an example where all four hyperparameters are configured.
\n\n { \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\",\n \"learningRateWarmupSteps\": \"10\" }\n
The collection of settings used by an AutoML job V2 for the text generation problem\n type.
\nThe text generation models that support fine-tuning in Autopilot are currently accessible\n exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported\n Regions.
\nThe name of the base model to fine-tune.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The resolved attributes specific to the text generation problem type.
" - } - }, - "com.amazonaws.sagemaker#ThingName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" - } - }, - "com.amazonaws.sagemaker#ThroughputConfig": { - "type": "structure", - "members": { - "ThroughputMode": { - "target": "com.amazonaws.sagemaker#ThroughputMode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The mode used for your feature group throughput: ON_DEMAND or\n PROVISIONED.
For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" - } - }, - "ProvisionedWriteCapacityUnits": { - "target": "com.amazonaws.sagemaker#CapacityUnit", - "traits": { - "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Used to set feature group throughput configuration. There are two modes:\n ON_DEMAND and PROVISIONED. With on-demand mode, you are\n charged for data reads and writes that your application performs on your feature group. You\n do not need to specify read and write throughput because Feature Store accommodates your\n workloads as they ramp up and down. You can switch a feature group to on-demand only once\n in a 24 hour period. With provisioned throughput mode, you specify the read and write\n capacity per second that you expect your application to require, and you are billed based\n on those limits. Exceeding provisioned throughput will result in your requests being\n throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that\n are offline-only, or use the \n Standard\n tier online store.
The mode used for your feature group throughput: ON_DEMAND or\n PROVISIONED.
For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" - } - }, - "ProvisionedWriteCapacityUnits": { - "target": "com.amazonaws.sagemaker#CapacityUnit", - "traits": { - "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Active throughput configuration of the feature group. There are two modes:\n ON_DEMAND and PROVISIONED. With on-demand mode, you are\n charged for data reads and writes that your application performs on your feature group. You\n do not need to specify read and write throughput because Feature Store accommodates your\n workloads as they ramp up and down. You can switch a feature group to on-demand only once\n in a 24 hour period. With provisioned throughput mode, you specify the read and write\n capacity per second that you expect your application to require, and you are billed based\n on those limits. Exceeding provisioned throughput will result in your requests being\n throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that\n are offline-only, or use the \n Standard\n tier online store.
Target throughput mode of the feature group. Throughput update is an asynchronous\n operation, and the outcome should be monitored by polling LastUpdateStatus\n field in DescribeFeatureGroup response. You cannot update a feature group's\n throughput while another update is in progress.
For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.
" - } - }, - "ProvisionedWriteCapacityUnits": { - "target": "com.amazonaws.sagemaker#CapacityUnit", - "traits": { - "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The new throughput configuration for the feature group. You can switch between on-demand\n and provisioned modes or update the read / write capacity of provisioned feature groups.\n You can switch a feature group to on-demand only once in a 24 hour period.
" - } - }, - "com.amazonaws.sagemaker#ThroughputMode": { - "type": "enum", - "members": { - "ON_DEMAND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OnDemand" - } - }, - "PROVISIONED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Provisioned" - } - } - } - }, - "com.amazonaws.sagemaker#TimeSeriesConfig": { - "type": "structure", - "members": { - "TargetAttributeName": { - "target": "com.amazonaws.sagemaker#TargetAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column representing the target variable that you want to predict for\n each item in your dataset. The data type of the target variable must be numerical.
", - "smithy.api#required": {} - } - }, - "TimestampAttributeName": { - "target": "com.amazonaws.sagemaker#TimestampAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column indicating a point in time at which the target value of a given\n item is recorded.
", - "smithy.api#required": {} - } - }, - "ItemIdentifierAttributeName": { - "target": "com.amazonaws.sagemaker#ItemIdentifierAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column that represents the set of item identifiers for which you want to\n predict the target value.
", - "smithy.api#required": {} - } - }, - "GroupingAttributeNames": { - "target": "com.amazonaws.sagemaker#GroupingAttributeNames", - "traits": { - "smithy.api#documentation": "A set of columns names that can be grouped with the item identifier column to create a\n composite key for which a target value is predicted.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The collection of components that defines the time-series.
" - } - }, - "com.amazonaws.sagemaker#TimeSeriesForecastingJobConfig": { - "type": "structure", - "members": { - "FeatureSpecificationS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "A URL to the Amazon S3 data source containing additional selected features that\n complement the target, itemID, timestamp, and grouped columns set in\n TimeSeriesConfig. When not provided, the AutoML job V2 includes all the\n columns from the original dataset that are not already declared in\n TimeSeriesConfig. If provided, the AutoML job V2 only considers these\n additional columns as a complement to the ones declared in\n TimeSeriesConfig.
You can input FeatureAttributeNames (optional) in JSON format as shown\n below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
Autopilot supports the following data types: numeric, categorical,\n text, and datetime.
These column keys must not include any column set in\n TimeSeriesConfig.
The frequency of predictions in a forecast.
\nValid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H\n (Hour), and min (Minute). For example, 1D indicates every day and\n 15min indicates every 15 minutes. The value of a frequency must not overlap\n with the next larger frequency. For example, you must use a frequency of 1H\n instead of 60min.
The valid values for each frequency are the following:
\nMinute - 1-59
\nHour - 1-23
\nDay - 1-6
\nWeek - 1-4
\nMonth - 1-11
\nYear - 1
\nThe number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4\n of the time-steps in the dataset.
", - "smithy.api#required": {} - } - }, - "ForecastQuantiles": { - "target": "com.amazonaws.sagemaker#ForecastQuantiles", - "traits": { - "smithy.api#documentation": "The quantiles used to train the model for forecasts at a specified quantile. You can\n specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of\n 0.01 or higher. Up to five forecast quantiles can be specified. When\n ForecastQuantiles is not provided, the AutoML job uses the quantiles p10,\n p50, and p90 as default.
The transformations modifying specific attributes of the time-series, such as filling\n strategies for missing values.
" - } - }, - "TimeSeriesConfig": { - "target": "com.amazonaws.sagemaker#TimeSeriesConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The collection of components that defines the time-series.
", - "smithy.api#required": {} - } - }, - "HolidayConfig": { - "target": "com.amazonaws.sagemaker#HolidayConfig", - "traits": { - "smithy.api#documentation": "The collection of holiday featurization attributes used to incorporate national holiday\n information into your forecasting model.
" - } - }, - "CandidateGenerationConfig": { - "target": "com.amazonaws.sagemaker#CandidateGenerationConfig" - } - }, - "traits": { - "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the time-series forecasting\n problem type.
" - } - }, - "com.amazonaws.sagemaker#TimeSeriesForecastingSettings": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#FeatureStatus", - "traits": { - "smithy.api#documentation": "Describes whether time series forecasting is enabled or disabled in the Canvas\n application.
" - } - }, - "AmazonForecastRoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default,\n Canvas uses the execution role specified in the UserProfile that launches the\n Canvas application. If an execution role is not specified in the UserProfile,\n Canvas uses the execution role specified in the Domain that owns the\n UserProfile. To allow time series forecasting, this IAM role should have the\n AmazonSageMakerCanvasForecastAccess policy attached and\n forecast.amazonaws.com added in the trust relationship as a service\n principal.
Time series forecast settings for the SageMaker Canvas application.
" - } - }, - "com.amazonaws.sagemaker#TimeSeriesTransformations": { - "type": "structure", - "members": { - "Filling": { - "target": "com.amazonaws.sagemaker#FillingTransformations", - "traits": { - "smithy.api#documentation": "A key value pair defining the filling method for a column, where the key is the column\n name and the value is an object which defines the filling logic. You can specify multiple\n filling methods for a single column.
\nThe supported filling methods and their corresponding options are:
\n\n frontfill: none (Supported only for target\n column)
\n middlefill: zero, value,\n median, mean, min, max\n
\n backfill: zero, value, median,\n mean, min, max\n
\n futurefill: zero, value,\n median, mean, min, max\n
To set a filling method to a specific value, set the fill parameter to the chosen\n filling method value (for example \"backfill\" : \"value\"), and define the\n filling value in an additional parameter prefixed with \"_value\". For example, to set\n backfill to a value of 2, you must include two parameters:\n \"backfill\": \"value\" and \"backfill_value\":\"2\".
A key value pair defining the aggregation method for a column, where the key is the\n column name and the value is the aggregation method.
\nThe supported aggregation methods are sum (default), avg,\n first, min, max.
Aggregation is only supported for the target column.
\nTransformations allowed on the dataset. Supported transformations are\n Filling and Aggregation. Filling specifies how to\n add values to missing values in the dataset. Aggregation defines how to\n aggregate data that does not align with forecast frequency.
The ARN of a listed tracking server.
" - } - }, - "TrackingServerName": { - "target": "com.amazonaws.sagemaker#TrackingServerName", - "traits": { - "smithy.api#documentation": "The name of a listed tracking server.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of a listed tracking server.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The last modified time of a listed tracking server.
" - } - }, - "TrackingServerStatus": { - "target": "com.amazonaws.sagemaker#TrackingServerStatus", - "traits": { - "smithy.api#documentation": "The creation status of a listed tracking server.
" - } - }, - "IsActive": { - "target": "com.amazonaws.sagemaker#IsTrackingServerActive", - "traits": { - "smithy.api#documentation": "The activity status of a listed tracking server.
" - } - }, - "MlflowVersion": { - "target": "com.amazonaws.sagemaker#MlflowVersion", - "traits": { - "smithy.api#documentation": "The MLflow version used for a listed tracking server.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The summary of the tracking server to list.
" - } - }, - "com.amazonaws.sagemaker#TrackingServerSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrackingServerSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#TrackingServerUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - } - } - }, - "com.amazonaws.sagemaker#TrafficDurationInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#TrafficPattern": { - "type": "structure", - "members": { - "TrafficType": { - "target": "com.amazonaws.sagemaker#TrafficType", - "traits": { - "smithy.api#documentation": "Defines the traffic patterns. Choose either PHASES or STAIRS.
Defines the phases traffic specification.
" - } - }, - "Stairs": { - "target": "com.amazonaws.sagemaker#Stairs", - "traits": { - "smithy.api#documentation": "Defines the stairs traffic pattern.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the traffic pattern of the load test.
" - } - }, - "com.amazonaws.sagemaker#TrafficRoutingConfig": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.sagemaker#TrafficRoutingConfigType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Traffic routing strategy type.
\n\n ALL_AT_ONCE: Endpoint traffic shifts to the new fleet\n in a single step.\n
\n CANARY: Endpoint traffic shifts to the new fleet\n in two steps. The first step is the canary, which is a small portion of the traffic. The\n second step is the remainder of the traffic.\n
\n LINEAR: Endpoint traffic shifts to the new fleet in\n n steps of a configurable size.\n
The waiting time (in seconds) between incremental steps to turn on traffic on the\n new endpoint fleet.
", - "smithy.api#required": {} - } - }, - "CanarySize": { - "target": "com.amazonaws.sagemaker#CapacitySize", - "traits": { - "smithy.api#documentation": "Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than\n or equal to 50% of the variant's total instance count.
Batch size for each step to turn on traffic on the new endpoint fleet. Value must be\n 10-50% of the variant's total instance count.
Defines the traffic routing strategy during an endpoint deployment to shift traffic from the\n old fleet to the new fleet.
" - } - }, - "com.amazonaws.sagemaker#TrafficRoutingConfigType": { - "type": "enum", - "members": { - "ALL_AT_ONCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_AT_ONCE" - } - }, - "CANARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANARY" - } - }, - "LINEAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINEAR" - } - } - } - }, - "com.amazonaws.sagemaker#TrafficType": { - "type": "enum", - "members": { - "PHASES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PHASES" - } - }, - "STAIRS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STAIRS" - } - } - } - }, - "com.amazonaws.sagemaker#TrainingContainerArgument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#TrainingContainerArguments": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrainingContainerArgument" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#TrainingContainerEntrypoint": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrainingContainerEntrypointString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#TrainingContainerEntrypointString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#TrainingEnvironmentKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" - } - }, - "com.amazonaws.sagemaker#TrainingEnvironmentMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#TrainingEnvironmentKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#TrainingEnvironmentValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#TrainingEnvironmentValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\S\\s]*$" - } - }, - "com.amazonaws.sagemaker#TrainingImageConfig": { - "type": "structure", - "members": { - "TrainingRepositoryAccessMode": { - "target": "com.amazonaws.sagemaker#TrainingRepositoryAccessMode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The method that your training job will use to gain access to the images in your\n private Docker registry. For access to an image in a private Docker registry, set to\n Vpc.
An object containing authentication information for a private Docker registry\n containing your training images.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration to use an image from a private Docker registry for a training\n job.
" - } - }, - "com.amazonaws.sagemaker#TrainingInputMode": { - "type": "enum", - "members": { - "PIPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pipe" - } - }, - "FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "File" - } - }, - "FASTFILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FastFile" - } - } - }, - "traits": { - "smithy.api#documentation": "The training input mode that the algorithm supports. For more information about input\n modes, see Algorithms.
\n\n Pipe mode\n
\nIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly from\n Amazon S3 to the container.
\n File mode\n
\nIf an algorithm supports File mode, SageMaker downloads the training data from\n S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume\n for the training container.
You must provision the ML storage volume with sufficient capacity to accommodate the\n data downloaded from S3. In addition to the training data, the ML storage volume also\n stores the output model. The algorithm container uses the ML storage volume to also\n store intermediate information, if any.
\nFor distributed algorithms, training data is distributed uniformly. Your training\n duration is predictable if the input data objects sizes are approximately the same. SageMaker\n does not split the files any further for model training. If the object sizes are skewed,\n training won't be optimal as the data distribution is also skewed when one host in a\n training cluster is overloaded, thus becoming a bottleneck in training.
\n\n FastFile mode\n
\nIf an algorithm supports FastFile mode, SageMaker streams data directly from\n S3 to the container with no code changes, and provides file system access to the data.\n Users can author their training script to interact with these files as if they were\n stored on disk.
\n FastFile mode works best when the data is read sequentially. Augmented\n manifest files aren't supported. The startup time is lower when there are fewer files in\n the S3 bucket provided.
The name of the training job.
" - } - }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
" - } - }, - "TuningJobArn": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.
" - } - }, - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the labeling job.
" - } - }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
" - } - }, - "ModelArtifacts": { - "target": "com.amazonaws.sagemaker#ModelArtifacts", - "traits": { - "smithy.api#documentation": "Information about the Amazon S3 location that is configured for storing model\n artifacts.
" - } - }, - "TrainingJobStatus": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", - "traits": { - "smithy.api#documentation": "The status of the\n training\n job.
\nTraining job statuses are:
\n\n InProgress - The training is in progress.
\n Completed - The training job has completed.
\n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.
\n Stopping - The training job is stopping.
\n Stopped - The training job has stopped.
For\n more detailed information, see SecondaryStatus.
Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of\n them:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTrainingStack\n
\n DownloadingTrainingImage\n
If the training job failed, the reason it failed.
" - } - }, - "HyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", - "traits": { - "smithy.api#documentation": "Algorithm-specific parameters.
" - } - }, - "AlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#AlgorithmSpecification", - "traits": { - "smithy.api#documentation": "Information about the algorithm used for training, and algorithm metadata.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Identity and Access Management (IAM) role configured for the\n training job.
" - } - }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#InputDataConfig", - "traits": { - "smithy.api#documentation": "An array of Channel objects that describes each data input\n channel.
Your input must be in the same Amazon Web Services region as your training job.
" - } - }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#OutputDataConfig", - "traits": { - "smithy.api#documentation": "The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.
" - } - }, - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfig", - "traits": { - "smithy.api#documentation": "Resources, including ML compute instances and ML storage volumes, that are configured\n for model training.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", - "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", - "traits": { - "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.
A timestamp that indicates when the training job was created.
" - } - }, - "TrainingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time when the training job starts on training instances. You are billed\n for the time interval between this time and the value of TrainingEndTime.\n The start time in CloudWatch Logs might be later than this time. The difference is due to the time\n it takes to download the training data and to the size of the training container.
Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
A timestamp that indicates when the status of the training job was last\n modified.
" - } - }, - "SecondaryStatusTransitions": { - "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", - "traits": { - "smithy.api#documentation": "A history of all of the secondary statuses that the training job has transitioned\n through.
" - } - }, - "FinalMetricDataList": { - "target": "com.amazonaws.sagemaker#FinalMetricDataList", - "traits": { - "smithy.api#documentation": "A list of final metric values that are set when the training job completes. Used only\n if the training job was configured to use metrics.
" - } - }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "If the TrainingJob was created with network isolation, the value is set\n to true. If network isolation is enabled, nodes can't communicate beyond\n the VPC they run in.
To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.
When true, enables managed spot training using Amazon EC2 Spot instances to run\n training jobs instead of on-demand instances. For more information, see Managed Spot Training.
" - } - }, - "CheckpointConfig": { - "target": "com.amazonaws.sagemaker#CheckpointConfig" - }, - "TrainingTimeInSeconds": { - "target": "com.amazonaws.sagemaker#TrainingTimeInSeconds", - "traits": { - "smithy.api#documentation": "The training time in seconds.
" - } - }, - "BillableTimeInSeconds": { - "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", - "traits": { - "smithy.api#documentation": "The billable time in seconds.
" - } - }, - "DebugHookConfig": { - "target": "com.amazonaws.sagemaker#DebugHookConfig" - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - }, - "DebugRuleConfigurations": { - "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", - "traits": { - "smithy.api#documentation": "Information about the debug rule configuration.
" - } - }, - "TensorBoardOutputConfig": { - "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" - }, - "DebugRuleEvaluationStatuses": { - "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", - "traits": { - "smithy.api#documentation": "Information about the evaluation status of the rules for the training job.
" - } - }, - "ProfilerConfig": { - "target": "com.amazonaws.sagemaker#ProfilerConfig" - }, - "Environment": { - "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container.
" - } - }, - "RetryStrategy": { - "target": "com.amazonaws.sagemaker#RetryStrategy", - "traits": { - "smithy.api#documentation": "The number of times to retry the job when the job fails due to an\n InternalServerError.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a training job.
" - } - }, - "com.amazonaws.sagemaker#TrainingJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/" - } - }, - "com.amazonaws.sagemaker#TrainingJobDefinition": { - "type": "structure", - "members": { - "TrainingInputMode": { - "target": "com.amazonaws.sagemaker#TrainingInputMode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "HyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", - "traits": { - "smithy.api#documentation": "The hyperparameters used for the training job.
" - } - }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#InputDataConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of Channel objects, each of which specifies an input\n source.
the path to the S3 bucket where you want to store model artifacts. SageMaker creates\n subfolders for the artifacts.
", - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The resources, including the ML compute instances and ML storage volumes, to use for\n model training.
", - "smithy.api#required": {} - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job\n termination for 120 seconds. Algorithms can use this 120-second window to save the model\n artifacts.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the input needed to run a training job using the algorithm.
" - } - }, - "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType": { - "type": "enum", - "members": { - "OFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Off" - } - }, - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Auto" - } - } - } - }, - "com.amazonaws.sagemaker#TrainingJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#TrainingJobSortByOptions": { - "type": "enum", - "members": { - "Name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "Status": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Status" - } - }, - "FinalObjectiveMetricValue": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FinalObjectiveMetricValue" - } - } - } - }, - "com.amazonaws.sagemaker#TrainingJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#TrainingJobStatusCounter": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.sagemaker#TrainingJobStatusCounters": { - "type": "structure", - "members": { - "Completed": { - "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", - "traits": { - "smithy.api#documentation": "The number of completed training jobs launched by the hyperparameter tuning\n job.
" - } - }, - "InProgress": { - "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", - "traits": { - "smithy.api#documentation": "The number of in-progress training jobs launched by a hyperparameter tuning\n job.
" - } - }, - "RetryableError": { - "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", - "traits": { - "smithy.api#documentation": "The number of training jobs that failed, but can be retried. A failed training job can\n be retried only if it failed because an internal service error occurred.
" - } - }, - "NonRetryableError": { - "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", - "traits": { - "smithy.api#documentation": "The number of training jobs that failed and can't be retried. A failed training job\n can't be retried if it failed because a client error occurred.
" - } - }, - "Stopped": { - "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", - "traits": { - "smithy.api#documentation": "The number of training jobs launched by a hyperparameter tuning job that were\n manually\n stopped.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The numbers of training jobs launched by a hyperparameter tuning job, categorized by\n status.
" - } - }, - "com.amazonaws.sagemaker#TrainingJobStepMetadata": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job that was run by this step execution.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for a training job step.
" - } - }, - "com.amazonaws.sagemaker#TrainingJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrainingJobSummary" - } - }, - "com.amazonaws.sagemaker#TrainingJobSummary": { - "type": "structure", - "members": { - "TrainingJobName": { - "target": "com.amazonaws.sagemaker#TrainingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the training job that you want a summary for.
", - "smithy.api#required": {} - } - }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the training job was created.
", - "smithy.api#required": {} - } - }, - "TrainingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the training job ended. This field is set only if the\n training job has one of the terminal statuses (Completed,\n Failed, or Stopped).
Timestamp when the training job was last modified.
" - } - }, - "TrainingJobStatus": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the training job.
", - "smithy.api#required": {} - } - }, - "SecondaryStatus": { - "target": "com.amazonaws.sagemaker#SecondaryStatus", - "traits": { - "smithy.api#documentation": "The secondary status of the training job.
" - } - }, - "WarmPoolStatus": { - "target": "com.amazonaws.sagemaker#WarmPoolStatus", - "traits": { - "smithy.api#documentation": "The status of the warm pool associated with the training job.
" - } - }, - "TrainingPlanArn": { - "target": "com.amazonaws.sagemaker#TrainingPlanArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan associated with this training job.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Provides summary information about a training job.
" - } - }, - "com.amazonaws.sagemaker#TrainingPlanArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 50, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-plan/" - } - }, - "com.amazonaws.sagemaker#TrainingPlanArns": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrainingPlanArn" - } - }, - "com.amazonaws.sagemaker#TrainingPlanDurationHours": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 87600 - } - } - }, - "com.amazonaws.sagemaker#TrainingPlanDurationHoursInput": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 87600 - } - } - }, - "com.amazonaws.sagemaker#TrainingPlanDurationMinutes": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 59 - } - } - }, - "com.amazonaws.sagemaker#TrainingPlanFilter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.sagemaker#TrainingPlanFilterName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the filter field (e.g., Status, InstanceType).
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#String64", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The value to filter by for the specified field.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A filter to apply when listing or searching for training plans.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The unique identifier for this training plan offering.
", - "smithy.api#required": {} - } - }, - "TargetResources": { - "target": "com.amazonaws.sagemaker#SageMakerResourceNames", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan\n offering.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe requested start time that the user specified when searching for the training plan\n offering.
" - } - }, - "RequestedEndTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The requested end time that the user specified when searching for the training plan\n offering.
" - } - }, - "DurationHours": { - "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", - "traits": { - "smithy.api#documentation": "The number of whole hours in the total duration for this training plan offering.
" - } - }, - "DurationMinutes": { - "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", - "traits": { - "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training plan\n offering.
" - } - }, - "UpfrontFee": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The upfront fee for this training plan offering.
" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.sagemaker#CurrencyCode", - "traits": { - "smithy.api#documentation": "The currency code for the upfront fee (e.g., USD).
" - } - }, - "ReservedCapacityOfferings": { - "target": "com.amazonaws.sagemaker#ReservedCapacityOfferings", - "traits": { - "smithy.api#documentation": "A list of reserved capacity offerings associated with this training plan\n offering.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about a training plan offering.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the training plan.
", - "smithy.api#required": {} - } - }, - "TrainingPlanName": { - "target": "com.amazonaws.sagemaker#TrainingPlanName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the training plan.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#TrainingPlanStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.
A message providing additional information about the current status of the training\n plan.
" - } - }, - "DurationHours": { - "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", - "traits": { - "smithy.api#documentation": "The number of whole hours in the total duration for this training plan.
" - } - }, - "DurationMinutes": { - "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", - "traits": { - "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training\n plan.
" - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The start time of the training plan.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The end time of the training plan.
" - } - }, - "UpfrontFee": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "The upfront fee for the training plan.
" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.sagemaker#CurrencyCode", - "traits": { - "smithy.api#documentation": "The currency code for the upfront fee (e.g., USD).
" - } - }, - "TotalInstanceCount": { - "target": "com.amazonaws.sagemaker#TotalInstanceCount", - "traits": { - "smithy.api#documentation": "The total number of instances reserved in this training plan.
" - } - }, - "AvailableInstanceCount": { - "target": "com.amazonaws.sagemaker#AvailableInstanceCount", - "traits": { - "smithy.api#documentation": "The number of instances currently available for use in this training plan.
" - } - }, - "InUseInstanceCount": { - "target": "com.amazonaws.sagemaker#InUseInstanceCount", - "traits": { - "smithy.api#documentation": "The number of instances currently in use from this training plan.
" - } - }, - "TargetResources": { - "target": "com.amazonaws.sagemaker#SageMakerResourceNames", - "traits": { - "smithy.api#documentation": "The target resources (e.g., training jobs, HyperPod clusters) that can use this training\n plan.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nA list of reserved capacities associated with this training plan, including details such\n as instance types, counts, and availability zones.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details of the training plan.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access\n credentials to your private Docker registry.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "An object containing authentication information for a private Docker registry.
" - } - }, - "com.amazonaws.sagemaker#TrainingRepositoryCredentialsProviderArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:" - } - }, - "com.amazonaws.sagemaker#TrainingSpecification": { - "type": "structure", - "members": { - "TrainingImage": { - "target": "com.amazonaws.sagemaker#ContainerImage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon ECR registry path of the Docker image that contains the training\n algorithm.
", - "smithy.api#required": {} - } - }, - "TrainingImageDigest": { - "target": "com.amazonaws.sagemaker#ImageDigest", - "traits": { - "smithy.api#documentation": "An MD5 hash of the training algorithm that identifies the Docker image used for\n training.
" - } - }, - "SupportedHyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameterSpecifications", - "traits": { - "smithy.api#documentation": "A list of the HyperParameterSpecification objects, that define the\n supported hyperparameters. This is required if the algorithm supports automatic model\n tuning.>
A list of the instance types that this algorithm can use for training.
", - "smithy.api#required": {} - } - }, - "SupportsDistributedTraining": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether the algorithm supports distributed training. If set to false, buyers\n can't request more than one instance during training.
" - } - }, - "MetricDefinitions": { - "target": "com.amazonaws.sagemaker#MetricDefinitionList", - "traits": { - "smithy.api#documentation": "A list of MetricDefinition objects, which are used for parsing metrics\n generated by the algorithm.
A list of ChannelSpecification objects, which specify the input sources\n to be used by the algorithm.
A list of the metrics that the algorithm emits that can be used as the objective\n metric in a hyperparameter tuning job.
" - } - }, - "AdditionalS3DataSource": { - "target": "com.amazonaws.sagemaker#AdditionalS3DataSource", - "traits": { - "smithy.api#documentation": "The additional data source used during the training job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines how the algorithm is used for a training job.
" - } - }, - "com.amazonaws.sagemaker#TrainingTimeInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#TransformDataSource": { - "type": "structure", - "members": { - "S3DataSource": { - "target": "com.amazonaws.sagemaker#TransformS3DataSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The S3 location of the data source that is associated with a channel.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the location of the channel data.
" - } - }, - "com.amazonaws.sagemaker#TransformEnvironmentKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]{0,1023}$" - } - }, - "com.amazonaws.sagemaker#TransformEnvironmentMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#TransformEnvironmentKey" - }, - "value": { - "target": "com.amazonaws.sagemaker#TransformEnvironmentValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 16 - } - } - }, - "com.amazonaws.sagemaker#TransformEnvironmentValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10240 - }, - "smithy.api#pattern": "^[\\S\\s]*$" - } - }, - "com.amazonaws.sagemaker#TransformInput": { - "type": "structure", - "members": { - "DataSource": { - "target": "com.amazonaws.sagemaker#TransformDataSource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the location of\n the\n channel data, which is, the S3 location of the input data that the\n model can consume.
", - "smithy.api#required": {} - } - }, - "ContentType": { - "target": "com.amazonaws.sagemaker#ContentType", - "traits": { - "smithy.api#documentation": "The multipurpose internet mail extension\n (MIME)\n type of the data. Amazon SageMaker uses the MIME type with each http call to\n transfer data to the transform job.
" - } - }, - "CompressionType": { - "target": "com.amazonaws.sagemaker#CompressionType", - "traits": { - "smithy.api#documentation": "If your transform data\n is\n compressed, specify the compression type. Amazon SageMaker automatically\n decompresses the data for the transform job accordingly. The default value is\n None.
The method to use to split the transform job's data files into smaller batches.\n Splitting is necessary when the total size of each object is too large to fit in a\n single request. You can also use data splitting to improve performance by processing\n multiple concurrent mini-batches. The default value for SplitType is\n None, which indicates that input data files are not split, and request\n payloads contain the entire contents of an input object. Set the value of this parameter\n to Line to split records on a newline character boundary.\n SplitType also supports a number of record-oriented binary data\n formats. Currently, the supported record formats are:
RecordIO
\nTFRecord
\nWhen splitting is enabled, the size of a mini-batch depends on the values of the\n BatchStrategy and MaxPayloadInMB parameters. When the\n value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum\n number of records in each request, up to the MaxPayloadInMB limit. If the\n value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual\n records in each request.
Some data formats represent a record as a binary payload wrapped with extra\n padding bytes. When splitting is applied to a binary data format, padding is removed\n if the value of BatchStrategy is set to SingleRecord.\n Padding is not removed if the value of BatchStrategy is set to\n MultiRecord.
For more information about RecordIO, see Create a Dataset Using\n RecordIO in the MXNet documentation. For more information about\n TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
Describes the input source of a transform job and the way the transform job consumes\n it.
" - } - }, - "com.amazonaws.sagemaker#TransformInstanceCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#TransformInstanceType": { - "type": "enum", - "members": { - "ML_M4_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.xlarge" - } - }, - "ML_M4_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.2xlarge" - } - }, - "ML_M4_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.4xlarge" - } - }, - "ML_M4_10XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.10xlarge" - } - }, - "ML_M4_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m4.16xlarge" - } - }, - "ML_C4_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.xlarge" - } - }, - "ML_C4_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.2xlarge" - } - }, - "ML_C4_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.4xlarge" - } - }, - "ML_C4_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c4.8xlarge" - } - }, - "ML_P2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p2.xlarge" - } - }, - "ML_P2_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p2.8xlarge" - } - }, - "ML_P2_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p2.16xlarge" - } - }, - "ML_P3_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.2xlarge" - } - }, - "ML_P3_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.8xlarge" - } - }, - "ML_P3_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.16xlarge" - } - }, - "ML_C5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.xlarge" - } - }, - "ML_C5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.2xlarge" - } - }, - "ML_C5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.4xlarge" - } - }, - "ML_C5_9XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.9xlarge" - } - }, - "ML_C5_18XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c5.18xlarge" - } - }, - "ML_M5_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.large" - } - }, - "ML_M5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.xlarge" - } - }, - "ML_M5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.2xlarge" - } - }, - "ML_M5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.4xlarge" - } - }, - "ML_M5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.12xlarge" - } - }, - "ML_M5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m5.24xlarge" - } - }, - "ML_M6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.large" - } - }, - "ML_M6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.xlarge" - } - }, - "ML_M6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.2xlarge" - } - }, - "ML_M6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.4xlarge" - } - }, - "ML_M6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.8xlarge" - } - }, - "ML_M6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.12xlarge" - } - }, - "ML_M6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.16xlarge" - } - }, - "ML_M6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.24xlarge" - } - }, - "ML_M6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m6i.32xlarge" - } - }, - "ML_C6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.large" - } - }, - "ML_C6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.xlarge" - } - }, - "ML_C6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.2xlarge" - } - }, - "ML_C6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.4xlarge" - } - }, - "ML_C6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.8xlarge" - } - }, - "ML_C6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.12xlarge" - } - }, - "ML_C6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.16xlarge" - } - }, - "ML_C6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.24xlarge" - } - }, - "ML_C6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c6i.32xlarge" - } - }, - "ML_R6I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.large" - } - }, - "ML_R6I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.xlarge" - } - }, - "ML_R6I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.2xlarge" - } - }, - "ML_R6I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.4xlarge" - } - }, - "ML_R6I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.8xlarge" - } - }, - "ML_R6I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.12xlarge" - } - }, - "ML_R6I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.16xlarge" - } - }, - "ML_R6I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.24xlarge" - } - }, - "ML_R6I_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r6i.32xlarge" - } - }, - "ML_M7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.large" - } - }, - "ML_M7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.xlarge" - } - }, - "ML_M7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.2xlarge" - } - }, - "ML_M7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.4xlarge" - } - }, - "ML_M7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.8xlarge" - } - }, - "ML_M7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.12xlarge" - } - }, - "ML_M7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.16xlarge" - } - }, - "ML_M7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.24xlarge" - } - }, - "ML_M7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.m7i.48xlarge" - } - }, - "ML_C7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.large" - } - }, - "ML_C7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.xlarge" - } - }, - "ML_C7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.2xlarge" - } - }, - "ML_C7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.4xlarge" - } - }, - "ML_C7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.8xlarge" - } - }, - "ML_C7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.12xlarge" - } - }, - "ML_C7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.16xlarge" - } - }, - "ML_C7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.24xlarge" - } - }, - "ML_C7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.c7i.48xlarge" - } - }, - "ML_R7I_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.large" - } - }, - "ML_R7I_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.xlarge" - } - }, - "ML_R7I_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.2xlarge" - } - }, - "ML_R7I_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.4xlarge" - } - }, - "ML_R7I_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.8xlarge" - } - }, - "ML_R7I_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.12xlarge" - } - }, - "ML_R7I_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.16xlarge" - } - }, - "ML_R7I_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.24xlarge" - } - }, - "ML_R7I_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.r7i.48xlarge" - } - }, - "ML_G4DN_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.xlarge" - } - }, - "ML_G4DN_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.2xlarge" - } - }, - "ML_G4DN_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.4xlarge" - } - }, - "ML_G4DN_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.8xlarge" - } - }, - "ML_G4DN_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.12xlarge" - } - }, - "ML_G4DN_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g4dn.16xlarge" - } - }, - "ML_G5_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.xlarge" - } - }, - "ML_G5_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.2xlarge" - } - }, - "ML_G5_4XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.4xlarge" - } - }, - "ML_G5_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.8xlarge" - } - }, - "ML_G5_12XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.12xlarge" - } - }, - "ML_G5_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.16xlarge" - } - }, - "ML_G5_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.24xlarge" - } - }, - "ML_G5_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.g5.48xlarge" - } - }, - "ML_TRN1_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.2xlarge" - } - }, - "ML_TRN1_32XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn1.32xlarge" - } - }, - "ML_INF2_XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.xlarge" - } - }, - "ML_INF2_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.8xlarge" - } - }, - "ML_INF2_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.24xlarge" - } - }, - "ML_INF2_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.inf2.48xlarge" - } - } - } - }, - "com.amazonaws.sagemaker#TransformInstanceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TransformInstanceType" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#TransformJob": { - "type": "structure", - "members": { - "TransformJobName": { - "target": "com.amazonaws.sagemaker#TransformJobName", - "traits": { - "smithy.api#documentation": "The name of the transform job.
" - } - }, - "TransformJobArn": { - "target": "com.amazonaws.sagemaker#TransformJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job.
" - } - }, - "TransformJobStatus": { - "target": "com.amazonaws.sagemaker#TransformJobStatus", - "traits": { - "smithy.api#documentation": "The status of the transform job.
\nTransform job statuses are:
\n\n InProgress - The job is in progress.
\n Completed - The job has completed.
\n Failed - The transform job has failed. To see the reason for the failure,\n see the FailureReason field in the response to a\n DescribeTransformJob call.
\n Stopping - The transform job is stopping.
\n Stopped - The transform job has stopped.
If the transform job failed, the reason it failed.
" - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "The name of the model associated with the transform job.
" - } - }, - "MaxConcurrentTransforms": { - "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", - "traits": { - "smithy.api#documentation": "The maximum number of parallel requests that can be sent to each instance in a transform\n job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the\n optional execution-parameters to determine the settings for your chosen algorithm. If the\n execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms,\n you don't need to set a value for MaxConcurrentTransforms.
The maximum allowed size of the payload, in MB. A payload is the data portion of a record\n (without metadata). The value in MaxPayloadInMB must be greater than, or equal\n to, the size of a single record. To estimate the size of a record in MB, divide the size of\n your dataset by the number of records. To ensure that the records fit within the maximum\n payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases\n where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding,\n set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in\n algorithms do not support HTTP chunked encoding.
Specifies the number of records to include in a mini-batch for an HTTP inference request.\n A record is a single unit of input data that inference can be made on. For example, a single\n line in a CSV file is a record.
" - } - }, - "Environment": { - "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", - "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.
" - } - }, - "TransformInput": { - "target": "com.amazonaws.sagemaker#TransformInput" - }, - "TransformOutput": { - "target": "com.amazonaws.sagemaker#TransformOutput" - }, - "DataCaptureConfig": { - "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig" - }, - "TransformResources": { - "target": "com.amazonaws.sagemaker#TransformResources" - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "A timestamp that shows when the transform Job was created.
" - } - }, - "TransformStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates when the transform job starts on ML instances. You are billed for the time\n interval between this time and the value of TransformEndTime.
Indicates when the transform job has been completed, or has stopped or failed. You are\n billed for the time interval between this time and the value of\n TransformStartTime.
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
" - } - }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
" - } - }, - "DataProcessing": { - "target": "com.amazonaws.sagemaker#DataProcessing" - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "A list of tags associated with the transform job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A batch transform job. For information about SageMaker batch transform, see Use Batch\n Transform.
" - } - }, - "com.amazonaws.sagemaker#TransformJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/" - } - }, - "com.amazonaws.sagemaker#TransformJobDefinition": { - "type": "structure", - "members": { - "MaxConcurrentTransforms": { - "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", - "traits": { - "smithy.api#documentation": "The maximum number of parallel requests that can be sent to each instance in a\n transform job. The default value is 1.
" - } - }, - "MaxPayloadInMB": { - "target": "com.amazonaws.sagemaker#MaxPayloadInMB", - "traits": { - "smithy.api#documentation": "The maximum payload size allowed, in MB. A payload is the data portion of a record\n (without metadata).
" - } - }, - "BatchStrategy": { - "target": "com.amazonaws.sagemaker#BatchStrategy", - "traits": { - "smithy.api#documentation": "A string that determines the number of records included in a single mini-batch.
\n\n SingleRecord means only one record is used per mini-batch.\n MultiRecord means a mini-batch is set to contain as many records that\n can fit within the MaxPayloadInMB limit.
The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.
" - } - }, - "TransformInput": { - "target": "com.amazonaws.sagemaker#TransformInput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A description of the input source and the way the transform job consumes it.
", - "smithy.api#required": {} - } - }, - "TransformOutput": { - "target": "com.amazonaws.sagemaker#TransformOutput", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.
", - "smithy.api#required": {} - } - }, - "TransformResources": { - "target": "com.amazonaws.sagemaker#TransformResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the ML compute instances for the transform job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the input needed to run a transform job using the inference specification\n specified in the algorithm.
" - } - }, - "com.amazonaws.sagemaker#TransformJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#TransformJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#TransformJobStepMetadata": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#TransformJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for a transform job step.
" - } - }, - "com.amazonaws.sagemaker#TransformJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TransformJobSummary" - } - }, - "com.amazonaws.sagemaker#TransformJobSummary": { - "type": "structure", - "members": { - "TransformJobName": { - "target": "com.amazonaws.sagemaker#TransformJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the transform job.
", - "smithy.api#required": {} - } - }, - "TransformJobArn": { - "target": "com.amazonaws.sagemaker#TransformJobArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp that shows when the transform Job was created.
", - "smithy.api#required": {} - } - }, - "TransformEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates when the transform\n job\n ends on compute instances. For successful jobs and stopped jobs, this\n is the exact time\n recorded\n after the results are uploaded. For failed jobs, this is when Amazon SageMaker\n detected that the job failed.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates when the transform job was last modified.
" - } - }, - "TransformJobStatus": { - "target": "com.amazonaws.sagemaker#TransformJobStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the transform job.
", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "If the transform job failed,\n the\n reason it failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides a\n summary\n of a transform job. Multiple TransformJobSummary objects are returned as a\n list after in response to a ListTransformJobs call.
The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For\n example, s3://bucket-name/key-name-prefix.
For every S3 object used as input for the transform job, batch transform stores the\n transformed data with an .out suffix in a corresponding subfolder in the\n location in the output prefix. For example, for the input data stored at\n s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform\n stores the transformed data at\n s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out.\n Batch transform doesn't upload partially processed objects. For an input S3 object that\n contains multiple records, it creates an .out file only if the transform\n job succeeds on the entire file. When the input contains multiple S3 objects, the batch\n transform job processes the listed S3 objects and uploads only the output for\n successfully processed objects. If any object fails in the transform job batch transform\n marks the job as failed to prompt investigation.
The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http\n call to transfer data from the transform job.
" - } - }, - "AssembleWith": { - "target": "com.amazonaws.sagemaker#AssemblyType", - "traits": { - "smithy.api#documentation": "Defines how to assemble the results of the transform job as a single S3 object. Choose\n a format that is most convenient to you. To concatenate the results in binary format,\n specify None. To add a newline character at the end of every transformed\n record, specify\n Line.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n
\nThe KMS key policy must grant permission to the IAM role that you specify in your\n\tCreateModel\n\t\trequest. For more information, see Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the results of a transform job.
" - } - }, - "com.amazonaws.sagemaker#TransformResources": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.sagemaker#TransformInstanceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ML compute instance type for the transform job. If you are using built-in\n algorithms to\n transform\n moderately sized datasets, we recommend using ml.m4.xlarge or\n ml.m5.largeinstance types.
The number of\n ML\n compute instances to use in the transform job. The default value is\n 1, and the maximum is 100. For distributed transform jobs,\n specify a value greater than 1.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume\n attached to the ML compute instance(s) that run the batch transform job.
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\n\n The VolumeKmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
Describes the resources, including ML instance types and ML instance count, to use for\n transform job.
" - } - }, - "com.amazonaws.sagemaker#TransformS3DataSource": { - "type": "structure", - "members": { - "S3DataType": { - "target": "com.amazonaws.sagemaker#S3DataType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If you choose S3Prefix, S3Uri identifies a key name prefix.\n Amazon SageMaker uses all objects with the specified key name prefix for batch transform.
If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch\n transform.
The following values are compatible: ManifestFile,\n S3Prefix\n
The following value is not compatible: AugmentedManifestFile\n
Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest. For example:
A key name prefix might look like this:\n\t\ts3://bucketname/exampleprefix/.
A manifest might look like this:\n s3://bucketname/example.manifest\n
The manifest is an S3 object which is a JSON file with the following format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
The preceding JSON matches the following S3Uris:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uris in this manifest constitutes the\n input data for the channel for this datasource. The object that each\n S3Uris points to must be readable by the IAM role that Amazon SageMaker\n uses to perform tasks on your behalf.
Describes the S3 data source.
" - } - }, - "com.amazonaws.sagemaker#TransformationAttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.sagemaker#Trial": { - "type": "structure", - "members": { - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial.
" - } - }, - "TrialArn": { - "target": "com.amazonaws.sagemaker#TrialArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.
The name of the experiment the trial is part of.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#TrialSource" - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the trial was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who created the trial.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "Who last modified the trial.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "The list of tags that are associated with the trial. You can use Search\n API to search on the tags.
" - } - }, - "TrialComponentSummaries": { - "target": "com.amazonaws.sagemaker#TrialComponentSimpleSummaries", - "traits": { - "smithy.api#documentation": "A list of the components associated with the trial. For each component, a summary of the\n component's properties is included.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The properties of a trial as returned by the Search API.
" - } - }, - "com.amazonaws.sagemaker#TrialArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/" - } - }, - "com.amazonaws.sagemaker#TrialComponent": { - "type": "structure", - "members": { - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial component.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.
The Amazon Resource Name (ARN) of the trial component.
" - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#TrialComponentSource", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) and job type of the source of the component.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#TrialComponentStatus" - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component started.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component ended.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who created the trial component.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, - "Parameters": { - "target": "com.amazonaws.sagemaker#TrialComponentParameters", - "traits": { - "smithy.api#documentation": "The hyperparameters of the component.
" - } - }, - "InputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", - "traits": { - "smithy.api#documentation": "The input artifacts of the component.
" - } - }, - "OutputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", - "traits": { - "smithy.api#documentation": "The output artifacts of the component.
" - } - }, - "Metrics": { - "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", - "traits": { - "smithy.api#documentation": "The metrics for the component.
" - } - }, - "MetadataProperties": { - "target": "com.amazonaws.sagemaker#MetadataProperties" - }, - "SourceDetail": { - "target": "com.amazonaws.sagemaker#TrialComponentSourceDetail", - "traits": { - "smithy.api#documentation": "Details of the source of the component.
" - } - }, - "LineageGroupArn": { - "target": "com.amazonaws.sagemaker#LineageGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group resource.
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "The list of tags that are associated with the component. You can use Search API to search on the tags.
" - } - }, - "Parents": { - "target": "com.amazonaws.sagemaker#Parents", - "traits": { - "smithy.api#documentation": "An array of the parents of the component. A parent is a trial the component is associated\n with and the experiment the trial is part of. A component might not have any parents.
" - } - }, - "RunName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment run.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The properties of a trial component as returned by the Search\n API.
" - } - }, - "com.amazonaws.sagemaker#TrialComponentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/" - } - }, - "com.amazonaws.sagemaker#TrialComponentArtifact": { - "type": "structure", - "members": { - "MediaType": { - "target": "com.amazonaws.sagemaker#MediaType", - "traits": { - "smithy.api#documentation": "The media type of the artifact, which indicates the type of data in the artifact file. The\n media type consists of a type and a subtype\n concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The\n type specifies the category of the media. The subtype specifies the kind of data.
" - } - }, - "Value": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifactValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location of the artifact.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Represents an input or output artifact of a trial component. You specify\n TrialComponentArtifact as part of the InputArtifacts and\n OutputArtifacts parameters in the CreateTrialComponent\n request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and\n instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
" - } - }, - "com.amazonaws.sagemaker#TrialComponentArtifactValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#TrialComponentArtifacts": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#TrialComponentKey128" - }, - "value": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifact" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 60 - } - } - }, - "com.amazonaws.sagemaker#TrialComponentKey128": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#TrialComponentKey256": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#TrialComponentKey320": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 320 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#TrialComponentMetricSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrialComponentMetricSummary" - } - }, - "com.amazonaws.sagemaker#TrialComponentMetricSummary": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.sagemaker#MetricName", - "traits": { - "smithy.api#documentation": "The name of the metric.
" - } - }, - "SourceArn": { - "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source.
" - } - }, - "TimeStamp": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the metric was last updated.
" - } - }, - "Max": { - "target": "com.amazonaws.sagemaker#OptionalDouble", - "traits": { - "smithy.api#documentation": "The maximum value of the metric.
" - } - }, - "Min": { - "target": "com.amazonaws.sagemaker#OptionalDouble", - "traits": { - "smithy.api#documentation": "The minimum value of the metric.
" - } - }, - "Last": { - "target": "com.amazonaws.sagemaker#OptionalDouble", - "traits": { - "smithy.api#documentation": "The most recent value of the metric.
" - } - }, - "Count": { - "target": "com.amazonaws.sagemaker#OptionalInteger", - "traits": { - "smithy.api#documentation": "The number of samples used to generate the metric.
" - } - }, - "Avg": { - "target": "com.amazonaws.sagemaker#OptionalDouble", - "traits": { - "smithy.api#documentation": "The average value of the metric.
" - } - }, - "StdDev": { - "target": "com.amazonaws.sagemaker#OptionalDouble", - "traits": { - "smithy.api#documentation": "The standard deviation of the metric.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of the metrics of a trial component.
" - } - }, - "com.amazonaws.sagemaker#TrialComponentParameterValue": { - "type": "union", - "members": { - "StringValue": { - "target": "com.amazonaws.sagemaker#StringParameterValue", - "traits": { - "smithy.api#documentation": "The string value of a categorical hyperparameter. If you specify a value for this\n parameter, you can't specify the NumberValue parameter.
The numeric value of a numeric hyperparameter. If you specify a value for this parameter,\n you can't specify the StringValue parameter.
The value of a hyperparameter. Only one of NumberValue or\n StringValue can be specified.
This object is specified in the CreateTrialComponent request.
" - } - }, - "com.amazonaws.sagemaker#TrialComponentParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.sagemaker#TrialComponentKey320" - }, - "value": { - "target": "com.amazonaws.sagemaker#TrialComponentParameterValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 300 - } - } - }, - "com.amazonaws.sagemaker#TrialComponentPrimaryStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - } - } - }, - "com.amazonaws.sagemaker#TrialComponentSimpleSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrialComponentSimpleSummary" - } - }, - "com.amazonaws.sagemaker#TrialComponentSimpleSummary": { - "type": "structure", - "members": { - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial component.
" - } - }, - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" - } - }, - "TrialComponentSource": { - "target": "com.amazonaws.sagemaker#TrialComponentSource" - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - } - }, - "traits": { - "smithy.api#documentation": "A short summary of a trial component.
" - } - }, - "com.amazonaws.sagemaker#TrialComponentSource": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The source Amazon Resource Name (ARN).
", - "smithy.api#required": {} - } - }, - "SourceType": { - "target": "com.amazonaws.sagemaker#SourceType", - "traits": { - "smithy.api#documentation": "The source job type.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) and job type of the source of a trial component.
" - } - }, - "com.amazonaws.sagemaker#TrialComponentSourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:" - } - }, - "com.amazonaws.sagemaker#TrialComponentSourceDetail": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source.
" - } - }, - "TrainingJob": { - "target": "com.amazonaws.sagemaker#TrainingJob", - "traits": { - "smithy.api#documentation": "Information about a training job that's the source of a trial component.
" - } - }, - "ProcessingJob": { - "target": "com.amazonaws.sagemaker#ProcessingJob", - "traits": { - "smithy.api#documentation": "Information about a processing job that's the source of a trial component.
" - } - }, - "TransformJob": { - "target": "com.amazonaws.sagemaker#TransformJob", - "traits": { - "smithy.api#documentation": "Information about a transform job that's the source of a trial component.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Detailed information about the source of a trial component. Either\n ProcessingJob or TrainingJob is returned.
The status of the trial component.
" - } - }, - "Message": { - "target": "com.amazonaws.sagemaker#TrialComponentStatusMessage", - "traits": { - "smithy.api#documentation": "If the component failed, a message describing why.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The status of the trial component.
" - } - }, - "com.amazonaws.sagemaker#TrialComponentStatusMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.sagemaker#TrialComponentSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrialComponentSummary" - } - }, - "com.amazonaws.sagemaker#TrialComponentSummary": { - "type": "structure", - "members": { - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial component.
" - } - }, - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.
The status of the component. States include:
\nInProgress
\nCompleted
\nFailed
\nWhen the component started.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component ended.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component was created.
" - } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who created the trial component.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component was last modified.
" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "Who last modified the component.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of the properties of a trial component. To get all the properties, call the\n DescribeTrialComponent API and provide the\n TrialComponentName.
The Amazon Resource Name (ARN) of the source.
", - "smithy.api#required": {} - } - }, - "SourceType": { - "target": "com.amazonaws.sagemaker#SourceType", - "traits": { - "smithy.api#documentation": "The source job type.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The source of the trial.
" - } - }, - "com.amazonaws.sagemaker#TrialSourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:" - } - }, - "com.amazonaws.sagemaker#TrialSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#TrialSummary" - } - }, - "com.amazonaws.sagemaker#TrialSummary": { - "type": "structure", - "members": { - "TrialArn": { - "target": "com.amazonaws.sagemaker#TrialArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" - } - }, - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.
When the trial was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the trial was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A summary of the properties of a trial. To get the complete set of properties, call the\n DescribeTrial API and provide the TrialName.
\n TtlDuration time unit.
\n TtlDuration time value.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
The value of the objective metric.
" - } - }, - "BestObjectiveNotImproving": { - "target": "com.amazonaws.sagemaker#BestObjectiveNotImproving", - "traits": { - "smithy.api#documentation": "A flag to stop your hyperparameter tuning job if model performance fails to improve as\n evaluated against an objective function.
" - } - }, - "ConvergenceDetected": { - "target": "com.amazonaws.sagemaker#ConvergenceDetected", - "traits": { - "smithy.api#documentation": "A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has\n detected that your model has converged as evaluated against your objective\n function.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The job completion criteria.
" - } - }, - "com.amazonaws.sagemaker#TuningJobStepMetaData": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metadata for a tuning step.
" - } - }, - "com.amazonaws.sagemaker#USD": { - "type": "structure", - "members": { - "Dollars": { - "target": "com.amazonaws.sagemaker#Dollars", - "traits": { - "smithy.api#documentation": "The whole number of dollars in the amount.
" - } - }, - "Cents": { - "target": "com.amazonaws.sagemaker#Cents", - "traits": { - "smithy.api#documentation": "The fractional portion, in cents, of the amount.
" - } - }, - "TenthFractionsOfACent": { - "target": "com.amazonaws.sagemaker#TenthFractionsOfACent", - "traits": { - "smithy.api#documentation": "Fractions of a cent, in tenths.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents an amount of money in United States dollars.
" - } - }, - "com.amazonaws.sagemaker#UiConfig": { - "type": "structure", - "members": { - "UiTemplateS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The Amazon S3 bucket location of the UI template, or worker task template. This is the\n template used to render the worker UI and tools for labeling job tasks. For more\n information about the contents of a UI template, see Creating Your Custom\n Labeling Task Template.
" - } - }, - "HumanTaskUiArn": { - "target": "com.amazonaws.sagemaker#HumanTaskUiArn", - "traits": { - "smithy.api#documentation": "The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.
\nUse this parameter when you are creating a labeling job for named entity recognition,\n 3D point cloud and video frame labeling jobs. Use your labeling job task type to select\n one of the following ARNs and use it with this parameter when you create a labeling job.\n Replace aws-region with the Amazon Web Services Region you are creating your labeling job\n in. For example, replace aws-region with us-west-1 if you\n create a labeling job in US West (N. California).
\n Named Entity Recognition\n
\nUse the following HumanTaskUiArn for named entity recognition labeling\n jobs:
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition\n
\n 3D Point Cloud HumanTaskUiArns\n
\nUse this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n
Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n
Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n
\n Video Frame HumanTaskUiArns\n
\nUse this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.
\n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n
Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n
Provided configuration information for the worker UI for a labeling job. Provide\n either HumanTaskUiArn or UiTemplateS3Uri.
For named entity recognition, 3D point cloud and video frame labeling jobs, use\n HumanTaskUiArn.
For all other Ground Truth built-in task types and custom task types, use\n UiTemplateS3Uri to specify the location of a worker task template in\n Amazon S3.
The content of the Liquid template for the worker user interface.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The Liquid template for the worker user interface.
" - } - }, - "com.amazonaws.sagemaker#UiTemplateInfo": { - "type": "structure", - "members": { - "Url": { - "target": "com.amazonaws.sagemaker#TemplateUrl", - "traits": { - "smithy.api#documentation": "The URL for the user interface template.
" - } - }, - "ContentSha256": { - "target": "com.amazonaws.sagemaker#TemplateContentSha256", - "traits": { - "smithy.api#documentation": "The SHA-256 digest of the contents of the template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Container for user interface template information.
" - } - }, - "com.amazonaws.sagemaker#Uid": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 10000, - "max": 4000000 - } - } - }, - "com.amazonaws.sagemaker#UpdateAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateActionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateActionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates an action.
" - } - }, - "com.amazonaws.sagemaker#UpdateActionRequest": { - "type": "structure", - "members": { - "ActionName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the action to update.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ExperimentDescription", - "traits": { - "smithy.api#documentation": "The new description for the action.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#ActionStatus", - "traits": { - "smithy.api#documentation": "The new status for the action.
" - } - }, - "Properties": { - "target": "com.amazonaws.sagemaker#LineageEntityParameters", - "traits": { - "smithy.api#documentation": "The new list of properties. Overwrites the current property list.
" - } - }, - "PropertiesToRemove": { - "target": "com.amazonaws.sagemaker#ListLineageEntityParameterKey", - "traits": { - "smithy.api#documentation": "A list of properties to remove.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateActionResponse": { - "type": "structure", - "members": { - "ActionArn": { - "target": "com.amazonaws.sagemaker#ActionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateAppImageConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateAppImageConfigRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateAppImageConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates the properties of an AppImageConfig.
" - } - }, - "com.amazonaws.sagemaker#UpdateAppImageConfigRequest": { - "type": "structure", - "members": { - "AppImageConfigName": { - "target": "com.amazonaws.sagemaker#AppImageConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the AppImageConfig to update.
", - "smithy.api#required": {} - } - }, - "KernelGatewayImageConfig": { - "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", - "traits": { - "smithy.api#documentation": "The new KernelGateway app to run on the image.
" - } - }, - "JupyterLabAppImageConfig": { - "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", - "traits": { - "smithy.api#documentation": "The JupyterLab app running on the image.
" - } - }, - "CodeEditorAppImageConfig": { - "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", - "traits": { - "smithy.api#documentation": "The Code Editor app running on the image.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateAppImageConfigResponse": { - "type": "structure", - "members": { - "AppImageConfigArn": { - "target": "com.amazonaws.sagemaker#AppImageConfigArn", - "traits": { - "smithy.api#documentation": "The ARN for the AppImageConfig.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateArtifact": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateArtifactRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateArtifactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates an artifact.
" - } - }, - "com.amazonaws.sagemaker#UpdateArtifactRequest": { - "type": "structure", - "members": { - "ArtifactArn": { - "target": "com.amazonaws.sagemaker#ArtifactArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact to update.
", - "smithy.api#required": {} - } - }, - "ArtifactName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The new name for the artifact.
" - } - }, - "Properties": { - "target": "com.amazonaws.sagemaker#ArtifactProperties", - "traits": { - "smithy.api#documentation": "The new list of properties. Overwrites the current property list.
" - } - }, - "PropertiesToRemove": { - "target": "com.amazonaws.sagemaker#ListLineageEntityParameterKey", - "traits": { - "smithy.api#documentation": "A list of properties to remove.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateArtifactResponse": { - "type": "structure", - "members": { - "ArtifactArn": { - "target": "com.amazonaws.sagemaker#ArtifactArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateClusterRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates a SageMaker HyperPod cluster.
" - } - }, - "com.amazonaws.sagemaker#UpdateClusterRequest": { - "type": "structure", - "members": { - "ClusterName": { - "target": "com.amazonaws.sagemaker#ClusterNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specify the name of the SageMaker HyperPod cluster you want to update.
", - "smithy.api#required": {} - } - }, - "InstanceGroups": { - "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specify the instance groups to update.
", - "smithy.api#required": {} - } - }, - "NodeRecovery": { - "target": "com.amazonaws.sagemaker#ClusterNodeRecovery", - "traits": { - "smithy.api#documentation": "The node recovery mode to be applied to the SageMaker HyperPod cluster.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateClusterResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateClusterSchedulerConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Update the cluster policy configuration.
" - } - }, - "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigRequest": { - "type": "structure", - "members": { - "ClusterSchedulerConfigId": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the cluster policy.
", - "smithy.api#required": {} - } - }, - "TargetVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Target version.
", - "smithy.api#required": {} - } - }, - "SchedulerConfig": { - "target": "com.amazonaws.sagemaker#SchedulerConfig", - "traits": { - "smithy.api#documentation": "Cluster policy configuration.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "Description of the cluster policy.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigResponse": { - "type": "structure", - "members": { - "ClusterSchedulerConfigArn": { - "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the cluster policy.
", - "smithy.api#required": {} - } - }, - "ClusterSchedulerConfigVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Version of the cluster policy.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateClusterSoftware": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to\n use this API, see Update the SageMaker HyperPod platform software of a cluster.
\nThe UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster\n uptime and availability. Plan accordingly to mitigate potential disruptions to your\n workloads.
Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security\n patching.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateClusterSoftwareResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "target": "com.amazonaws.sagemaker#ClusterArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateCodeRepository": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateCodeRepositoryInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateCodeRepositoryOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the specified Git repository with the specified values.
" - } - }, - "com.amazonaws.sagemaker#UpdateCodeRepositoryInput": { - "type": "structure", - "members": { - "CodeRepositoryName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Git repository to update.
", - "smithy.api#required": {} - } - }, - "GitConfig": { - "target": "com.amazonaws.sagemaker#GitConfigForUpdate", - "traits": { - "smithy.api#documentation": "The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:
\n {\"username\": UserName, \"password\":\n Password}\n
The ARN of the Git repository.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateComputeQuota": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateComputeQuotaRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateComputeQuotaResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Update the compute allocation definition.
" - } - }, - "com.amazonaws.sagemaker#UpdateComputeQuotaRequest": { - "type": "structure", - "members": { - "ComputeQuotaId": { - "target": "com.amazonaws.sagemaker#ComputeQuotaId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ID of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "TargetVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Target version.
", - "smithy.api#required": {} - } - }, - "ComputeQuotaConfig": { - "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", - "traits": { - "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" - } - }, - "ComputeQuotaTarget": { - "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", - "traits": { - "smithy.api#documentation": "The target entity to allocate compute resources to.
" - } - }, - "ActivationState": { - "target": "com.amazonaws.sagemaker#ActivationState", - "traits": { - "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Description of the compute allocation definition.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateComputeQuotaResponse": { - "type": "structure", - "members": { - "ComputeQuotaArn": { - "target": "com.amazonaws.sagemaker#ComputeQuotaArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "ARN of the compute allocation definition.
", - "smithy.api#required": {} - } - }, - "ComputeQuotaVersion": { - "target": "com.amazonaws.sagemaker#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Version of the compute allocation definition.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateContext": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateContextRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateContextResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates a context.
" - } - }, - "com.amazonaws.sagemaker#UpdateContextRequest": { - "type": "structure", - "members": { - "ContextName": { - "target": "com.amazonaws.sagemaker#ContextName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the context to update.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#ExperimentDescription", - "traits": { - "smithy.api#documentation": "The new description for the context.
" - } - }, - "Properties": { - "target": "com.amazonaws.sagemaker#LineageEntityParameters", - "traits": { - "smithy.api#documentation": "The new list of properties. Overwrites the current property list.
" - } - }, - "PropertiesToRemove": { - "target": "com.amazonaws.sagemaker#ListLineageEntityParameterKey", - "traits": { - "smithy.api#documentation": "A list of properties to remove.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateContextResponse": { - "type": "structure", - "members": { - "ContextArn": { - "target": "com.amazonaws.sagemaker#ContextArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateDeviceFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateDeviceFleetRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - } - ], - "traits": { - "smithy.api#documentation": "Updates a fleet of devices.
" - } - }, - "com.amazonaws.sagemaker#UpdateDeviceFleetRequest": { - "type": "structure", - "members": { - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the device.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#DeviceFleetDescription", - "traits": { - "smithy.api#documentation": "Description of the fleet.
" - } - }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#EdgeOutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Output configuration for storing sample data collected by the fleet.
", - "smithy.api#required": {} - } - }, - "EnableIotRoleAlias": { - "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", - "traits": { - "smithy.api#documentation": "Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".
\nFor example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateDevices": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateDevicesRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Updates one or more devices in a fleet.
" - } - }, - "com.amazonaws.sagemaker#UpdateDevicesRequest": { - "type": "structure", - "members": { - "DeviceFleetName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet the devices belong to.
", - "smithy.api#required": {} - } - }, - "Devices": { - "target": "com.amazonaws.sagemaker#Devices", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "List of devices to register with Edge Manager agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateDomainRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateDomainResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates the default settings for new user profiles in the domain.
" - } - }, - "com.amazonaws.sagemaker#UpdateDomainRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the domain to be updated.
", - "smithy.api#required": {} - } - }, - "DefaultUserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", - "traits": { - "smithy.api#documentation": "A collection of settings.
" - } - }, - "DomainSettingsForUpdate": { - "target": "com.amazonaws.sagemaker#DomainSettingsForUpdate", - "traits": { - "smithy.api#documentation": "A collection of DomainSettings configuration values to update.
The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.
The default settings for shared spaces that users create in the domain.
" - } - }, - "SubnetIds": { - "target": "com.amazonaws.sagemaker#Subnets", - "traits": { - "smithy.api#documentation": "The VPC subnets that Studio uses for communication.
\nIf removing subnets, ensure there are no apps in the InService,\n Pending, or Deleting state.
Specifies the VPC used for non-EFS traffic.
\n\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.
\n VpcOnly - All Studio traffic is through the specified VPC and\n subnets.
This configuration can only be modified if there are no apps in the\n InService, Pending, or Deleting state. The\n configuration cannot be updated if\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already\n set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided as part of the same request.
Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.
The Amazon Resource Name (ARN) of the domain.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateEndpointInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateEndpointOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Deploys the EndpointConfig specified in the request to a new fleet of\n instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint\n configuration and then deletes the old instances using the previous\n EndpointConfig (there is no availability loss). For more information\n about how to control the update and traffic shifting process, see Update\n models in production.
When SageMaker receives the request, it sets the endpoint status to Updating.\n After updating the endpoint, it sets the status to InService. To check the\n status of an endpoint, use the DescribeEndpoint API.\n \n
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.
The name of the endpoint whose configuration you want to update.
", - "smithy.api#required": {} - } - }, - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the new endpoint configuration.
", - "smithy.api#required": {} - } - }, - "RetainAllVariantProperties": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To\n retain the variant properties of an endpoint when updating it, set\n RetainAllVariantProperties to true. To use the variant\n properties specified in a new EndpointConfig call when updating an\n endpoint, set RetainAllVariantProperties to false. The default\n is false.
When you are updating endpoint resources with RetainAllVariantProperties,\n whose value is set to true, ExcludeRetainedVariantProperties\n specifies the list of type VariantProperty\n to override with the values provided by EndpointConfig. If you don't\n specify a value for ExcludeRetainedVariantProperties, no variant properties\n are overridden.
The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.
" - } - }, - "RetainDeploymentConfig": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Specifies whether to reuse the last deployment configuration. The default value is\n false (the configuration is not reused).
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateEndpointOutput": { - "type": "structure", - "members": { - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacities": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Updates variant weight of one or more variants associated with an existing\n endpoint, or capacity of one variant associated with an existing endpoint. When it\n receives the request, SageMaker sets the endpoint status to Updating. After\n updating the endpoint, it sets the status to InService. To check the status\n of an endpoint, use the DescribeEndpoint API.
The name of an existing SageMaker endpoint.
", - "smithy.api#required": {} - } - }, - "DesiredWeightsAndCapacities": { - "target": "com.amazonaws.sagemaker#DesiredWeightAndCapacityList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An object that provides new capacity and weight values for a variant.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesOutput": { - "type": "structure", - "members": { - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated endpoint.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateExperimentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Adds, updates, or removes the description of an experiment. Updates the display name of an\n experiment.
" - } - }, - "com.amazonaws.sagemaker#UpdateExperimentRequest": { - "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the experiment to update.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the experiment as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, ExperimentName is displayed.
The description of the experiment.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateExperimentResponse": { - "type": "structure", - "members": { - "ExperimentArn": { - "target": "com.amazonaws.sagemaker#ExperimentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateFeatureGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateFeatureGroupRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateFeatureGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates the feature group by either adding features or updating the online store\n configuration. Use one of the following request parameters at a time while using the\n UpdateFeatureGroup API.
You can add features for your feature group using the FeatureAdditions\n request parameter. Features cannot be removed from a feature group.
You can update the online store configuration by using the\n OnlineStoreConfig request parameter. If a TtlDuration is\n specified, the default TtlDuration applies for all records added to the\n feature group after the feature group is updated. If a record level\n TtlDuration exists from using the PutRecord API, the record\n level TtlDuration applies to that record instead of the default\n TtlDuration. To remove the default TtlDuration from an\n existing feature group, use the UpdateFeatureGroup API and set the\n TtlDuration\n Unit and Value to null.
The name or Amazon Resource Name (ARN) of the feature group that you're updating.
", - "smithy.api#required": {} - } - }, - "FeatureAdditions": { - "target": "com.amazonaws.sagemaker#FeatureAdditions", - "traits": { - "smithy.api#documentation": "Updates the feature group. Updating a feature group is an asynchronous operation. When\n you get an HTTP 200 response, you've made a valid request. It takes some time after you've\n made a valid request for Feature Store to update the feature group.
" - } - }, - "OnlineStoreConfig": { - "target": "com.amazonaws.sagemaker#OnlineStoreConfigUpdate", - "traits": { - "smithy.api#documentation": "Updates the feature group online store configuration.
" - } - }, - "ThroughputConfig": { - "target": "com.amazonaws.sagemaker#ThroughputConfigUpdate" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateFeatureGroupResponse": { - "type": "structure", - "members": { - "FeatureGroupArn": { - "target": "com.amazonaws.sagemaker#FeatureGroupArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the feature group that you're updating.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateFeatureMetadata": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateFeatureMetadataRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates the description and parameters of the feature group.
" - } - }, - "com.amazonaws.sagemaker#UpdateFeatureMetadataRequest": { - "type": "structure", - "members": { - "FeatureGroupName": { - "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the feature group containing the feature that\n you're updating.
", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.sagemaker#FeatureName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the feature that you're updating.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#FeatureDescription", - "traits": { - "smithy.api#documentation": "A description that you can write to better describe the feature.
" - } - }, - "ParameterAdditions": { - "target": "com.amazonaws.sagemaker#FeatureParameterAdditions", - "traits": { - "smithy.api#documentation": "A list of key-value pairs that you can add to better describe the feature.
" - } - }, - "ParameterRemovals": { - "target": "com.amazonaws.sagemaker#FeatureParameterRemovals", - "traits": { - "smithy.api#documentation": "A list of parameter keys that you can specify to remove parameters that describe your\n feature.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateHub": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateHubRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateHubResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Update a hub.
" - } - }, - "com.amazonaws.sagemaker#UpdateHubRequest": { - "type": "structure", - "members": { - "HubName": { - "target": "com.amazonaws.sagemaker#HubNameOrArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the hub to update.
", - "smithy.api#required": {} - } - }, - "HubDescription": { - "target": "com.amazonaws.sagemaker#HubDescription", - "traits": { - "smithy.api#documentation": "A description of the updated hub.
" - } - }, - "HubDisplayName": { - "target": "com.amazonaws.sagemaker#HubDisplayName", - "traits": { - "smithy.api#documentation": "The display name of the hub.
" - } - }, - "HubSearchKeywords": { - "target": "com.amazonaws.sagemaker#HubSearchKeywordList", - "traits": { - "smithy.api#documentation": "The searchable keywords for the hub.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateHubResponse": { - "type": "structure", - "members": { - "HubArn": { - "target": "com.amazonaws.sagemaker#HubArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated hub.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateImageRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateImageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates the properties of a SageMaker AI image. To change the image's tags, use the\n AddTags and DeleteTags APIs.
" - } - }, - "com.amazonaws.sagemaker#UpdateImageRequest": { - "type": "structure", - "members": { - "DeleteProperties": { - "target": "com.amazonaws.sagemaker#ImageDeletePropertyList", - "traits": { - "smithy.api#documentation": "A list of properties to delete. Only the Description and\n DisplayName properties can be deleted.
The new description for the image.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ImageDisplayName", - "traits": { - "smithy.api#documentation": "The new display name for the image.
" - } - }, - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image to update.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateImageResponse": { - "type": "structure", - "members": { - "ImageArn": { - "target": "com.amazonaws.sagemaker#ImageArn", - "traits": { - "smithy.api#documentation": "The ARN of the image.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateImageVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateImageVersionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateImageVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates the properties of a SageMaker AI image version.
" - } - }, - "com.amazonaws.sagemaker#UpdateImageVersionRequest": { - "type": "structure", - "members": { - "ImageName": { - "target": "com.amazonaws.sagemaker#ImageName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image.
", - "smithy.api#required": {} - } - }, - "Alias": { - "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", - "traits": { - "smithy.api#documentation": "The alias of the image version.
" - } - }, - "Version": { - "target": "com.amazonaws.sagemaker#ImageVersionNumber", - "traits": { - "smithy.api#documentation": "The version of the image.
" - } - }, - "AliasesToAdd": { - "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", - "traits": { - "smithy.api#documentation": "A list of aliases to add.
" - } - }, - "AliasesToDelete": { - "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", - "traits": { - "smithy.api#documentation": "A list of aliases to delete.
" - } - }, - "VendorGuidance": { - "target": "com.amazonaws.sagemaker#VendorGuidance", - "traits": { - "smithy.api#documentation": "The availability of the image version specified by the maintainer.
\n\n NOT_PROVIDED: The maintainers did not provide a status for image version stability.
\n STABLE: The image version is stable.
\n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
\n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
\n\n TRAINING: The image version is compatible with SageMaker AI training jobs.
\n INFERENCE: The image version is compatible with SageMaker AI inference jobs.
\n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
The machine learning framework vended in the image version.
" - } - }, - "ProgrammingLang": { - "target": "com.amazonaws.sagemaker#ProgrammingLang", - "traits": { - "smithy.api#documentation": "The supported programming language and its version.
" - } - }, - "Processor": { - "target": "com.amazonaws.sagemaker#Processor", - "traits": { - "smithy.api#documentation": "Indicates CPU or GPU compatibility.
\n\n CPU: The image version is compatible with CPU.
\n GPU: The image version is compatible with GPU.
Indicates Horovod compatibility.
" - } - }, - "ReleaseNotes": { - "target": "com.amazonaws.sagemaker#ReleaseNotes", - "traits": { - "smithy.api#documentation": "The maintainer description of the image version.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateImageVersionResponse": { - "type": "structure", - "members": { - "ImageVersionArn": { - "target": "com.amazonaws.sagemaker#ImageVersionArn", - "traits": { - "smithy.api#documentation": "The ARN of the image version.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateInferenceComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateInferenceComponentInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateInferenceComponentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Updates an inference component.
" - } - }, - "com.amazonaws.sagemaker#UpdateInferenceComponentInput": { - "type": "structure", - "members": { - "InferenceComponentName": { - "target": "com.amazonaws.sagemaker#InferenceComponentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference component.
", - "smithy.api#required": {} - } - }, - "Specification": { - "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", - "traits": { - "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.
" - } - }, - "RuntimeConfig": { - "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", - "traits": { - "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateInferenceComponentOutput": { - "type": "structure", - "members": { - "InferenceComponentArn": { - "target": "com.amazonaws.sagemaker#InferenceComponentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
" - } - }, - "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput": { - "type": "structure", - "members": { - "InferenceComponentName": { - "target": "com.amazonaws.sagemaker#InferenceComponentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the inference component to update.
", - "smithy.api#required": {} - } - }, - "DesiredRuntimeConfig": { - "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput": { - "type": "structure", - "members": { - "InferenceComponentArn": { - "target": "com.amazonaws.sagemaker#InferenceComponentArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateInferenceExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateInferenceExperimentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateInferenceExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "\n Updates an inference experiment that you created. The status of the inference experiment has to be either\n Created, Running. For more information on the status of an inference experiment,\n see DescribeInferenceExperiment.\n
The name of the inference experiment to be updated.
", - "smithy.api#required": {} - } - }, - "Schedule": { - "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", - "traits": { - "smithy.api#documentation": "\n The duration for which the inference experiment will run. If the status of the inference experiment is\n Created, then you can update both the start and end dates. If the status of the inference\n experiment is Running, then you can update only the end date.\n
The description of the inference experiment.
" - } - }, - "ModelVariants": { - "target": "com.amazonaws.sagemaker#ModelVariantConfigList", - "traits": { - "smithy.api#documentation": "\n An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure\n configuration you want to update.\n
The Amazon S3 location and configuration for storing inference request and response data.
" - } - }, - "ShadowModeConfig": { - "target": "com.amazonaws.sagemaker#ShadowModeConfig", - "traits": { - "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n
The ARN of the updated inference experiment.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateMlflowTrackingServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates properties of an existing MLflow Tracking Server.
" - } - }, - "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest": { - "type": "structure", - "members": { - "TrackingServerName": { - "target": "com.amazonaws.sagemaker#TrackingServerName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the MLflow Tracking Server to update.
", - "smithy.api#required": {} - } - }, - "ArtifactStoreUri": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow\n Tracking Server.
" - } - }, - "TrackingServerSize": { - "target": "com.amazonaws.sagemaker#TrackingServerSize", - "traits": { - "smithy.api#documentation": "The new size for the MLflow Tracking Server.
" - } - }, - "AutomaticModelRegistration": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. \n To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. \n If not specified, AutomaticModelRegistration defaults to False\n
The new weekly maintenance window start day and time to update. The maintenance window day and time should be \n in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse": { - "type": "structure", - "members": { - "TrackingServerArn": { - "target": "com.amazonaws.sagemaker#TrackingServerArn", - "traits": { - "smithy.api#documentation": "The ARN of the updated MLflow Tracking Server.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateModelCard": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateModelCardRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateModelCardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Update an Amazon SageMaker Model Card.
\nYou cannot update both model card content and model card status in a single call.
\nThe name or Amazon Resource Name (ARN) of the model card to update.
", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.sagemaker#ModelCardContent", - "traits": { - "smithy.api#documentation": "The updated model card content. Content must be in model card JSON schema and provided as a string.
\nWhen updating model card content, be sure to include the full content and not just updated content.
" - } - }, - "ModelCardStatus": { - "target": "com.amazonaws.sagemaker#ModelCardStatus", - "traits": { - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The Amazon Resource Name (ARN) of the updated model card.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateModelPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateModelPackageInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateModelPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a versioned model.
" - } - }, - "com.amazonaws.sagemaker#UpdateModelPackageInput": { - "type": "structure", - "members": { - "ModelPackageArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
", - "smithy.api#required": {} - } - }, - "ModelApprovalStatus": { - "target": "com.amazonaws.sagemaker#ModelApprovalStatus", - "traits": { - "smithy.api#documentation": "The approval status of the model.
" - } - }, - "ApprovalDescription": { - "target": "com.amazonaws.sagemaker#ApprovalDescription", - "traits": { - "smithy.api#documentation": "A description for the approval status of the model.
" - } - }, - "CustomerMetadataProperties": { - "target": "com.amazonaws.sagemaker#CustomerMetadataMap", - "traits": { - "smithy.api#documentation": "The metadata properties associated with the model package versions.
" - } - }, - "CustomerMetadataPropertiesToRemove": { - "target": "com.amazonaws.sagemaker#CustomerMetadataKeyList", - "traits": { - "smithy.api#documentation": "The metadata properties associated with the model package versions to remove.
" - } - }, - "AdditionalInferenceSpecificationsToAdd": { - "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", - "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects to be added to the \n existing array additional Inference Specification. Total number of additional \n Inference Specifications can not exceed 15. Each additional Inference Specification \n specifies artifacts based on this model package that can be used on inference endpoints. \n Generally used with SageMaker Neo to store the compiled artifacts.
" - } - }, - "InferenceSpecification": { - "target": "com.amazonaws.sagemaker#InferenceSpecification", - "traits": { - "smithy.api#documentation": "Specifies details about inference jobs that you can run with models based on this model\n package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nThe URI of the source for the model package.
" - } - }, - "ModelCard": { - "target": "com.amazonaws.sagemaker#ModelPackageModelCard", - "traits": { - "smithy.api#documentation": "The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
\n A structure describing the current state of the model in its life cycle.\n
" - } - }, - "ClientToken": { - "target": "com.amazonaws.sagemaker#ClientToken", - "traits": { - "smithy.api#documentation": "\n A unique token that guarantees that the call to this API is idempotent.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateModelPackageOutput": { - "type": "structure", - "members": { - "ModelPackageArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateMonitoringAlert": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateMonitoringAlertRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateMonitoringAlertResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Update the parameters of a model monitor alert.
" - } - }, - "com.amazonaws.sagemaker#UpdateMonitoringAlertRequest": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a monitoring schedule.
", - "smithy.api#required": {} - } - }, - "MonitoringAlertName": { - "target": "com.amazonaws.sagemaker#MonitoringAlertName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a monitoring alert.
", - "smithy.api#required": {} - } - }, - "DatapointsToAlert": { - "target": "com.amazonaws.sagemaker#MonitoringDatapointsToAlert", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Within EvaluationPeriod, how many execution failures will raise an\n alert.
The number of most recent monitoring executions to consider when evaluating alert\n status.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateMonitoringAlertResponse": { - "type": "structure", - "members": { - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", - "smithy.api#required": {} - } - }, - "MonitoringAlertName": { - "target": "com.amazonaws.sagemaker#MonitoringAlertName", - "traits": { - "smithy.api#documentation": "The name of a monitoring alert.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateMonitoringSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateMonitoringScheduleRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateMonitoringScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates a previously created schedule.
" - } - }, - "com.amazonaws.sagemaker#UpdateMonitoringScheduleRequest": { - "type": "structure", - "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "MonitoringScheduleConfig": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateMonitoringScheduleResponse": { - "type": "structure", - "members": { - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateNotebookInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Updates a notebook instance. NotebookInstance updates include upgrading or\n downgrading the ML compute instance used for your notebook instance to accommodate\n changes in your workload requirements.
" - } - }, - "com.amazonaws.sagemaker#UpdateNotebookInstanceInput": { - "type": "structure", - "members": { - "NotebookInstanceName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the notebook instance to update.
", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#InstanceType", - "traits": { - "smithy.api#documentation": "The Amazon ML compute instance type.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to\n access the notebook instance. For more information, see SageMaker AI Roles.
\nTo be able to pass this role to SageMaker AI, the caller of this API must\n have the iam:PassRole permission.
The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.
" - } - }, - "DisassociateLifecycleConfig": { - "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceLifecycleConfig", - "traits": { - "smithy.api#documentation": "Set to true to remove the notebook instance lifecycle configuration\n currently associated with the notebook instance. This operation is idempotent. If you\n specify a lifecycle configuration that is not associated with the notebook instance when\n you call this method, it does not throw an error.
The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't\n determine the amount of available free space on the volume. Because of this, you can\n increase the volume size when you update a notebook instance, but you can't decrease the\n volume size. If you want to decrease the size of the ML storage volume in use, create a\n new notebook instance with the desired size.
" - } - }, - "DefaultCodeRepository": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", - "traits": { - "smithy.api#documentation": "The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" - } - }, - "AdditionalCodeRepositories": { - "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", - "traits": { - "smithy.api#documentation": "An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" - } - }, - "AcceleratorTypes": { - "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", - "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of the EI instance types to associate with\n this notebook instance.
" - } - }, - "DisassociateAcceleratorTypes": { - "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes", - "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of the EI instance types to remove from this notebook\n instance.
" - } - }, - "DisassociateDefaultCodeRepository": { - "target": "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository", - "traits": { - "smithy.api#documentation": "The name or URL of the default Git repository to remove from this notebook instance.\n This operation is idempotent. If you specify a Git repository that is not associated\n with the notebook instance when you call this method, it does not throw an error.
" - } - }, - "DisassociateAdditionalCodeRepositories": { - "target": "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories", - "traits": { - "smithy.api#documentation": "A list of names or URLs of the default Git repositories to remove from this notebook\n instance. This operation is idempotent. If you specify a Git repository that is not\n associated with the notebook instance when you call this method, it does not throw an\n error.
" - } - }, - "RootAccess": { - "target": "com.amazonaws.sagemaker#RootAccess", - "traits": { - "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.
If you set this to Disabled, users don't have root access on the\n notebook instance, but lifecycle configuration scripts still run with root\n permissions.
Information on the IMDS configuration of the notebook instance
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
" - } - }, - "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigInput": { - "type": "structure", - "members": { - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the lifecycle configuration.
", - "smithy.api#required": {} - } - }, - "OnCreate": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", - "traits": { - "smithy.api#documentation": "The shell script that runs only once, when you create a notebook instance. The shell\n script must be a base64-encoded string.
" - } - }, - "OnStart": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", - "traits": { - "smithy.api#documentation": "The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance. The shell script must be a base64-encoded\n string.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateNotebookInstanceOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdatePartnerApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdatePartnerAppRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdatePartnerAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates all of the SageMaker Partner AI Apps in an account.
" - } - }, - "com.amazonaws.sagemaker#UpdatePartnerAppRequest": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#PartnerAppArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to update.
", - "smithy.api#required": {} - } - }, - "MaintenanceConfig": { - "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", - "traits": { - "smithy.api#documentation": "Maintenance configuration settings for the SageMaker Partner AI App.
" - } - }, - "Tier": { - "target": "com.amazonaws.sagemaker#NonEmptyString64", - "traits": { - "smithy.api#documentation": "Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
" - } - }, - "ApplicationConfig": { - "target": "com.amazonaws.sagemaker#PartnerAppConfig", - "traits": { - "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" - } - }, - "EnableIamSessionBasedIdentity": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
A unique token that guarantees that the call to this API is idempotent.
", - "smithy.api#idempotencyToken": {} - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdatePartnerAppResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.sagemaker#PartnerAppArn", - "traits": { - "smithy.api#documentation": "The ARN of the SageMaker Partner AI App that was updated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdatePipeline": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdatePipelineRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdatePipelineResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates a pipeline.
" - } - }, - "com.amazonaws.sagemaker#UpdatePipelineExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdatePipelineExecutionRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdatePipelineExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates a pipeline execution.
" - } - }, - "com.amazonaws.sagemaker#UpdatePipelineExecutionRequest": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", - "smithy.api#required": {} - } - }, - "PipelineExecutionDescription": { - "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", - "traits": { - "smithy.api#documentation": "The description of the pipeline execution.
" - } - }, - "PipelineExecutionDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineExecutionName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline execution.
" - } - }, - "ParallelismConfiguration": { - "target": "com.amazonaws.sagemaker#ParallelismConfiguration", - "traits": { - "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdatePipelineExecutionResponse": { - "type": "structure", - "members": { - "PipelineExecutionArn": { - "target": "com.amazonaws.sagemaker#PipelineExecutionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated pipeline execution.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdatePipelineRequest": { - "type": "structure", - "members": { - "PipelineName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the pipeline to update.
", - "smithy.api#required": {} - } - }, - "PipelineDisplayName": { - "target": "com.amazonaws.sagemaker#PipelineName", - "traits": { - "smithy.api#documentation": "The display name of the pipeline.
" - } - }, - "PipelineDefinition": { - "target": "com.amazonaws.sagemaker#PipelineDefinition", - "traits": { - "smithy.api#documentation": "The JSON pipeline definition.
" - } - }, - "PipelineDefinitionS3Location": { - "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", - "traits": { - "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.
" - } - }, - "PipelineDescription": { - "target": "com.amazonaws.sagemaker#PipelineDescription", - "traits": { - "smithy.api#documentation": "The description of the pipeline.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that the pipeline uses to execute.
" - } - }, - "ParallelismConfiguration": { - "target": "com.amazonaws.sagemaker#ParallelismConfiguration", - "traits": { - "smithy.api#documentation": "If specified, it applies to all executions of this pipeline by default.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdatePipelineResponse": { - "type": "structure", - "members": { - "PipelineArn": { - "target": "com.amazonaws.sagemaker#PipelineArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated pipeline.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateProjectInput" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateProjectOutput" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a machine learning (ML) project that is created from a template that \n sets up an ML pipeline from training to deploying an approved model.
\nYou must not update a project that is in use. If you update the\n ServiceCatalogProvisioningUpdateDetails of a project that is active\n or being created, or updated, you may lose resources already created by the\n project.
The name of the project.
", - "smithy.api#required": {} - } - }, - "ProjectDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "The description for the project.
" - } - }, - "ServiceCatalogProvisioningUpdateDetails": { - "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningUpdateDetails", - "traits": { - "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. \n The provisioning artifact ID will default to the latest provisioning artifact \n ID of the product, if you don't provide the provisioning artifact ID. For more \n information, see What is Amazon Web Services Service Catalog.\n
" - } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your \n Amazon Web Services resources in different ways, for example, by purpose, owner, or \n environment. For more information, see Tagging Amazon Web Services Resources.\n In addition, the project must have tag update constraints set in order to include this \n parameter in the request. For more information, see Amazon Web Services Service \n Catalog Tag Update Constraints.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateProjectOutput": { - "type": "structure", - "members": { - "ProjectArn": { - "target": "com.amazonaws.sagemaker#ProjectArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateSpace": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateSpaceRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateSpaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates the settings of a space.
\nYou can't edit the app type of a space in the SpaceSettings.
The ID of the associated domain.
", - "smithy.api#required": {} - } - }, - "SpaceName": { - "target": "com.amazonaws.sagemaker#SpaceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the space.
", - "smithy.api#required": {} - } - }, - "SpaceSettings": { - "target": "com.amazonaws.sagemaker#SpaceSettings", - "traits": { - "smithy.api#documentation": "A collection of space settings.
" - } - }, - "SpaceDisplayName": { - "target": "com.amazonaws.sagemaker#NonEmptyString64", - "traits": { - "smithy.api#documentation": "The name of the space that appears in the Amazon SageMaker Studio UI.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateSpaceResponse": { - "type": "structure", - "members": { - "SpaceArn": { - "target": "com.amazonaws.sagemaker#SpaceArn", - "traits": { - "smithy.api#documentation": "The space's Amazon Resource Name (ARN).
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateTrainingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateTrainingJobRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateTrainingJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Update a model training job to request a new Debugger profiling configuration or to\n change warm pool retention length.
" - } - }, - "com.amazonaws.sagemaker#UpdateTrainingJobRequest": { - "type": "structure", - "members": { - "TrainingJobName": { - "target": "com.amazonaws.sagemaker#TrainingJobName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a training job to update the Debugger profiling configuration.
", - "smithy.api#required": {} - } - }, - "ProfilerConfig": { - "target": "com.amazonaws.sagemaker#ProfilerConfigForUpdate", - "traits": { - "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and\n storage paths.
" - } - }, - "ProfilerRuleConfigurations": { - "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", - "traits": { - "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.
" - } - }, - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfigForUpdate", - "traits": { - "smithy.api#documentation": "The training job ResourceConfig to update warm pool retention\n length.
Configuration for remote debugging while the training job is running. You can update\n the remote debugging configuration when the SecondaryStatus of the job is\n Downloading or Training.To learn more about the remote\n debugging functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
The Amazon Resource Name (ARN) of the training job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateTrial": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateTrialRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateTrialResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates the display name of a trial.
" - } - }, - "com.amazonaws.sagemaker#UpdateTrialComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateTrialComponentRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateTrialComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates one or more properties of a trial component.
" - } - }, - "com.amazonaws.sagemaker#UpdateTrialComponentRequest": { - "type": "structure", - "members": { - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the component to update.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.
The new status of the component.
" - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component started.
" - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "When the component ended.
" - } - }, - "Parameters": { - "target": "com.amazonaws.sagemaker#TrialComponentParameters", - "traits": { - "smithy.api#documentation": "Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
" - } - }, - "ParametersToRemove": { - "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", - "traits": { - "smithy.api#documentation": "The hyperparameters to remove from the component.
" - } - }, - "InputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", - "traits": { - "smithy.api#documentation": "Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
" - } - }, - "InputArtifactsToRemove": { - "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", - "traits": { - "smithy.api#documentation": "The input artifacts to remove from the component.
" - } - }, - "OutputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", - "traits": { - "smithy.api#documentation": "Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
" - } - }, - "OutputArtifactsToRemove": { - "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", - "traits": { - "smithy.api#documentation": "The output artifacts to remove from the component.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateTrialComponentResponse": { - "type": "structure", - "members": { - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateTrialRequest": { - "type": "structure", - "members": { - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the trial to update.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.
The Amazon Resource Name (ARN) of the trial.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateUserProfileRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateUserProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceInUse" - }, - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - }, - { - "target": "com.amazonaws.sagemaker#ResourceNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Updates a user profile.
" - } - }, - "com.amazonaws.sagemaker#UpdateUserProfileRequest": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The domain ID.
", - "smithy.api#required": {} - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The user profile name.
", - "smithy.api#required": {} - } - }, - "UserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", - "traits": { - "smithy.api#documentation": "A collection of settings.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateUserProfileResponse": { - "type": "structure", - "members": { - "UserProfileArn": { - "target": "com.amazonaws.sagemaker#UserProfileArn", - "traits": { - "smithy.api#documentation": "The user profile Amazon Resource Name (ARN).
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateWorkforce": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateWorkforceRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateWorkforceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ConflictException" - } - ], - "traits": { - "smithy.api#documentation": "Use this operation to update your workforce. You can use this operation to \n require that workers use specific IP addresses to work on tasks\n and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.
\nThe worker portal is now supported in VPC and public internet.
\n Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. \n You specify allowed IP addresses by creating a list of up to ten CIDRs.\n By default, a workforce isn't restricted to specific IP addresses. If you specify a\n range of IP addresses, workers who attempt to access tasks using any IP address outside\n the specified range are denied and get a Not Found error message on\n the worker portal.
To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"10.0.0.0/16\".
Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.
\nUse OidcConfig to update the configuration of a workforce created using\n your own OIDC IdP.
You can only update your OIDC IdP configuration when there are no work teams\n associated with your workforce. You can delete work teams using the DeleteWorkteam operation.
\nAfter restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you\n can view details about your update workforce using the DescribeWorkforce\n operation.
\nThis operation only applies to private workforces.
\nThe name of the private workforce that you want to update. You can find your workforce\n name by using the ListWorkforces operation.
", - "smithy.api#required": {} - } - }, - "SourceIpConfig": { - "target": "com.amazonaws.sagemaker#SourceIpConfig", - "traits": { - "smithy.api#documentation": "A list of one to ten worker IP address ranges (CIDRs) that can be used to\n access tasks assigned to this workforce.
\nMaximum: Ten CIDR values
" - } - }, - "OidcConfig": { - "target": "com.amazonaws.sagemaker#OidcConfig", - "traits": { - "smithy.api#documentation": "Use this parameter to update your OIDC Identity Provider (IdP) \n configuration for a workforce made using your own IdP.
" - } - }, - "WorkforceVpcConfig": { - "target": "com.amazonaws.sagemaker#WorkforceVpcConfigRequest", - "traits": { - "smithy.api#documentation": "Use this parameter to update your VPC configuration for a workforce.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateWorkforceResponse": { - "type": "structure", - "members": { - "Workforce": { - "target": "com.amazonaws.sagemaker#Workforce", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A single private workforce. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sagemaker#UpdateWorkteam": { - "type": "operation", - "input": { - "target": "com.amazonaws.sagemaker#UpdateWorkteamRequest" - }, - "output": { - "target": "com.amazonaws.sagemaker#UpdateWorkteamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Updates an existing work team with new member definitions or description.
" - } - }, - "com.amazonaws.sagemaker#UpdateWorkteamRequest": { - "type": "structure", - "members": { - "WorkteamName": { - "target": "com.amazonaws.sagemaker#WorkteamName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the work team to update.
", - "smithy.api#required": {} - } - }, - "MemberDefinitions": { - "target": "com.amazonaws.sagemaker#MemberDefinitions", - "traits": { - "smithy.api#documentation": "A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition. You should not provide input\n for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want\n to include in your private work team in OidcMemberDefinition by listing\n those groups in Groups. Be aware that user groups that are already in the\n work team must also be listed in Groups when you make this request to\n remain on the work team. If you do not include these user groups, they will no longer be\n associated with the work team you update.
An updated description for the work team.
" - } - }, - "NotificationConfiguration": { - "target": "com.amazonaws.sagemaker#NotificationConfiguration", - "traits": { - "smithy.api#documentation": "Configures SNS topic notifications for available or expiring work items
" - } - }, - "WorkerAccessConfiguration": { - "target": "com.amazonaws.sagemaker#WorkerAccessConfiguration", - "traits": { - "smithy.api#documentation": "Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sagemaker#UpdateWorkteamResponse": { - "type": "structure", - "members": { - "Workteam": { - "target": "com.amazonaws.sagemaker#Workteam", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A Workteam object that describes the updated work team.
The Amazon Resource Name (ARN) of the user's profile.
" - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The name of the user's profile.
" - } - }, - "DomainId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The domain associated with the user.
" - } - }, - "IamIdentity": { - "target": "com.amazonaws.sagemaker#IamIdentity", - "traits": { - "smithy.api#documentation": "The IAM Identity details associated with the user. These details are\n associated with model package groups, model packages, and project entities only.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial\n component, lineage group, project, or model card.
" - } - }, - "com.amazonaws.sagemaker#UserProfileArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/" - } - }, - "com.amazonaws.sagemaker#UserProfileDetails": { - "type": "structure", - "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "The domain ID.
" - } - }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "The user profile name.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#UserProfileStatus", - "traits": { - "smithy.api#documentation": "The status.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "The creation time.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "The last modified time.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The user profile details.
" - } - }, - "com.amazonaws.sagemaker#UserProfileList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#UserProfileDetails" - } - }, - "com.amazonaws.sagemaker#UserProfileName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#UserProfileSortKey": { - "type": "enum", - "members": { - "CreationTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - }, - "LastModifiedTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastModifiedTime" - } - } - } - }, - "com.amazonaws.sagemaker#UserProfileStatus": { - "type": "enum", - "members": { - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "InService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Updating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "Update_Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Update_Failed" - } - }, - "Delete_Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Delete_Failed" - } - } - } - }, - "com.amazonaws.sagemaker#UserSettings": { - "type": "structure", - "members": { - "ExecutionRole": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "The execution role for the user.
\nSageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.sagemaker#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for\n communication.
\nOptional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.
Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for\n the domain.
Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the\n maximum number shown.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" - } - }, - "SharingSettings": { - "target": "com.amazonaws.sagemaker#SharingSettings", - "traits": { - "smithy.api#documentation": "Specifies options for sharing Amazon SageMaker AI Studio notebooks.
" - } - }, - "JupyterServerAppSettings": { - "target": "com.amazonaws.sagemaker#JupyterServerAppSettings", - "traits": { - "smithy.api#documentation": "The Jupyter server's app settings.
" - } - }, - "KernelGatewayAppSettings": { - "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings", - "traits": { - "smithy.api#documentation": "The kernel gateway app settings.
" - } - }, - "TensorBoardAppSettings": { - "target": "com.amazonaws.sagemaker#TensorBoardAppSettings", - "traits": { - "smithy.api#documentation": "The TensorBoard app settings.
" - } - }, - "RStudioServerProAppSettings": { - "target": "com.amazonaws.sagemaker#RStudioServerProAppSettings", - "traits": { - "smithy.api#documentation": "A collection of settings that configure user interaction with the\n RStudioServerPro app.
A collection of settings that configure the RSessionGateway app.
The Canvas app settings.
\nSageMaker applies these settings only to private spaces that SageMaker creates for the Canvas\n app.
" - } - }, - "CodeEditorAppSettings": { - "target": "com.amazonaws.sagemaker#CodeEditorAppSettings", - "traits": { - "smithy.api#documentation": "The Code Editor application settings.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" - } - }, - "JupyterLabAppSettings": { - "target": "com.amazonaws.sagemaker#JupyterLabAppSettings", - "traits": { - "smithy.api#documentation": "The settings for the JupyterLab application.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" - } - }, - "SpaceStorageSettings": { - "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings", - "traits": { - "smithy.api#documentation": "The storage settings for a space.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" - } - }, - "DefaultLandingUri": { - "target": "com.amazonaws.sagemaker#LandingUri", - "traits": { - "smithy.api#documentation": "The default experience that the user is directed to when accessing the domain. The\n supported values are:
\n\n studio::: Indicates that Studio is the default experience. This value can\n only be passed if StudioWebPortal is set to ENABLED.
\n app:JupyterServer:: Indicates that Studio Classic is the default\n experience.
Whether the user can access Studio. If this value is set to DISABLED, the\n user cannot access Studio, even if that is the default experience for the domain.
Details about the POSIX identity that is used for file system operations.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" - } - }, - "CustomFileSystemConfigs": { - "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", - "traits": { - "smithy.api#documentation": "The settings for assigning a custom file system to a user profile. Permitted users can\n access this file system in Amazon SageMaker AI Studio.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" - } - }, - "StudioWebPortalSettings": { - "target": "com.amazonaws.sagemaker#StudioWebPortalSettings", - "traits": { - "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.
" - } - }, - "AutoMountHomeEFS": { - "target": "com.amazonaws.sagemaker#AutoMountHomeEFS", - "traits": { - "smithy.api#documentation": "Indicates whether auto-mounting of an EFS volume is supported for the user profile. The\n DefaultAsDomain value is only supported for user profiles. Do not use the\n DefaultAsDomain value when setting this parameter for a domain.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A collection of settings that apply to users in a domain. These settings are specified\n when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.
\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.
The type of variant property. The supported values are:
\n\n DesiredInstanceCount: Overrides the existing variant instance\n counts using the InitialInstanceCount values in the\n ProductionVariants of CreateEndpointConfig.
\n DesiredWeight: Overrides the existing variant weights using the\n InitialVariantWeight values in the\n ProductionVariants of CreateEndpointConfig.
\n DataCaptureConfig: (Not currently supported.)
Specifies a production variant property type for an Endpoint.
\nIf you are updating an endpoint with the RetainAllVariantProperties\n option of UpdateEndpointInput set to true, the\n VariantProperty objects listed in the\n ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the\n endpoint.
The number of elements in your vector.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration for your vector collection type.
" - } - }, - "com.amazonaws.sagemaker#VendorGuidance": { - "type": "enum", - "members": { - "NOT_PROVIDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_PROVIDED" - } - }, - "STABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STABLE" - } - }, - "TO_BE_ARCHIVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TO_BE_ARCHIVED" - } - }, - "ARCHIVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARCHIVED" - } - } - } - }, - "com.amazonaws.sagemaker#VersionAliasesList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#ImageVersionAliasPattern" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#VersionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.sagemaker#VersionedArnOrName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 176 - }, - "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The Amazon Resource Name (ARN) of the lineage entity resource." - } - }, - "Type": { - "target": "com.amazonaws.sagemaker#String40", - "traits": { - "smithy.api#documentation": "The type of the lineage entity resource. For example: DataSet, Model, Endpoint, \n etc...
The type of resource of the lineage entity.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A lineage entity connected to the starting entity(ies).
" - } - }, - "com.amazonaws.sagemaker#Vertices": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Vertex" - } - }, - "com.amazonaws.sagemaker#VisibilityConditions": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.sagemaker#VisibilityConditionsKey", - "traits": { - "smithy.api#documentation": "The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags..
The value for the tag that you're using to filter the search results.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. \n If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.
" - } - }, - "com.amazonaws.sagemaker#VisibilityConditionsKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.sagemaker#VisibilityConditionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#VisibilityConditions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#VisibilityConditionsValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.sagemaker#VolumeSizeInGB": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.sagemaker#VpcConfig": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#VpcSecurityGroupIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your training job or\n model. For information about the availability of specific instance types, see Supported\n Instance Types and Availability Zones.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources\n have access to. You can control access to and from your resources by configuring a VPC.\n For more information, see Give SageMaker Access to\n Resources in your Amazon VPC.
" - } - }, - "com.amazonaws.sagemaker#VpcId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.sagemaker#VpcOnlyTrustedAccounts": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#AccountId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.sagemaker#VpcSecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#SecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#WaitIntervalInSeconds": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 3600 - } - } - }, - "com.amazonaws.sagemaker#WarmPoolResourceStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Available" - } - }, - "TERMINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terminated" - } - }, - "REUSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Reused" - } - }, - "INUSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InUse" - } - } - } - }, - "com.amazonaws.sagemaker#WarmPoolStatus": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.sagemaker#WarmPoolResourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the warm pool.
\n\n InUse: The warm pool is in use for the training job.
\n Available: The warm pool is available to reuse for a matching\n training job.
\n Reused: The warm pool moved to a matching training job for\n reuse.
\n Terminated: The warm pool is no longer available. Warm pools are\n unavailable if they are terminated by a user, terminated for a patch update, or\n terminated for exceeding the specified\n KeepAlivePeriodInSeconds.
The billable time in seconds used by the warm pool. Billable time refers to the\n absolute wall-clock time.
\nMultiply ResourceRetainedBillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run warm pool training. The formula is as follows:\n ResourceRetainedBillableTimeInSeconds * InstanceCount.
The name of the matching training job that reused the warm pool.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Status and billing information about the warm pool.
" - } - }, - "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 9 - }, - "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$" - } - }, - "com.amazonaws.sagemaker#WeeklyScheduleTimeFormat": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 9 - }, - "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$" - } - }, - "com.amazonaws.sagemaker#WorkerAccessConfiguration": { - "type": "structure", - "members": { - "S3Presign": { - "target": "com.amazonaws.sagemaker#S3Presign", - "traits": { - "smithy.api#documentation": "Defines any Amazon S3 resource constraints.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
" - } - }, - "com.amazonaws.sagemaker#Workforce": { - "type": "structure", - "members": { - "WorkforceName": { - "target": "com.amazonaws.sagemaker#WorkforceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the private workforce.
", - "smithy.api#required": {} - } - }, - "WorkforceArn": { - "target": "com.amazonaws.sagemaker#WorkforceArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the private workforce.
", - "smithy.api#required": {} - } - }, - "LastUpdatedDate": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The most recent date that UpdateWorkforce was used to\n successfully add one or more IP address ranges (CIDRs) to a private workforce's\n allow list.
" - } - }, - "SourceIpConfig": { - "target": "com.amazonaws.sagemaker#SourceIpConfig", - "traits": { - "smithy.api#documentation": "A list of one to ten IP address ranges (CIDRs) to be added to the\n workforce allow list. By default, a workforce isn't restricted to specific IP addresses.
" - } - }, - "SubDomain": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The subdomain for your OIDC Identity Provider.
" - } - }, - "CognitoConfig": { - "target": "com.amazonaws.sagemaker#CognitoConfig", - "traits": { - "smithy.api#documentation": "The configuration of an Amazon Cognito workforce. \n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.
" - } - }, - "OidcConfig": { - "target": "com.amazonaws.sagemaker#OidcConfigForResponse", - "traits": { - "smithy.api#documentation": "The configuration of an OIDC Identity Provider (IdP) private workforce.
" - } - }, - "CreateDate": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date that the workforce is created.
" - } - }, - "WorkforceVpcConfig": { - "target": "com.amazonaws.sagemaker#WorkforceVpcConfigResponse", - "traits": { - "smithy.api#documentation": "The configuration of a VPC workforce.
" - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#WorkforceStatus", - "traits": { - "smithy.api#documentation": "The status of your workforce.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#WorkforceFailureReason", - "traits": { - "smithy.api#documentation": "The reason your workforce failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
" - } - }, - "com.amazonaws.sagemaker#WorkforceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/" - } - }, - "com.amazonaws.sagemaker#WorkforceFailureReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.sagemaker#WorkforceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$" - } - }, - "com.amazonaws.sagemaker#WorkforceSecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^sg-[0-9a-z]*$" - } - }, - "com.amazonaws.sagemaker#WorkforceSecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.sagemaker#WorkforceStatus": { - "type": "enum", - "members": { - "INITIALIZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Initializing" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - } - } - }, - "com.amazonaws.sagemaker#WorkforceSubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^subnet-[0-9a-z]*$" - } - }, - "com.amazonaws.sagemaker#WorkforceSubnets": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#WorkforceSubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.sagemaker#WorkforceVpcConfigRequest": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.sagemaker#WorkforceVpcId", - "traits": { - "smithy.api#documentation": "The ID of the VPC that the workforce uses for communication.
" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupIds", - "traits": { - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
The ID of the subnets in the VPC that you want to connect.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The VPC object you use to create or update a workforce.
" - } - }, - "com.amazonaws.sagemaker#WorkforceVpcConfigResponse": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.sagemaker#WorkforceVpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the VPC that the workforce uses for communication.
", - "smithy.api#required": {} - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
", - "smithy.api#required": {} - } - }, - "Subnets": { - "target": "com.amazonaws.sagemaker#WorkforceSubnets", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the subnets in the VPC that you want to connect.
", - "smithy.api#required": {} - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.sagemaker#WorkforceVpcEndpointId", - "traits": { - "smithy.api#documentation": "The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your workforce to connect to.
" - } - }, - "com.amazonaws.sagemaker#WorkforceVpcEndpointId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^vpce-[0-9a-z]*$" - } - }, - "com.amazonaws.sagemaker#WorkforceVpcId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^vpc-[0-9a-z]*$" - } - }, - "com.amazonaws.sagemaker#Workforces": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Workforce" - } - }, - "com.amazonaws.sagemaker#WorkspaceSettings": { - "type": "structure", - "members": { - "S3ArtifactPath": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts\n existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users\n must log out and log back in to apply the new location.
" - } - }, - "S3KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The workspace settings for the SageMaker Canvas application.
" - } - }, - "com.amazonaws.sagemaker#Workteam": { - "type": "structure", - "members": { - "WorkteamName": { - "target": "com.amazonaws.sagemaker#WorkteamName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the work team.
", - "smithy.api#required": {} - } - }, - "MemberDefinitions": { - "target": "com.amazonaws.sagemaker#MemberDefinitions", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition.
The Amazon Resource Name (ARN) that identifies the work team.
", - "smithy.api#required": {} - } - }, - "WorkforceArn": { - "target": "com.amazonaws.sagemaker#WorkforceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workforce.
" - } - }, - "ProductListingIds": { - "target": "com.amazonaws.sagemaker#ProductListings", - "traits": { - "smithy.api#documentation": "The Amazon Marketplace identifier for a vendor's work team.
" - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#String200", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A description of the work team.
", - "smithy.api#required": {} - } - }, - "SubDomain": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "The URI of the labeling job's user interface. Workers open this URI to start labeling\n your data objects.
" - } - }, - "CreateDate": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the work team was created (timestamp).
" - } - }, - "LastUpdatedDate": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the work team was last updated (timestamp).
" - } - }, - "NotificationConfiguration": { - "target": "com.amazonaws.sagemaker#NotificationConfiguration", - "traits": { - "smithy.api#documentation": "Configures SNS notifications of available or expiring work items for work\n teams.
" - } - }, - "WorkerAccessConfiguration": { - "target": "com.amazonaws.sagemaker#WorkerAccessConfiguration", - "traits": { - "smithy.api#documentation": "Describes any access constraints that have been defined for Amazon S3 resources.
" - } + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.sagemaker#Accept": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AcceptEula": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.sagemaker#ActionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/" + } + }, + "com.amazonaws.sagemaker#ActionSource": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the source.
", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the source.
" + } + }, + "SourceId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The ID of the source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure describing the source of an action.
" + } + }, + "com.amazonaws.sagemaker#ActionStatus": { + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#ActionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ActionSummary" + } + }, + "com.amazonaws.sagemaker#ActionSummary": { + "type": "structure", + "members": { + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" + } + }, + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the action.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ActionSource", + "traits": { + "smithy.api#documentation": "The source of the action.
" + } + }, + "ActionType": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#documentation": "The type of the action.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the action was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the action was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Lists the properties of an action. An action represents an action\n or activity. Some examples are a workflow step and a model deployment. Generally, an\n action involves at least one input artifact or output artifact.
" + } + }, + "com.amazonaws.sagemaker#ActivationState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#AddAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#AddAssociationRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#AddAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates an association between the source and the destination. A\n source can be associated with multiple destinations, and a destination can be associated\n with multiple sources. An association is a lineage tracking entity. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" + } + }, + "com.amazonaws.sagemaker#AddAssociationRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the source.
", + "smithy.api#required": {} + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
", + "smithy.api#required": {} + } + }, + "AssociationType": { + "target": "com.amazonaws.sagemaker#AssociationEdgeType", + "traits": { + "smithy.api#documentation": "The type of association. The following are suggested uses for each type. Amazon SageMaker\n places no restrictions on their use.
\nContributedTo - The source contributed to the destination or had a part in\n enabling the destination. For example, the training data contributed to the training\n job.
\nAssociatedWith - The source is connected to the destination. For example, an\n approval workflow is associated with a model deployment.
\nDerivedFrom - The destination is a modification of the source. For example, a digest\n output of a channel input for a processing job is derived from the original inputs.
\nProduced - The source generated the destination. For example, a training job\n produced a model artifact.
\nThe ARN of the source.
" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#AddTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#AddTagsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#AddTagsOutput" + }, + "traits": { + "smithy.api#documentation": "Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.
\nEach tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.
\nTags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n
Tags that you add to a SageMaker Domain or User Profile by calling this API are\n also added to any Apps that the Domain or User Profile launches after you call this\n API, but not to Apps that the Domain or User Profile launched before you called this\n API. To make sure that the tags associated with a Domain or User Profile are also\n added to all Apps that the Domain or User Profile launches, add the tags when you\n first create the Domain or User Profile by specifying them in the Tags\n parameter of CreateDomain\n or CreateUserProfile.
The Amazon Resource Name (ARN) of the resource that you want to tag.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#AddTagsOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags associated with the SageMaker resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#AdditionalInferenceSpecificationDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique name to identify the additional inference specification. The name must \n be unique within the list of your additional inference specifications for a \n particular model package.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A description of the additional Inference specification
" + } + }, + "Containers": { + "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon ECR registry path of the Docker image that contains the inference code.
", + "smithy.api#required": {} + } + }, + "SupportedTransformInstanceTypes": { + "target": "com.amazonaws.sagemaker#TransformInstanceTypes", + "traits": { + "smithy.api#documentation": "A list of the instance types on which a transformation job can be run \n or on which an endpoint can be deployed.
" + } + }, + "SupportedRealtimeInferenceInstanceTypes": { + "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", + "traits": { + "smithy.api#documentation": "A list of the instance types that are used to generate inferences in real-time.
" + } + }, + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#ContentTypes", + "traits": { + "smithy.api#documentation": "The supported MIME types for the input data.
" + } + }, + "SupportedResponseMIMETypes": { + "target": "com.amazonaws.sagemaker#ResponseMIMETypes", + "traits": { + "smithy.api#documentation": "The supported MIME types for the output data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure of additional Inference Specification. Additional Inference Specification \n specifies details about inference jobs that can be run with models based on\n this model package
" + } + }, + "com.amazonaws.sagemaker#AdditionalInferenceSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecificationDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + } + } + }, + "com.amazonaws.sagemaker#AdditionalModelChannelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$" + } + }, + "com.amazonaws.sagemaker#AdditionalModelDataSource": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.sagemaker#AdditionalModelChannelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A custom name for this AdditionalModelDataSource object.
Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.
The data type of the additional data source that you specify for use in inference or\n training.
", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The uniform resource identifier (URI) used to identify an additional data source used\n in inference or training.
", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "The type of compression used for an additional data source used in inference or\n training. Specify None if your additional data source is not\n compressed.
The ETag associated with S3 URI.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A data source used for training or inference that is in addition to the input dataset\n or model data.
" + } + }, + "com.amazonaws.sagemaker#AdditionalS3DataSourceDataType": { + "type": "enum", + "members": { + "S3OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Object" + } + }, + "S3PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + } + } + }, + "com.amazonaws.sagemaker#AgentVersion": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Version of the agent.
", + "smithy.api#required": {} + } + }, + "AgentCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of Edge Manager agents.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Edge Manager agent version.
" + } + }, + "com.amazonaws.sagemaker#AgentVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AgentVersion" + } + }, + "com.amazonaws.sagemaker#AggregationTransformationValue": { + "type": "enum", + "members": { + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sum" + } + }, + "Avg": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "avg" + } + }, + "First": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "first" + } + }, + "Min": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "min" + } + }, + "Max": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "max" + } + } + } + }, + "com.amazonaws.sagemaker#AggregationTransformations": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TransformationAttributeName" + }, + "value": { + "target": "com.amazonaws.sagemaker#AggregationTransformationValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#Alarm": { + "type": "structure", + "members": { + "AlarmName": { + "target": "com.amazonaws.sagemaker#AlarmName", + "traits": { + "smithy.api#documentation": "The name of a CloudWatch alarm in your account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
" + } + }, + "com.amazonaws.sagemaker#AlarmList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Alarm" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#AlarmName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.sagemaker#AlgorithmArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#AlgorithmImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AlgorithmSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#AlgorithmSpecification": { + "type": "structure", + "members": { + "TrainingImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#documentation": "The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry\n Paths and Example Code in the Amazon SageMaker developer guide.\n SageMaker supports both registry/repository[:tag] and\n registry/repository[@digest] image path formats. For more information\n about using your custom training container, see Using Your Own Algorithms with\n Amazon SageMaker.
You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.
For more information, see the note in the AlgorithmName parameter\n description.
The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services\n Marketplace.
\nYou must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.
Note that the AlgorithmName parameter is mutually exclusive with the\n TrainingImage parameter. If you specify a value for the\n AlgorithmName parameter, you can't specify a value for\n TrainingImage, and vice versa.
If you specify values for both parameters, the training job might break; if you\n don't specify any value for both parameters, the training job might raise a\n null error.
A list of metric definition objects. Each object specifies the metric name and regular\n expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.
" + } + }, + "EnableSageMakerMetricsTimeSeries": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:
You use one of the SageMaker built-in algorithms
\nYou use one of the following Prebuilt SageMaker Docker Images:
\nTensorflow (version >= 1.15)
\nMXNet (version >= 1.6)
\nPyTorch (version >= 1.3)
\nYou specify at least one MetricDefinition\n
\nThe entrypoint script\n for a Docker container used to run a training job. This script takes\n precedence over the default train processing instructions. See How Amazon SageMaker\n Runs Your Training Image for more information.
" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#TrainingContainerArguments", + "traits": { + "smithy.api#documentation": "The arguments for a container used to run a training job. See How Amazon SageMaker\n Runs Your Training Image for additional information.
" + } + }, + "TrainingImageConfig": { + "target": "com.amazonaws.sagemaker#TrainingImageConfig", + "traits": { + "smithy.api#documentation": "The configuration to use an image from a private Docker registry for a training\n job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the training algorithm to use in a CreateTrainingJob request.
\nSageMaker uses its own SageMaker account credentials to pull and access built-in algorithms\n so built-in algorithms are universally accessible across all Amazon Web Services accounts. As a\n result, built-in algorithms have standard, unrestricted access. You cannot restrict\n built-in algorithms using IAM roles. Use custom algorithms if you require specific\n access controls.
\nFor more information about algorithms provided by SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.
" + } + }, + "com.amazonaws.sagemaker#AlgorithmStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#AlgorithmStatusDetails": { + "type": "structure", + "members": { + "ValidationStatuses": { + "target": "com.amazonaws.sagemaker#AlgorithmStatusItemList", + "traits": { + "smithy.api#documentation": "The status of algorithm validation.
" + } + }, + "ImageScanStatuses": { + "target": "com.amazonaws.sagemaker#AlgorithmStatusItemList", + "traits": { + "smithy.api#documentation": "The status of the scan of the algorithm's Docker image container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the validation and image scan statuses of the algorithm.
" + } + }, + "com.amazonaws.sagemaker#AlgorithmStatusItem": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the algorithm for which the overall status is being reported.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#DetailedAlgorithmStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "if the overall status is Failed, the reason for the failure.
Represents the overall status of an algorithm.
" + } + }, + "com.amazonaws.sagemaker#AlgorithmStatusItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AlgorithmStatusItem" + } + }, + "com.amazonaws.sagemaker#AlgorithmSummary": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the algorithm that is described by the summary.
", + "smithy.api#required": {} + } + }, + "AlgorithmArn": { + "target": "com.amazonaws.sagemaker#AlgorithmArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the algorithm.
", + "smithy.api#required": {} + } + }, + "AlgorithmDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A brief description of the algorithm.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the algorithm was created.
", + "smithy.api#required": {} + } + }, + "AlgorithmStatus": { + "target": "com.amazonaws.sagemaker#AlgorithmStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The overall status of the algorithm.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about an algorithm.
" + } + }, + "com.amazonaws.sagemaker#AlgorithmSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AlgorithmSummary" + } + }, + "com.amazonaws.sagemaker#AlgorithmValidationProfile": { + "type": "structure", + "members": { + "ProfileName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the profile for the algorithm. The name must have 1 to 63 characters.\n Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#required": {} + } + }, + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#TrainingJobDefinition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The TrainingJobDefinition object that describes the training job that\n SageMaker runs to validate your algorithm.
The TransformJobDefinition object that describes the transform job that\n SageMaker runs to validate your algorithm.
Defines a training job and a batch transform job that SageMaker runs to validate your\n algorithm.
\nThe data provided in the validation profile is made available to your buyers on\n Amazon Web Services Marketplace.
" + } + }, + "com.amazonaws.sagemaker#AlgorithmValidationProfiles": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AlgorithmValidationProfile" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#AlgorithmValidationSpecification": { + "type": "structure", + "members": { + "ValidationRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IAM roles that SageMaker uses to run the training jobs.
", + "smithy.api#required": {} + } + }, + "ValidationProfiles": { + "target": "com.amazonaws.sagemaker#AlgorithmValidationProfiles", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of AlgorithmValidationProfile objects, each of which specifies a\n training job and batch transform job that SageMaker runs to validate your algorithm.
Specifies configurations for one or more training jobs that SageMaker runs to test the\n algorithm.
" + } + }, + "com.amazonaws.sagemaker#AmazonQSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "Whether Amazon Q has been enabled within the domain.
" + } + }, + "QProfileArn": { + "target": "com.amazonaws.sagemaker#QProfileArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Q profile used within the domain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain.
" + } + }, + "com.amazonaws.sagemaker#AnnotationConsolidationConfig": { + "type": "structure", + "members": { + "AnnotationConsolidationLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.
\nFor built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.
\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox\n
\n Image classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass\n
\n Multi-label image classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel\n
\n Semantic segmentation - Treats each pixel in an image\n as a multi-class classification and treats pixel annotations from workers as \"votes\" for\n the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation\n
\n Text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of text based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass\n
\n Multi-label text classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel\n
\n Named entity recognition - Groups similar selections\n and calculates aggregate boundaries, resolving to most-assigned label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition\n
\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass\n
\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection\n
\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking\n
\n 3D Point Cloud Object Detection - Use this task type\n when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids\n around objects. For example, you can use this task type to ask workers to identify\n different types of objects in a point cloud, such as cars, bikes, and\n pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection\n
\n 3D Point Cloud Object Tracking - Use this task type\n when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D\n point cloud frames. For example, you can use this task type to ask workers to track the\n movement of vehicles across multiple point cloud frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking\n
\n 3D Point Cloud Semantic Segmentation - Use this task\n type when you want workers to create a point-level semantic segmentation masks by\n painting objects in a 3D point cloud using different colors where each color is assigned\n to one of the classes you specify.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation\n
\n Use the following ARNs for Label Verification and Adjustment Jobs\n
\nUse label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .
\n\n Semantic Segmentation Adjustment - Treats each pixel\n in an image as a multi-class classification and treats pixel adjusted annotations from\n workers as \"votes\" for the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation\n
\n Semantic Segmentation Verification - Uses a variant\n of the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation\n
\n Bounding Box Adjustment - Finds the most similar\n boxes from different workers based on the Jaccard index of the adjusted\n annotations.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox\n
\n Bounding Box Verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification judgement\n for bounding box labels based on annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox\n
\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection\n
\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking\n
\n 3D Point Cloud Object Detection Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n 3D Point Cloud Object Tracking Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects that appear in a\n sequence of 3D point cloud frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n 3D Point Cloud Semantic Segmentation Adjustment - Use this task\n type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
Configures how labels are consolidated across human workers and processes output data.
" + } + }, + "com.amazonaws.sagemaker#AppArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/" + } + }, + "com.amazonaws.sagemaker#AppDetails": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "The domain ID.
" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "The user profile name.
" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "The name of the space.
" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "The type of app.
" + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#documentation": "The name of the app.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#AppStatus", + "traits": { + "smithy.api#documentation": "The status.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "The creation time.
" + } + }, + "ResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + } + }, + "traits": { + "smithy.api#documentation": "Details about an Amazon SageMaker AI app.
" + } + }, + "com.amazonaws.sagemaker#AppImageConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/" + } + }, + "com.amazonaws.sagemaker#AppImageConfigDetails": { + "type": "structure", + "members": { + "AppImageConfigArn": { + "target": "com.amazonaws.sagemaker#AppImageConfigArn", + "traits": { + "smithy.api#documentation": "The ARN of the AppImageConfig.
" + } + }, + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#documentation": "The name of the AppImageConfig. Must be unique to your account.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the AppImageConfig was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the AppImageConfig was last modified.
" + } + }, + "KernelGatewayImageConfig": { + "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", + "traits": { + "smithy.api#documentation": "The configuration for the file system and kernels in the SageMaker AI image.
" + } + }, + "JupyterLabAppImageConfig": { + "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", + "traits": { + "smithy.api#documentation": "The configuration for the file system and the runtime, such as the environment variables and entry point.
" + } + }, + "CodeEditorAppImageConfig": { + "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", + "traits": { + "smithy.api#documentation": "The configuration for the file system and the runtime, \n such as the environment variables and entry point.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for running a SageMaker AI image as a KernelGateway app.
" + } + }, + "com.amazonaws.sagemaker#AppImageConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppImageConfigDetails" + } + }, + "com.amazonaws.sagemaker#AppImageConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#AppImageConfigSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + }, + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.sagemaker#AppInstanceType": { + "type": "enum", + "members": { + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "system" + } + }, + "ML_T3_MICRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.micro" + } + }, + "ML_T3_SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.small" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.8xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.16xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.large" + } + }, + "ML_M5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.xlarge" + } + }, + "ML_M5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.2xlarge" + } + }, + "ML_M5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.4xlarge" + } + }, + "ML_M5D_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.8xlarge" + } + }, + "ML_M5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.12xlarge" + } + }, + "ML_M5D_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.16xlarge" + } + }, + "ML_M5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.24xlarge" + } + }, + "ML_C5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.large" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.12xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.24xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_P3DN_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3dn.24xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.8xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.16xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_G6E_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.xlarge" + } + }, + "ML_G6E_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.2xlarge" + } + }, + "ML_G6E_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.4xlarge" + } + }, + "ML_G6E_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.8xlarge" + } + }, + "ML_G6E_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.12xlarge" + } + }, + "ML_G6E_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.16xlarge" + } + }, + "ML_G6E_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.24xlarge" + } + }, + "ML_G6E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.48xlarge" + } + }, + "ML_GEOSPATIAL_INTERACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.geospatial.interactive" + } + }, + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + }, + "ML_M6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.large" + } + }, + "ML_M6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.xlarge" + } + }, + "ML_M6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.2xlarge" + } + }, + "ML_M6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.4xlarge" + } + }, + "ML_M6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.8xlarge" + } + }, + "ML_M6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.12xlarge" + } + }, + "ML_M6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.16xlarge" + } + }, + "ML_M6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.24xlarge" + } + }, + "ML_M6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.32xlarge" + } + }, + "ML_C6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.large" + } + }, + "ML_C6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.xlarge" + } + }, + "ML_C6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.2xlarge" + } + }, + "ML_C6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.4xlarge" + } + }, + "ML_C6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.8xlarge" + } + }, + "ML_C6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.12xlarge" + } + }, + "ML_C6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.16xlarge" + } + }, + "ML_C6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.24xlarge" + } + }, + "ML_C6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.32xlarge" + } + }, + "ML_R6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.large" + } + }, + "ML_R6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.xlarge" + } + }, + "ML_R6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.2xlarge" + } + }, + "ML_R6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.4xlarge" + } + }, + "ML_R6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.8xlarge" + } + }, + "ML_R6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.12xlarge" + } + }, + "ML_R6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.16xlarge" + } + }, + "ML_R6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.24xlarge" + } + }, + "ML_R6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.32xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#AppLifecycleManagement": { + "type": "structure", + "members": { + "IdleSettings": { + "target": "com.amazonaws.sagemaker#IdleSettings", + "traits": { + "smithy.api#documentation": "Settings related to idle shutdown of Studio applications.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications.
" + } + }, + "com.amazonaws.sagemaker#AppList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppDetails" + } + }, + "com.amazonaws.sagemaker#AppManaged": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#AppName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#AppNetworkAccessType": { + "type": "enum", + "members": { + "PublicInternetOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PublicInternetOnly" + } + }, + "VpcOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VpcOnly" + } + } + } + }, + "com.amazonaws.sagemaker#AppSecurityGroupManagement": { + "type": "enum", + "members": { + "Service": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Service" + } + }, + "Customer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Customer" + } + } + } + }, + "com.amazonaws.sagemaker#AppSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#AppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The container image to be run by the processing job.
", + "smithy.api#required": {} + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "traits": { + "smithy.api#documentation": "The entrypoint for a container used to run a processing job.
" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#ContainerArguments", + "traits": { + "smithy.api#documentation": "The arguments for a container used to run a processing job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration to run a processing job in a specified container image.
" + } + }, + "com.amazonaws.sagemaker#AppStatus": { + "type": "enum", + "members": { + "Deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + } + } + }, + "com.amazonaws.sagemaker#AppType": { + "type": "enum", + "members": { + "JupyterServer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JupyterServer" + } + }, + "KernelGateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KernelGateway" + } + }, + "DetailedProfiler": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetailedProfiler" + } + }, + "TensorBoard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TensorBoard" + } + }, + "CodeEditor": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CodeEditor" + } + }, + "JupyterLab": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JupyterLab" + } + }, + "RStudioServerPro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RStudioServerPro" + } + }, + "RSessionGateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSessionGateway" + } + }, + "Canvas": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Canvas" + } + } + } + }, + "com.amazonaws.sagemaker#ApprovalDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ArnOrName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 170 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The URI of the source.", + "smithy.api#required": {} + } + }, + "SourceTypes": { + "target": "com.amazonaws.sagemaker#ArtifactSourceTypes", + "traits": { + "smithy.api#documentation": "A list of source types.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure describing the source of an artifact.
" + } + }, + "com.amazonaws.sagemaker#ArtifactSourceIdType": { + "type": "enum", + "members": { + "MD5_HASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD5Hash" + } + }, + "S3_ETAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3ETag" + } + }, + "S3_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Version" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Custom" + } + } + } + }, + "com.amazonaws.sagemaker#ArtifactSourceType": { + "type": "structure", + "members": { + "SourceIdType": { + "target": "com.amazonaws.sagemaker#ArtifactSourceIdType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of ID.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The ID and ID type of an artifact source.
" + } + }, + "com.amazonaws.sagemaker#ArtifactSourceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ArtifactSourceType" + } + }, + "com.amazonaws.sagemaker#ArtifactSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ArtifactSummary" + } + }, + "com.amazonaws.sagemaker#ArtifactSummary": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" + } + }, + "ArtifactName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the artifact.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ArtifactSource", + "traits": { + "smithy.api#documentation": "The source of the artifact.
" + } + }, + "ArtifactType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the artifact.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the artifact was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the artifact was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Lists a summary of the properties of an artifact. An artifact represents a URI\n addressable object or data. Some examples are a dataset and a model.
" + } + }, + "com.amazonaws.sagemaker#AssemblyType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Line" + } + } + } + }, + "com.amazonaws.sagemaker#AssociateTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#AssociateTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#AssociateTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Associates a trial component with a trial. A trial component can be associated with\n multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
" + } + }, + "com.amazonaws.sagemaker#AssociateTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the component to associated with the trial.
", + "smithy.api#required": {} + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the trial to associate with.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#AssociateTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" + } + }, + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#AssociationEdgeType": { + "type": "enum", + "members": { + "CONTRIBUTED_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContributedTo" + } + }, + "ASSOCIATED_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociatedWith" + } + }, + "DERIVED_FROM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DerivedFrom" + } + }, + "PRODUCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Produced" + } + }, + "SAME_AS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SameAs" + } + } + } + }, + "com.amazonaws.sagemaker#AssociationEntityArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/" + } + }, + "com.amazonaws.sagemaker#AssociationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AssociationSummary" + } + }, + "com.amazonaws.sagemaker#AssociationSummary": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "The ARN of the source.
" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
" + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The source type.
" + } + }, + "DestinationType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The destination type.
" + } + }, + "AssociationType": { + "target": "com.amazonaws.sagemaker#AssociationEdgeType", + "traits": { + "smithy.api#documentation": "The type of the association.
" + } + }, + "SourceName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the source.
" + } + }, + "DestinationName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the destination.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the association was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#documentation": "Lists a summary of the properties of an association. An association is an entity that\n links other lineage or experiment entities. An example would be an association between a\n training job and a model.
" + } + }, + "com.amazonaws.sagemaker#AssumableRoleArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RoleArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#AsyncInferenceClientConfig": { + "type": "structure", + "members": { + "MaxConcurrentInvocationsPerInstance": { + "target": "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent requests sent by the SageMaker client to the model\n container. If no value is provided, SageMaker chooses an optimal value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.
" + } + }, + "com.amazonaws.sagemaker#AsyncInferenceConfig": { + "type": "structure", + "members": { + "ClientConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceClientConfig", + "traits": { + "smithy.api#documentation": "Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.
" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the configuration for asynchronous inference invocation outputs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies configuration for how an endpoint performs asynchronous inference.
" + } + }, + "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig": { + "type": "structure", + "members": { + "SuccessTopic": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#documentation": "Amazon SNS topic to post a notification to when inference completes successfully. If no\n topic is provided, no notification is sent on success.
" + } + }, + "ErrorTopic": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#documentation": "Amazon SNS topic to post a notification to when inference fails. If no topic is provided,\n no notification is sent on failure.
" + } + }, + "IncludeInferenceResponseIn": { + "target": "com.amazonaws.sagemaker#AsyncNotificationTopicTypeList", + "traits": { + "smithy.api#documentation": "The Amazon SNS topics where you want the inference response to be included.
\nThe inference response is included only if the response size is less than or equal\n to 128 KB.
\nSpecifies the configuration for notifications of inference results for asynchronous\n inference.
" + } + }, + "com.amazonaws.sagemaker#AsyncInferenceOutputConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the asynchronous inference output in Amazon S3.
\n " + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 location to upload inference responses to.
" + } + }, + "NotificationConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig", + "traits": { + "smithy.api#documentation": "Specifies the configuration for notifications of inference results for asynchronous\n inference.
" + } + }, + "S3FailurePath": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 location to upload failure inference responses to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the configuration for asynchronous inference invocation outputs.
" + } + }, + "com.amazonaws.sagemaker#AsyncNotificationTopicTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AsyncNotificationTopicTypes" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#AsyncNotificationTopicTypes": { + "type": "enum", + "members": { + "SUCCESS_NOTIFICATION_TOPIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS_NOTIFICATION_TOPIC" + } + }, + "ERROR_NOTIFICATION_TOPIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR_NOTIFICATION_TOPIC" + } + } + } + }, + "com.amazonaws.sagemaker#AthenaCatalog": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of the data catalog used in Athena query execution.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.sagemaker#AthenaDatabase": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of the database used in the Athena query execution.
", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AthenaDatasetDefinition": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.sagemaker#AthenaCatalog", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.sagemaker#AthenaDatabase", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.sagemaker#AthenaQueryString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "WorkGroup": { + "target": "com.amazonaws.sagemaker#AthenaWorkGroup" + }, + "OutputS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location in Amazon S3 where Athena query results are stored.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from\n an Athena query execution.
" + } + }, + "OutputFormat": { + "target": "com.amazonaws.sagemaker#AthenaResultFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "OutputCompression": { + "target": "com.amazonaws.sagemaker#AthenaResultCompressionType" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for Athena Dataset Definition input.
" + } + }, + "com.amazonaws.sagemaker#AthenaQueryString": { + "type": "string", + "traits": { + "smithy.api#documentation": "The SQL query statements, to be executed.
", + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.sagemaker#AthenaResultCompressionType": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "SNAPPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPPY" + } + }, + "ZLIB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZLIB" + } + } + }, + "traits": { + "smithy.api#documentation": "The compression used for Athena query results.
" + } + }, + "com.amazonaws.sagemaker#AthenaResultFormat": { + "type": "enum", + "members": { + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "ORC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORC" + } + }, + "AVRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVRO" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "TEXTFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTFILE" + } + } + }, + "traits": { + "smithy.api#documentation": "The data storage format for Athena query results.
" + } + }, + "com.amazonaws.sagemaker#AthenaWorkGroup": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of the workgroup in which the Athena query is being started.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#AttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#AttributeNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AttributeName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#AuthMode": { + "type": "enum", + "members": { + "SSO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSO" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + } + } + }, + "com.amazonaws.sagemaker#AuthenticationRequestExtraParams": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AuthenticationRequestExtraParamsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#AutoGenerateEndpointName": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#AutoMLAlgorithm": { + "type": "enum", + "members": { + "XGBOOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xgboost" + } + }, + "LINEAR_LEARNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "linear-learner" + } + }, + "MLP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mlp" + } + }, + "LIGHTGBM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lightgbm" + } + }, + "CATBOOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "catboost" + } + }, + "RANDOMFOREST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "randomforest" + } + }, + "EXTRA_TREES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "extra-trees" + } + }, + "NN_TORCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nn-torch" + } + }, + "FASTAI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fastai" + } + }, + "CNN_QR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cnn-qr" + } + }, + "DEEPAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deepar" + } + }, + "PROPHET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prophet" + } + }, + "NPTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "npts" + } + }, + "ARIMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arima" + } + }, + "ETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ets" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLAlgorithmConfig": { + "type": "structure", + "members": { + "AutoMLAlgorithms": { + "target": "com.amazonaws.sagemaker#AutoMLAlgorithms", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.
\n\n For the tabular problem type\n TabularJobConfig:\n
Selected algorithms must belong to the list corresponding to the training mode\n set in AutoMLJobConfig.Mode (ENSEMBLING or\n HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.
In ENSEMBLING mode:
\"catboost\"
\n\"extra-trees\"
\n\"fastai\"
\n\"lightgbm\"
\n\"linear-learner\"
\n\"nn-torch\"
\n\"randomforest\"
\n\"xgboost\"
\nIn HYPERPARAMETER_TUNING mode:
\"linear-learner\"
\n\"mlp\"
\n\"xgboost\"
\n\n For the time-series forecasting problem type\n TimeSeriesForecastingJobConfig:\n
Choose your algorithms from this list.
\n\"cnn-qr\"
\n\"deepar\"
\n\"prophet\"
\n\"arima\"
\n\"npts\"
\n\"ets\"
\nThe selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.
" + } + }, + "com.amazonaws.sagemaker#AutoMLAlgorithms": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLAlgorithm" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 11 + } + } + }, + "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLAlgorithmConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#AutoMLCandidate": { + "type": "structure", + "members": { + "CandidateName": { + "target": "com.amazonaws.sagemaker#CandidateName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the candidate.
", + "smithy.api#required": {} + } + }, + "FinalAutoMLJobObjectiveMetric": { + "target": "com.amazonaws.sagemaker#FinalAutoMLJobObjectiveMetric" + }, + "ObjectiveStatus": { + "target": "com.amazonaws.sagemaker#ObjectiveStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The objective's status.
", + "smithy.api#required": {} + } + }, + "CandidateSteps": { + "target": "com.amazonaws.sagemaker#CandidateSteps", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the candidate's steps.
", + "smithy.api#required": {} + } + }, + "CandidateStatus": { + "target": "com.amazonaws.sagemaker#CandidateStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The candidate's status.
", + "smithy.api#required": {} + } + }, + "InferenceContainers": { + "target": "com.amazonaws.sagemaker#AutoMLContainerDefinitions", + "traits": { + "smithy.api#documentation": "Information about the recommended inference container definitions.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The creation time.
", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The last modified time.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "The failure reason.
" + } + }, + "CandidateProperties": { + "target": "com.amazonaws.sagemaker#CandidateProperties", + "traits": { + "smithy.api#documentation": "The properties of an AutoML candidate job.
" + } + }, + "InferenceContainerDefinitions": { + "target": "com.amazonaws.sagemaker#AutoMLInferenceContainerDefinitions", + "traits": { + "smithy.api#documentation": "The mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the AutoML jobs V2 (for example,\n for jobs created by calling CreateAutoMLJobV2) related to image or text\n classification problem types only.
Information about a candidate produced by an AutoML training job, including its status,\n steps, and other properties.
" + } + }, + "com.amazonaws.sagemaker#AutoMLCandidateGenerationConfig": { + "type": "structure", + "members": { + "FeatureSpecificationS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
These column keys may not include the target column.
\nIn ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.
If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
Stores the configuration information for the selection of algorithms trained on tabular\n data.
\nThe list of available algorithms to choose from depends on the training mode set in\n \n TabularJobConfig.Mode\n .
\n AlgorithmsConfig should not be set if the training mode is set on\n AUTO.
When AlgorithmsConfig is provided, one AutoMLAlgorithms\n attribute must be set and one only.
If the list of algorithms provided as values for AutoMLAlgorithms is\n empty, CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.
For the list of all algorithms per problem type and training mode, see \n AutoMLAlgorithmConfig.
\nFor more information on each algorithm, see the Algorithm support section in Autopilot developer guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stores the configuration information for how a candidate is generated (optional).
" + } + }, + "com.amazonaws.sagemaker#AutoMLCandidateStep": { + "type": "structure", + "members": { + "CandidateStepType": { + "target": "com.amazonaws.sagemaker#CandidateStepType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether the candidate is at the transform, training, or processing step.
", + "smithy.api#required": {} + } + }, + "CandidateStepArn": { + "target": "com.amazonaws.sagemaker#CandidateStepArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN for the candidate's step.
", + "smithy.api#required": {} + } + }, + "CandidateStepName": { + "target": "com.amazonaws.sagemaker#CandidateStepName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name for the candidate's step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the steps for a candidate and what step it is working on.
" + } + }, + "com.amazonaws.sagemaker#AutoMLCandidates": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLCandidate" + } + }, + "com.amazonaws.sagemaker#AutoMLChannel": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.sagemaker#AutoMLDataSource", + "traits": { + "smithy.api#documentation": "The data source for an AutoML channel.
" + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "You can use Gzip or None. The default value is\n None.
The name of the target variable in supervised learning, usually represented by\n 'y'.
", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "The content type of the data from the input source. You can use\n text/csv;header=present or x-application/vnd.amazon+parquet.\n The default value is text/csv;header=present.
The channel type (optional) is an enum string. The default value is\n training. Channels for training and validation must share the same\n ContentType and TargetAttributeName. For information on\n specifying training and validation channel types, see How to specify training and validation datasets.
If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.
\nSample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.
\nSupport for sample weights is available in Ensembling\n mode only.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A channel is a named input source that training algorithms can consume. The validation\n dataset size is limited to less than 2 GB. The training dataset size must be less than 100\n GB. For more information, see Channel.
\nA validation dataset must contain the same headers as the training dataset.
\nThe configuration for using EMR Serverless\n to run the AutoML job V2.
\nTo allow your AutoML job V2 to automatically initiate a remote job on EMR Serverless\n when additional compute resources are needed to process large datasets, you need to provide\n an EmrServerlessComputeConfig object, which includes an\n ExecutionRoleARN attribute, to the AutoMLComputeConfig of the\n AutoML job V2 input request.
By seamlessly transitioning to EMR Serverless when required, the AutoML job can handle\n datasets that would otherwise exceed the initially provisioned resources, without any\n manual intervention from you.
\nEMR Serverless is available for the tabular and time series problem types. We\n recommend setting up this option for tabular datasets larger than 5 GB and time series\n datasets larger than 30 GB.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in\n other contexts at the moment.
\nSpecifies the compute configuration for an AutoML job V2.
" + } + }, + "com.amazonaws.sagemaker#AutoMLContainerDefinition": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more\n information, see \n ContainerDefinition.
", + "smithy.api#required": {} + } + }, + "ModelDataUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location of the model artifacts. For more information, see \n ContainerDefinition.
", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the container. For more information, see \n ContainerDefinition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of container definitions that describe the different containers that make up an\n AutoML candidate. For more information, see \n ContainerDefinition.
" + } + }, + "com.amazonaws.sagemaker#AutoMLContainerDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLContainerDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#AutoMLDataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#AutoMLS3DataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 location of the input data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The data source for the Autopilot job.
" + } + }, + "com.amazonaws.sagemaker#AutoMLDataSplitConfig": { + "type": "structure", + "members": { + "ValidationFraction": { + "target": "com.amazonaws.sagemaker#ValidationFraction", + "traits": { + "smithy.api#documentation": "The validation fraction (optional) is a float that specifies the portion of the training\n dataset to be used for validation. The default value is 0.2, and values must be greater\n than 0 and less than 1. We recommend setting this value to be less than 0.5.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure specifies how to split the data into train and validation\n datasets.
\nThe validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.
Processing unit for an inference container. Currently Autopilot only supports\n CPU or GPU.
Information about the recommended inference container definitions.
" + } + }, + "traits": { + "smithy.api#documentation": "The mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the V2 API only (for example,\n for jobs created by calling CreateAutoMLJobV2).
The URL of the notebook location.
" + } + }, + "DataExplorationNotebookLocation": { + "target": "com.amazonaws.sagemaker#DataExplorationNotebookLocation", + "traits": { + "smithy.api#documentation": "The URL of the notebook location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The artifacts that are generated during an AutoML job.
" + } + }, + "com.amazonaws.sagemaker#AutoMLJobChannel": { + "type": "structure", + "members": { + "ChannelType": { + "target": "com.amazonaws.sagemaker#AutoMLChannelType", + "traits": { + "smithy.api#documentation": "The type of channel. Defines whether the data are used for training or validation. The\n default value is training. Channels for training and\n validation must share the same ContentType\n
The type of channel defaults to training for the time-series forecasting\n problem type.
The content type of the data from the input source. The following are the allowed\n content types for different problems:
\nFor tabular problem types: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For image classification: image/png, image/jpeg, or\n image/*. The default value is image/*.
For text classification: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For time-series forecasting: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For text generation (LLMs fine-tuning): text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
The allowed compression types depend on the input format and problem type. We allow the\n compression type Gzip for S3Prefix inputs on tabular data only.\n For all other inputs, the compression type should be None. If no compression\n type is provided, we default to None.
The data source for an AutoML channel (Required).
" + } + } + }, + "traits": { + "smithy.api#documentation": "A channel is a named input source that training algorithms can consume. This channel is\n used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).
" + } + }, + "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria": { + "type": "structure", + "members": { + "MaxCandidates": { + "target": "com.amazonaws.sagemaker#MaxCandidates", + "traits": { + "smithy.api#documentation": "The maximum number of times a training job is allowed to run.
\nFor text and image classification, time-series forecasting, as well as text generation\n (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the\n maximum value is 750.
" + } + }, + "MaxRuntimePerTrainingJobInSeconds": { + "target": "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds", + "traits": { + "smithy.api#documentation": "The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.
\nFor job V2s (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.
For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours\n (259200 seconds).
" + } + }, + "MaxAutoMLJobRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds", + "traits": { + "smithy.api#documentation": "The maximum runtime, in seconds, an AutoML job has to complete.
\nIf an AutoML job exceeds the maximum runtime, the job is stopped automatically and its\n processing is ended gracefully. The AutoML job identifies the best model whose training was\n completed and marks it as the best-performing model. Any unfinished steps of the job, such\n as automatic one-click Autopilot model deployment, are not completed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "How long a job is allowed to run, or how many candidates a job is allowed to\n generate.
" + } + }, + "com.amazonaws.sagemaker#AutoMLJobConfig": { + "type": "structure", + "members": { + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "How long an AutoML job is allowed to run, or how many candidates a job is allowed to\n generate.
" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", + "traits": { + "smithy.api#documentation": "The security configuration for traffic encryption or Amazon VPC settings.
" + } + }, + "CandidateGenerationConfig": { + "target": "com.amazonaws.sagemaker#AutoMLCandidateGenerationConfig", + "traits": { + "smithy.api#documentation": "The configuration for generating a candidate for an AutoML job (optional).
" + } + }, + "DataSplitConfig": { + "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", + "traits": { + "smithy.api#documentation": "The configuration for splitting the input training dataset.
\nType: AutoMLDataSplitConfig
" + } + }, + "Mode": { + "target": "com.amazonaws.sagemaker#AutoMLMode", + "traits": { + "smithy.api#documentation": "The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.
A collection of settings used for an AutoML job.
" + } + }, + "com.amazonaws.sagemaker#AutoMLJobInputDataConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLJobChannel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#AutoMLJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$" + } + }, + "com.amazonaws.sagemaker#AutoMLJobObjective": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.
\nThe list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.
\nFor tabular problem types:
\nList of available metrics:
\n Regression: MAE, MSE, R2,\n RMSE\n
Binary classification: Accuracy, AUC,\n BalancedAccuracy, F1,\n Precision, Recall\n
Multiclass classification: Accuracy,\n BalancedAccuracy, F1macro,\n PrecisionMacro, RecallMacro\n
For a description of each metric, see Autopilot metrics for classification and regression.
\nDefault objective metrics:
\nRegression: MSE.
Binary classification: F1.
Multiclass classification: Accuracy.
For image or text classification problem types:
\nList of available metrics: Accuracy\n
For a description of each metric, see Autopilot metrics for text and image classification.
\nDefault objective metrics: Accuracy\n
For time-series forecasting problem types:
\nList of available metrics: RMSE, wQL,\n Average wQL, MASE, MAPE,\n WAPE\n
For a description of each metric, see Autopilot metrics for\n time-series forecasting.
\nDefault objective metrics: AverageWeightedQuantileLoss\n
For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.
Specifies a metric to minimize or maximize as the objective of an AutoML job.
" + } + }, + "com.amazonaws.sagemaker#AutoMLJobObjectiveType": { + "type": "enum", + "members": { + "MAXIMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximize" + } + }, + "MINIMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimize" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "MAX_CANDIDATES_REACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxCandidatesReached" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "MAX_AUTO_ML_JOB_RUNTIME_REACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxAutoMLJobRuntimeReached" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "CANDIDATE_DEFINITIONS_GENERATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CandidateDefinitionsGenerated" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "EXPLAINABILITY_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExplainabilityError" + } + }, + "DEPLOYING_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeployingModel" + } + }, + "MODEL_DEPLOYMENT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelDeploymentError" + } + }, + "GENERATING_MODEL_INSIGHTS_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GeneratingModelInsightsReport" + } + }, + "MODEL_INSIGHTS_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelInsightsError" + } + }, + "ANALYZING_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AnalyzingData" + } + }, + "FEATURE_ENGINEERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureEngineering" + } + }, + "MODEL_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelTuning" + } + }, + "GENERATING_EXPLAINABILITY_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GeneratingExplainabilityReport" + } + }, + "TRAINING_MODELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrainingModels" + } + }, + "PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PreTraining" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLJobStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLJobStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for an AutoML job step.
" + } + }, + "com.amazonaws.sagemaker#AutoMLJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLJobSummary" + } + }, + "com.amazonaws.sagemaker#AutoMLJobSummary": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the AutoML job you are requesting.
", + "smithy.api#required": {} + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the AutoML job.
", + "smithy.api#required": {} + } + }, + "AutoMLJobStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the AutoML job.
", + "smithy.api#required": {} + } + }, + "AutoMLJobSecondaryStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The secondary status of the AutoML job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "When the AutoML job was created.
", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of an AutoML job.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "When the AutoML job was last modified.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "The failure reason of an AutoML job.
" + } + }, + "PartialFailureReasons": { + "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", + "traits": { + "smithy.api#documentation": "The list of reasons for partial failures within an AutoML job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary about an AutoML job.
" + } + }, + "com.amazonaws.sagemaker#AutoMLMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#AutoMLMaxResultsForTrials": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.sagemaker#AutoMLMetricEnum": { + "type": "enum", + "members": { + "ACCURACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accuracy" + } + }, + "MSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MSE" + } + }, + "F1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "F1" + } + }, + "F1_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "F1macro" + } + }, + "AUC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUC" + } + }, + "RMSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RMSE" + } + }, + "BALANCED_ACCURACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BalancedAccuracy" + } + }, + "R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "R2" + } + }, + "RECALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Recall" + } + }, + "RECALL_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecallMacro" + } + }, + "PRECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Precision" + } + }, + "PRECISION_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PrecisionMacro" + } + }, + "MAE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAE" + } + }, + "MAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAPE" + } + }, + "MASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MASE" + } + }, + "WAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAPE" + } + }, + "AVERAGE_WEIGHTED_QUANTILE_LOSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AverageWeightedQuantileLoss" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLMetricExtendedEnum": { + "type": "enum", + "members": { + "ACCURACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accuracy" + } + }, + "MSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MSE" + } + }, + "F1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "F1" + } + }, + "F1_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "F1macro" + } + }, + "AUC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUC" + } + }, + "RMSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RMSE" + } + }, + "MAE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAE" + } + }, + "R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "R2" + } + }, + "BALANCED_ACCURACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BalancedAccuracy" + } + }, + "PRECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Precision" + } + }, + "PRECISION_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PrecisionMacro" + } + }, + "RECALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Recall" + } + }, + "RECALL_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecallMacro" + } + }, + "LogLoss": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LogLoss" + } + }, + "INFERENCE_LATENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InferenceLatency" + } + }, + "MAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAPE" + } + }, + "MASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MASE" + } + }, + "WAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAPE" + } + }, + "AVERAGE_WEIGHTED_QUANTILE_LOSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AverageWeightedQuantileLoss" + } + }, + "ROUGE1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rouge1" + } + }, + "ROUGE2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rouge2" + } + }, + "ROUGEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RougeL" + } + }, + "ROUGEL_SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RougeLSum" + } + }, + "PERPLEXITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Perplexity" + } + }, + "VALIDATION_LOSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationLoss" + } + }, + "TRAINING_LOSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrainingLoss" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLMode": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "ENSEMBLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENSEMBLING" + } + }, + "HYPERPARAMETER_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HYPERPARAMETER_TUNING" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.sagemaker#AutoMLOutputDataConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Key Management Service encryption key ID.
" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 output path. Must be 512 characters or less.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The output data configuration.
" + } + }, + "com.amazonaws.sagemaker#AutoMLPartialFailureReason": { + "type": "structure", + "members": { + "PartialFailureMessage": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "The message containing the reason for a partial failure of an AutoML job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The reason for a partial failure of an AutoML job.
" + } + }, + "com.amazonaws.sagemaker#AutoMLPartialFailureReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReason" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#AutoMLProblemTypeConfig": { + "type": "union", + "members": { + "ImageClassificationJobConfig": { + "target": "com.amazonaws.sagemaker#ImageClassificationJobConfig", + "traits": { + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the image classification problem\n type.
" + } + }, + "TextClassificationJobConfig": { + "target": "com.amazonaws.sagemaker#TextClassificationJobConfig", + "traits": { + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the text classification problem\n type.
" + } + }, + "TimeSeriesForecastingJobConfig": { + "target": "com.amazonaws.sagemaker#TimeSeriesForecastingJobConfig", + "traits": { + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the time-series forecasting problem\n type.
" + } + }, + "TabularJobConfig": { + "target": "com.amazonaws.sagemaker#TabularJobConfig", + "traits": { + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the tabular problem type (regression,\n classification).
" + } + }, + "TextGenerationJobConfig": { + "target": "com.amazonaws.sagemaker#TextGenerationJobConfig", + "traits": { + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning)\n problem type.
\nThe text generation models that support fine-tuning in Autopilot are currently accessible\n exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported\n Regions.
\nA collection of settings specific to the problem type used to configure an AutoML job V2.\n There must be one and only one config of the following type.
" + } + }, + "com.amazonaws.sagemaker#AutoMLProblemTypeConfigName": { + "type": "enum", + "members": { + "IMAGE_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageClassification" + } + }, + "TEXT_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TextClassification" + } + }, + "TIMESERIES_FORECASTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TimeSeriesForecasting" + } + }, + "TABULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Tabular" + } + }, + "TEXT_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TextGeneration" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLProblemTypeResolvedAttributes": { + "type": "union", + "members": { + "TabularResolvedAttributes": { + "target": "com.amazonaws.sagemaker#TabularResolvedAttributes", + "traits": { + "smithy.api#documentation": "The resolved attributes for the tabular problem type.
" + } + }, + "TextGenerationResolvedAttributes": { + "target": "com.amazonaws.sagemaker#TextGenerationResolvedAttributes", + "traits": { + "smithy.api#documentation": "The resolved attributes for the text generation problem type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stores resolved attributes specific to the problem type of an AutoML job V2.
" + } + }, + "com.amazonaws.sagemaker#AutoMLProcessingUnit": { + "type": "enum", + "members": { + "CPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPU" + } + }, + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GPU" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLResolvedAttributes": { + "type": "structure", + "members": { + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective" + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + }, + "AutoMLProblemTypeResolvedAttributes": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeResolvedAttributes", + "traits": { + "smithy.api#documentation": "Defines the resolved attributes specific to a problem type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resolved attributes used to configure an AutoML job V2.
" + } + }, + "com.amazonaws.sagemaker#AutoMLS3DataSource": { + "type": "structure", + "members": { + "S3DataType": { + "target": "com.amazonaws.sagemaker#AutoMLS3DataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The data type.
\nIf you choose S3Prefix, S3Uri identifies a key name\n prefix. SageMaker AI uses all objects that match the specified key name prefix\n for model training.
The S3Prefix should have the following format:
\n s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE\n
If you choose ManifestFile, S3Uri identifies an object\n that is a manifest file containing a list of object keys that you want SageMaker AI to use for model training.
A ManifestFile should have the format shown below:
\n [ {\"prefix\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/\"}, \n
\n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1\",\n
\n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2\",\n
\n ... \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N\" ]\n
If you choose AugmentedManifestFile, S3Uri identifies an\n object that is an augmented manifest file in JSON lines format. This file contains\n the data you want to use for model training. AugmentedManifestFile is\n available for V2 API jobs only (for example, for jobs created by calling\n CreateAutoMLJobV2).
Here is a minimal, single-record example of an\n AugmentedManifestFile:
\n {\"source-ref\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg\",\n
\n \"label-metadata\": {\"class-name\": \"cat\" }
For more information on AugmentedManifestFile, see Provide\n Dataset Metadata to Training Jobs with an Augmented Manifest File.
The URL to the Amazon S3 data source. The Uri refers to the Amazon S3\n prefix or ManifestFile depending on the data type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the Amazon S3 data source.
" + } + }, + "com.amazonaws.sagemaker#AutoMLS3DataType": { + "type": "enum", + "members": { + "MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManifestFile" + } + }, + "S3_PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + }, + "AUGMENTED_MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AugmentedManifestFile" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLSecurityConfig": { + "type": "structure", + "members": { + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The key used to encrypt stored data.
" + } + }, + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Whether to use traffic encryption between the container layers.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Security options.
" + } + }, + "com.amazonaws.sagemaker#AutoMLSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMountHomeEFS": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + }, + "DEFAULT_AS_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DefaultAsDomain" + } + } + } + }, + "com.amazonaws.sagemaker#AutoParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hyperparameter to optimize using Autotune.
", + "smithy.api#required": {} + } + }, + "ValueHint": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An example value of the hyperparameter to optimize using Autotune.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The name and an example value of the hyperparameter that you want to use in Autotune.\n If Automatic model tuning (AMT) determines that your hyperparameter is eligible for\n Autotune, an optimal hyperparameter range is selected for you.
" + } + }, + "com.amazonaws.sagemaker#AutoParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#AutoRollbackConfig": { + "type": "structure", + "members": { + "Alarms": { + "target": "com.amazonaws.sagemaker#AlarmList", + "traits": { + "smithy.api#documentation": "List of CloudWatch alarms in your account that are configured to monitor metrics on an\n endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the\n deployment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Automatic rollback configuration for handling endpoint deployment failures and\n recovery.
" + } + }, + "com.amazonaws.sagemaker#Autotune": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.sagemaker#AutotuneMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Set Mode to Enabled if you want to use Autotune.
A flag to indicate if you want to use Autotune to automatically find optimal values\n for the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.
\nThe Amazon S3 location being used to capture the data.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the batch transform job.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
Flag that indicates whether to append inference id to the output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration to control how SageMaker captures inference data for batch transform jobs.
" + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes\n accepts a cluster name and a list of node IDs.
To safeguard your work, back up your data to Amazon S3 or an FSx for\n Lustre file system before invoking the API on a worker node group. This will help\n prevent any potential data loss from the instance root volume. For more\n information about backup, see Use the backup script provided by SageMaker HyperPod.
\nIf you want to invoke this API on an existing cluster, you'll first need to\n patch the cluster by running the UpdateClusterSoftware API. For more information about patching a\n cluster, see Update the SageMaker HyperPod platform software of a cluster.
\nThe error code associated with the error encountered when deleting a node.
\nThe code provides information about the specific issue encountered, such as the node not\n being found, the node's status being invalid for deletion, or the node ID being in use by\n another process.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A message describing the error encountered when deleting a node.
", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the node that encountered an error during the deletion process.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an error encountered when deleting a node from a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodesErrorCode": { + "type": "enum", + "members": { + "NODE_ID_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeIdNotFound" + } + }, + "INVALID_NODE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidNodeStatus" + } + }, + "NODE_ID_IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeIdInUse" + } + } + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodesErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesError" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 99 + } + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodesRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the SageMaker HyperPod cluster from which to delete the specified nodes.
", + "smithy.api#required": {} + } + }, + "NodeIds": { + "target": "com.amazonaws.sagemaker#ClusterNodeIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of node IDs to be deleted from the specified cluster.
\nFor SageMaker HyperPod clusters using the Slurm workload manager, \n you cannot remove instances that are configured as Slurm controller nodes.
\nA list of errors encountered when deleting the specified nodes.
" + } + }, + "Successful": { + "target": "com.amazonaws.sagemaker#ClusterNodeIds", + "traits": { + "smithy.api#documentation": "A list of node IDs that were successfully deleted from the specified cluster.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageOutput" + }, + "traits": { + "smithy.api#documentation": "This action batch describes a list of versioned model packages
" + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "ErrorResponse": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The error code and error description associated with the resource.
" + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageErrorMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ModelPackageArn" + }, + "value": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageError" + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageArnList": { + "target": "com.amazonaws.sagemaker#ModelPackageArnList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The list of Amazon Resource Name (ARN) of the model package groups.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageOutput": { + "type": "structure", + "members": { + "ModelPackageSummaries": { + "target": "com.amazonaws.sagemaker#ModelPackageSummaries", + "traits": { + "smithy.api#documentation": "The summaries for the model package versions
" + } + }, + "BatchDescribeModelPackageErrorMap": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageErrorMap", + "traits": { + "smithy.api#documentation": "A map of the resource and BatchDescribeModelPackageError objects \n reporting the error associated with describing the model package.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#BatchDescribeModelPackageSummary": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The group name for the model package
", + "smithy.api#required": {} + } + }, + "ModelPackageVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageVersion", + "traits": { + "smithy.api#documentation": "The version number of a versioned model.
" + } + }, + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
", + "smithy.api#required": {} + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "The description of the model package.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The creation time of the mortgage package summary.
", + "smithy.api#required": {} + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the mortgage package.
", + "smithy.api#required": {} + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "The approval status of the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about the model package.
" + } + }, + "com.amazonaws.sagemaker#BatchStrategy": { + "type": "enum", + "members": { + "MULTI_RECORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultiRecord" + } + }, + "SINGLE_RECORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SingleRecord" + } + } + } + }, + "com.amazonaws.sagemaker#BatchTransformInput": { + "type": "structure", + "members": { + "DataCapturedDestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 location being used to capture the data.
", + "smithy.api#required": {} + } + }, + "DatasetFormat": { + "target": "com.amazonaws.sagemaker#MonitoringDatasetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The dataset format for your batch transform job.
", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Path to the filesystem where the batch transform data is available to the container.
", + "smithy.api#required": {} + } + }, + "S3InputMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", + "traits": { + "smithy.api#documentation": "Whether the Pipe or File is used as the input mode for\n transferring data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.\n Defaults to FullyReplicated\n
The attributes of the input data that are the input features.
" + } + }, + "InferenceAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The attribute of the input data that represents the ground truth label.
" + } + }, + "ProbabilityAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "In a classification problem, the attribute that represents the class probability.
" + } + }, + "ProbabilityThresholdAttribute": { + "target": "com.amazonaws.sagemaker#ProbabilityThresholdAttribute", + "traits": { + "smithy.api#documentation": "The threshold for the class probability to be evaluated as a positive result.
" + } + }, + "StartTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "If specified, monitoring jobs substract this time from the start time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + } + }, + "EndTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "If specified, monitoring jobs subtract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + } + }, + "ExcludeFeaturesAttribute": { + "target": "com.amazonaws.sagemaker#ExcludeFeaturesAttribute", + "traits": { + "smithy.api#documentation": "The attributes of the input data to exclude from the analysis.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input object for the batch transform job.
" + } + }, + "com.amazonaws.sagemaker#BestObjectiveNotImproving": { + "type": "structure", + "members": { + "MaxNumberOfTrainingJobsNotImproving": { + "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobsNotImproving", + "traits": { + "smithy.api#documentation": "The number of training jobs that have failed to improve model performance by 1% or\n greater over prior training jobs as evaluated against an objective function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that keeps track of which training jobs launched by your hyperparameter\n tuning job are not improving model performance as evaluated against an objective\n function.
" + } + }, + "com.amazonaws.sagemaker#Bias": { + "type": "structure", + "members": { + "Report": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The bias report for a model
" + } + }, + "PreTrainingReport": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The pre-training bias report for a model.
" + } + }, + "PostTrainingReport": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The post-training bias report for a model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains bias metrics for a model.
" + } + }, + "com.amazonaws.sagemaker#BillableTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#BlockedReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#BlueGreenUpdatePolicy": { + "type": "structure", + "members": { + "TrafficRoutingConfiguration": { + "target": "com.amazonaws.sagemaker#TrafficRoutingConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Defines the traffic routing strategy to shift traffic from the old fleet to the new\n fleet during an endpoint deployment.
", + "smithy.api#required": {} + } + }, + "TerminationWaitInSeconds": { + "target": "com.amazonaws.sagemaker#TerminationWaitInSeconds", + "traits": { + "smithy.api#documentation": "Additional waiting time in seconds after the completion of an endpoint deployment\n before terminating the old endpoint fleet. Default is 0.
" + } + }, + "MaximumExecutionTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "Maximum execution timeout for the deployment. Note that the timeout value should be\n larger than the total waiting time specified in TerminationWaitInSeconds\n and WaitIntervalInSeconds.
Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.
" + } + }, + "com.amazonaws.sagemaker#Boolean": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#BooleanOperator": { + "type": "enum", + "members": { + "AND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "And" + } + }, + "OR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Or" + } + } + } + }, + "com.amazonaws.sagemaker#BorrowLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.sagemaker#Branch": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[^ ~^:?*\\[]+$" + } + }, + "com.amazonaws.sagemaker#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.sagemaker#CacheHitResult": { + "type": "structure", + "members": { + "SourcePipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details on the cache hit of a pipeline execution step.
" + } + }, + "com.amazonaws.sagemaker#CallbackStepMetadata": { + "type": "structure", + "members": { + "CallbackToken": { + "target": "com.amazonaws.sagemaker#CallbackToken", + "traits": { + "smithy.api#documentation": "The pipeline generated token from the Amazon SQS queue.
" + } + }, + "SqsQueueUrl": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.
" + } + }, + "OutputParameters": { + "target": "com.amazonaws.sagemaker#OutputParameterList", + "traits": { + "smithy.api#documentation": "A list of the output parameters of the callback step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata about a callback step.
" + } + }, + "com.amazonaws.sagemaker#CallbackToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.sagemaker#CandidateArtifactLocations": { + "type": "structure", + "members": { + "Explainability": { + "target": "com.amazonaws.sagemaker#ExplainabilityLocation", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 prefix to the explainability artifacts generated for the AutoML\n candidate.
", + "smithy.api#required": {} + } + }, + "ModelInsights": { + "target": "com.amazonaws.sagemaker#ModelInsightsLocation", + "traits": { + "smithy.api#documentation": "The Amazon S3 prefix to the model insight artifacts generated for the AutoML\n candidate.
" + } + }, + "BacktestResults": { + "target": "com.amazonaws.sagemaker#BacktestResultsLocation", + "traits": { + "smithy.api#documentation": "The Amazon S3 prefix to the accuracy metrics and the inference results observed\n over the testing window. Available only for the time-series forecasting problem\n type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location of artifacts for an AutoML candidate job.
" + } + }, + "com.amazonaws.sagemaker#CandidateDefinitionNotebookLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#CandidateGenerationConfig": { + "type": "structure", + "members": { + "AlgorithmsConfig": { + "target": "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig", + "traits": { + "smithy.api#documentation": "Your Autopilot job trains a default set of algorithms on your dataset. For tabular and\n time-series data, you can customize the algorithm list by selecting a subset of algorithms\n for your problem type.
\n\n AlgorithmsConfig stores the customized selection of algorithms to train on\n your data.
\n For the tabular problem type\n TabularJobConfig, the list of available algorithms to\n choose from depends on the training mode set in \n AutoMLJobConfig.Mode\n .
\n AlgorithmsConfig should not be set when the training mode\n AutoMLJobConfig.Mode is set to AUTO.
When AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.
If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.
For the list of all algorithms per training mode, see \n AlgorithmConfig.
\nFor more information on each algorithm, see the Algorithm support section in the Autopilot developer guide.
\n\n For the time-series forecasting problem type\n TimeSeriesForecastingJobConfig, choose your algorithms\n from the list provided in \n AlgorithmConfig.
For more information on each algorithm, see the Algorithms\n support for time-series forecasting section in the Autopilot developer\n guide.
\nWhen AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.
If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.
Stores the configuration information for how model candidates are generated using an\n AutoML job V2.
" + } + }, + "com.amazonaws.sagemaker#CandidateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.sagemaker#CandidateProperties": { + "type": "structure", + "members": { + "CandidateArtifactLocations": { + "target": "com.amazonaws.sagemaker#CandidateArtifactLocations", + "traits": { + "smithy.api#documentation": "The Amazon S3 prefix to the artifacts generated for an AutoML candidate.
" + } + }, + "CandidateMetrics": { + "target": "com.amazonaws.sagemaker#MetricDataList", + "traits": { + "smithy.api#documentation": "Information about the candidate metrics for an AutoML job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of an AutoML candidate job.
" + } + }, + "com.amazonaws.sagemaker#CandidateSortBy": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "FinalObjectiveMetricValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FinalObjectiveMetricValue" + } + } + } + }, + "com.amazonaws.sagemaker#CandidateStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + } + } + }, + "com.amazonaws.sagemaker#CandidateStepArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/" + } + }, + "com.amazonaws.sagemaker#CandidateStepName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.sagemaker#CandidateStepType": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::TrainingJob" + } + }, + "TRANSFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::TransformJob" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::ProcessingJob" + } + } + } + }, + "com.amazonaws.sagemaker#CandidateSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AutoMLCandidateStep" + } + }, + "com.amazonaws.sagemaker#CanvasAppSettings": { + "type": "structure", + "members": { + "TimeSeriesForecastingSettings": { + "target": "com.amazonaws.sagemaker#TimeSeriesForecastingSettings", + "traits": { + "smithy.api#documentation": "Time series forecast settings for the SageMaker Canvas application.
" + } + }, + "ModelRegisterSettings": { + "target": "com.amazonaws.sagemaker#ModelRegisterSettings", + "traits": { + "smithy.api#documentation": "The model registry settings for the SageMaker Canvas application.
" + } + }, + "WorkspaceSettings": { + "target": "com.amazonaws.sagemaker#WorkspaceSettings", + "traits": { + "smithy.api#documentation": "The workspace settings for the SageMaker Canvas application.
" + } + }, + "IdentityProviderOAuthSettings": { + "target": "com.amazonaws.sagemaker#IdentityProviderOAuthSettings", + "traits": { + "smithy.api#documentation": "The settings for connecting to an external data source with OAuth.
" + } + }, + "DirectDeploySettings": { + "target": "com.amazonaws.sagemaker#DirectDeploySettings", + "traits": { + "smithy.api#documentation": "The model deployment settings for the SageMaker Canvas application.
" + } + }, + "KendraSettings": { + "target": "com.amazonaws.sagemaker#KendraSettings", + "traits": { + "smithy.api#documentation": "The settings for document querying.
" + } + }, + "GenerativeAiSettings": { + "target": "com.amazonaws.sagemaker#GenerativeAiSettings", + "traits": { + "smithy.api#documentation": "The generative AI settings for the SageMaker Canvas application.
" + } + }, + "EmrServerlessSettings": { + "target": "com.amazonaws.sagemaker#EmrServerlessSettings", + "traits": { + "smithy.api#documentation": "The settings for running Amazon EMR Serverless data processing jobs in SageMaker Canvas.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The SageMaker Canvas application settings.
" + } + }, + "com.amazonaws.sagemaker#CapacitySize": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#CapacitySizeType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the endpoint capacity type.
\n\n INSTANCE_COUNT: The endpoint activates based on the number of\n instances.
\n CAPACITY_PERCENT: The endpoint activates based on the specified\n percentage of capacity.
Defines the capacity size, either as a number of instances or a capacity\n percentage.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the type and size of the endpoint capacity to activate for a blue/green\n deployment, a rolling deployment, or a rollback strategy. You can specify your batches\n as either instance count or the overall percentage or your fleet.
\nFor a rollback strategy, if you don't specify the fields in this object, or if you set\n the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls\n all traffic back to the blue fleet.
The list of all content type headers that Amazon SageMaker AI will treat as CSV and\n capture accordingly.
" + } + }, + "JsonContentTypes": { + "target": "com.amazonaws.sagemaker#JsonContentTypes", + "traits": { + "smithy.api#documentation": "The list of all content type headers that SageMaker AI will treat as JSON and\n capture accordingly.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified\n Amazon SageMaker AI will by default base64 encode when capturing the data.
" + } + }, + "com.amazonaws.sagemaker#CaptureMode": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Output" + } + }, + "INPUT_AND_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InputAndOutput" + } + } + } + }, + "com.amazonaws.sagemaker#CaptureOption": { + "type": "structure", + "members": { + "CaptureMode": { + "target": "com.amazonaws.sagemaker#CaptureMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specify the boundary of data to capture.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies data Model Monitor will capture.
" + } + }, + "com.amazonaws.sagemaker#CaptureOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CaptureOption" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.sagemaker#CaptureStatus": { + "type": "enum", + "members": { + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#Catalog": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.sagemaker#CategoricalParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Name of the environment variable.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#CategoricalParameterRangeValues", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The list of values you can pass.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Environment parameters you want to benchmark your load test against.
" + } + }, + "com.amazonaws.sagemaker#CategoricalParameterRange": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the categorical hyperparameter to tune.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.sagemaker#ParameterValues", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of the categories\n for\n the hyperparameter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of categorical hyperparameters to tune.
" + } + }, + "com.amazonaws.sagemaker#CategoricalParameterRangeSpecification": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.sagemaker#ParameterValues", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The allowed categories for the hyperparameter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the possible values for a categorical hyperparameter.
" + } + }, + "com.amazonaws.sagemaker#CategoricalParameterRangeValues": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#String128" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#CategoricalParameterRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CategoricalParameterRange" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#CategoricalParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CategoricalParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Cents": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 99 + } + } + }, + "com.amazonaws.sagemaker#CertifyForMarketplace": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#Channel": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.sagemaker#ChannelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#required": {} + } + }, + "DataSource": { + "target": "com.amazonaws.sagemaker#DataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location of the channel data.
", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "The MIME type of the data.
" + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "If training data is compressed, the compression type. The default value is\n None. CompressionType is used only in Pipe input mode. In\n File mode, leave this field unset or set it to None.
Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.
\nIn File mode, leave this field unset or set it to None.
" + } + }, + "InputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", + "traits": { + "smithy.api#documentation": "(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a\n different input mode from the training job's general setting. To download the data from\n Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a\n Docker volume, use File input mode. To stream data directly from Amazon S3 to\n the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, this shuffles the results of the\n S3 key prefix matches. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large\n datasets this ensures that the order of the training data is different for each epoch,\n it helps reduce bias and possible overfitting. In a multi-node training job when\n ShuffleConfig is combined with S3DataDistributionType of\n ShardedByS3Key, the data is shuffled across nodes so that the content\n sent to a particular node on the first epoch might be sent to a different node on the\n second epoch.
A channel is a named input source that training algorithms can consume.
" + } + }, + "com.amazonaws.sagemaker#ChannelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$" + } + }, + "com.amazonaws.sagemaker#ChannelSpecification": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ChannelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A brief description of the channel.
" + } + }, + "IsRequired": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the channel is required by the algorithm.
" + } + }, + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#ContentTypes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The supported MIME types for the data.
", + "smithy.api#required": {} + } + }, + "SupportedCompressionTypes": { + "target": "com.amazonaws.sagemaker#CompressionTypes", + "traits": { + "smithy.api#documentation": "The allowed compression types, if data compression is used.
" + } + }, + "SupportedInputModes": { + "target": "com.amazonaws.sagemaker#InputModes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The allowed input mode, either FILE or PIPE.
\nIn FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon\n Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This\n is the most commonly used input mode.
\nIn PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm\n without using the EBS volume.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a named input source, called a channel, to be used by an algorithm.
" + } + }, + "com.amazonaws.sagemaker#ChannelSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ChannelSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8 + } + } + }, + "com.amazonaws.sagemaker#CheckpointConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies the S3 path where you want SageMaker to store checkpoints. For example,\n s3://bucket-name/key-name-prefix.
(Optional) The local directory where checkpoints are written. The default directory is\n /opt/ml/checkpoints/.
Contains information about the output location for managed spot training checkpoint\n data.
" + } + }, + "com.amazonaws.sagemaker#Cidr": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 64 + }, + "smithy.api#pattern": "^(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)$" + } + }, + "com.amazonaws.sagemaker#Cidrs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Cidr" + } + }, + "com.amazonaws.sagemaker#ClarifyCheckStepMetadata": { + "type": "structure", + "members": { + "CheckType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the Clarify Check step
" + } + }, + "BaselineUsedForDriftCheckConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of baseline constraints file to be used for the drift check.
" + } + }, + "CalculatedBaselineConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the newly calculated baseline constraints file.
" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The model package group name.
" + } + }, + "ViolationReport": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the violation report if violations are detected.
" + } + }, + "CheckJobArn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.
" + } + }, + "SkipCheck": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints property.
The container for the metadata for the ClarifyCheck step. For more information, \n see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.\n
" + } + }, + "com.amazonaws.sagemaker#ClarifyContentTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyEnableExplanations": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyExplainerConfig": { + "type": "structure", + "members": { + "EnableExplanations": { + "target": "com.amazonaws.sagemaker#ClarifyEnableExplanations", + "traits": { + "smithy.api#documentation": "A JMESPath boolean expression used to filter which records to explain. Explanations\n are activated by default. See \n EnableExplanations\n for additional information.
The inference configuration parameter for the model container.
" + } + }, + "ShapConfig": { + "target": "com.amazonaws.sagemaker#ClarifyShapConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The configuration for SHAP analysis.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration parameters for the SageMaker Clarify explainer.
" + } + }, + "com.amazonaws.sagemaker#ClarifyFeatureHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClarifyHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ClarifyFeatureType": { + "type": "enum", + "members": { + "NUMERICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "numerical" + } + }, + "CATEGORICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "categorical" + } + }, + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "text" + } + } + } + }, + "com.amazonaws.sagemaker#ClarifyFeatureTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClarifyFeatureType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ClarifyFeaturesAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyInferenceConfig": { + "type": "structure", + "members": { + "FeaturesAttribute": { + "target": "com.amazonaws.sagemaker#ClarifyFeaturesAttribute", + "traits": { + "smithy.api#documentation": "Provides the JMESPath expression to extract the features from a model container input\n in JSON Lines format. For example, if FeaturesAttribute is the JMESPath\n expression 'myfeatures', it extracts a list of features\n [1,2,3] from request data '{\"myfeatures\":[1,2,3]}'.
A template string used to format a JSON record into an acceptable model container\n input. For example, a ContentTemplate string\n '{\"myfeatures\":$features}' will format a list of features\n [1,2,3] into the record string '{\"myfeatures\":[1,2,3]}'.\n Required only when the model container input is in JSON Lines format.
The maximum number of records in a request that the model container can process when\n querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be\n made on, for example, a single line in CSV data. If MaxRecordCount is\n 1, the model container expects one record per request. A value of 2 or\n greater means that the model expects batch requests, which can reduce overhead and speed\n up the inferencing process. If this parameter is not provided, the explainer will tune\n the record count per request according to the model container's capacity at\n runtime.
The maximum payload size (MB) allowed of a request from the explainer to the model\n container. Defaults to 6 MB.
A zero-based index used to extract a probability value (score) or list from model\n container output in CSV format. If this value is not provided, the entire model\n container output will be treated as a probability value (score) or list.
\n\n Example for a single class model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '1,0.6', set ProbabilityIndex to 1\n to select the probability value 0.6.
\n Example for a multiclass model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n ProbabilityIndex to 1 to select the probability values\n [0.1,0.6,0.3].
A zero-based index used to extract a label header or list of label headers from model\n container output in CSV format.
\n\n Example for a multiclass model: If the model\n container output consists of label headers followed by probabilities:\n '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n LabelIndex to 0 to select the label headers\n ['cat','dog','fish'].
A JMESPath expression used to extract the probability (or score) from the model\n container output if the model container is in JSON Lines format.
\n\n Example: If the model container output of a single\n request is '{\"predicted_label\":1,\"probability\":0.6}', then set\n ProbabilityAttribute to 'probability'.
A JMESPath expression used to locate the list of label headers in the model container\n output.
\n\n Example: If the model container output of a batch\n request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}',\n then set LabelAttribute to 'labels' to extract the list of\n label headers [\"cat\",\"dog\",\"fish\"]\n
For multiclass classification problems, the label headers are the names of the\n classes. Otherwise, the label header is the name of the predicted label. These are used\n to help readability for the output of the InvokeEndpoint API. See the\n response section under Invoke the endpoint\n in the Developer Guide for more information. If there are no label headers in the model\n container output, provide them manually using this parameter.
The names of the features. If provided, these are included in the endpoint response\n payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint\n in the Developer Guide for more information.
A list of data types of the features (optional). Applicable only to NLP\n explainability. If provided, FeatureTypes must have at least one\n 'text' string (for example, ['text']). If\n FeatureTypes is not provided, the explainer infers the feature types\n based on the baseline data. The feature types are included in the endpoint response\n payload. For additional information see the response section under Invoke the endpoint\n in the Developer Guide for more information.
The inference configuration parameter for the model container.
" + } + }, + "com.amazonaws.sagemaker#ClarifyLabelAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyLabelHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClarifyHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#ClarifyLabelIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ClarifyMaxPayloadInMB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#ClarifyMaxRecordCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ClarifyMimeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*$" + } + }, + "com.amazonaws.sagemaker#ClarifyProbabilityAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ClarifyProbabilityIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ClarifyShapBaseline": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.sagemaker#ClarifyShapBaselineConfig": { + "type": "structure", + "members": { + "MimeType": { + "target": "com.amazonaws.sagemaker#ClarifyMimeType", + "traits": { + "smithy.api#documentation": "The MIME type of the baseline data. Choose from 'text/csv' or\n 'application/jsonlines'. Defaults to 'text/csv'.
The inline SHAP baseline data in string format. ShapBaseline can have one\n or multiple records to be used as the baseline dataset. The format of the SHAP baseline\n file should be the same format as the training dataset. For example, if the training\n dataset is in CSV format and each record contains four features, and all features are\n numerical, then the format of the baseline data should also share these characteristics.\n For natural language processing (NLP) of text columns, the baseline value should be the\n value used to replace the unit of text specified by the Granularity of the\n TextConfig parameter. The size limit for ShapBasline is 4\n KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB\n of baseline data.
The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is\n stored. The format of the SHAP baseline file should be the same format as the format of\n the training dataset. For example, if the training dataset is in CSV format, and each\n record in the training dataset has four features, and all features are numerical, then\n the baseline file should also have this same format. Each record should contain only the\n features. If you are using a virtual private cloud (VPC), the\n ShapBaselineUri should be accessible to the VPC. For more information\n about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to\n Resources in your Amazon Virtual Private Cloud.
The configuration for the SHAP\n baseline (also called the background or reference dataset) of the Kernal\n SHAP algorithm.
\nThe number of records in the baseline data determines the size of the\n synthetic dataset, which has an impact on latency of explainability\n requests. For more information, see the Synthetic\n data of Configure and create an endpoint.
\n\n ShapBaseline and ShapBaselineUri are mutually\n exclusive parameters. One or the either is required to configure a SHAP\n baseline.
The configuration for the SHAP baseline of the Kernal SHAP algorithm.
", + "smithy.api#required": {} + } + }, + "NumberOfSamples": { + "target": "com.amazonaws.sagemaker#ClarifyShapNumberOfSamples", + "traits": { + "smithy.api#documentation": "The number of samples to be used for analysis by the Kernal SHAP algorithm.
\nThe number of samples determines the size of the synthetic dataset, which has an\n impact on latency of explainability requests. For more information, see the\n Synthetic data of Configure and create an endpoint.
\nA Boolean toggle to indicate if you want to use the logit function (true) or log-odds\n units (false) for model predictions. Defaults to false.
" + } + }, + "Seed": { + "target": "com.amazonaws.sagemaker#ClarifyShapSeed", + "traits": { + "smithy.api#documentation": "The starting value used to initialize the random number generator in the explainer.\n Provide a value for this parameter to obtain a deterministic SHAP result.
" + } + }, + "TextConfig": { + "target": "com.amazonaws.sagemaker#ClarifyTextConfig", + "traits": { + "smithy.api#documentation": "A parameter that indicates if text features are treated as text and explanations are\n provided for individual units of text. Required for natural language processing (NLP)\n explainability only.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for SHAP analysis using SageMaker Clarify Explainer.
" + } + }, + "com.amazonaws.sagemaker#ClarifyShapNumberOfSamples": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ClarifyShapSeed": { + "type": "integer" + }, + "com.amazonaws.sagemaker#ClarifyShapUseLogit": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#ClarifyTextConfig": { + "type": "structure", + "members": { + "Language": { + "target": "com.amazonaws.sagemaker#ClarifyTextLanguage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the language of the text features in ISO 639-1 or\n ISO 639-3 code of a\n supported language.
\nFor a mix of multiple languages, use code 'xx'.
The unit of granularity for the analysis of text features. For example, if the unit is\n 'token', then each token (like a word in English) of the text is\n treated as a feature. SHAP values are computed for each unit/feature.
A parameter used to configure the SageMaker Clarify explainer to treat text features as text so\n that explanations are provided for individual units of text. Required only for natural\n language processing (NLP) explainability.
" + } + }, + "com.amazonaws.sagemaker#ClarifyTextGranularity": { + "type": "enum", + "members": { + "TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "token" + } + }, + "SENTENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sentence" + } + }, + "PARAGRAPH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "paragraph" + } + } + } + }, + "com.amazonaws.sagemaker#ClarifyTextLanguage": { + "type": "enum", + "members": { + "AFRIKAANS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af" + } + }, + "ALBANIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sq" + } + }, + "ARABIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ar" + } + }, + "ARMENIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hy" + } + }, + "BASQUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu" + } + }, + "BENGALI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bn" + } + }, + "BULGARIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bg" + } + }, + "CATALAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca" + } + }, + "CHINESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh" + } + }, + "CROATIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hr" + } + }, + "CZECH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cs" + } + }, + "DANISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "da" + } + }, + "DUTCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nl" + } + }, + "ENGLISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en" + } + }, + "ESTONIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "et" + } + }, + "FINNISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fi" + } + }, + "FRENCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr" + } + }, + "GERMAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de" + } + }, + "GREEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "el" + } + }, + "GUJARATI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gu" + } + }, + "HEBREW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "he" + } + }, + "HINDI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hi" + } + }, + "HUNGARIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hu" + } + }, + "ICELANDIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is" + } + }, + "INDONESIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "id" + } + }, + "IRISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ga" + } + }, + "ITALIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it" + } + }, + "KANNADA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kn" + } + }, + "KYRGYZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ky" + } + }, + "LATVIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lv" + } + }, + "LITHUANIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lt" + } + }, + "LUXEMBOURGISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lb" + } + }, + "MACEDONIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mk" + } + }, + "MALAYALAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml" + } + }, + "MARATHI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mr" + } + }, + "NEPALI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ne" + } + }, + "NORWEGIAN_BOKMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nb" + } + }, + "PERSIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fa" + } + }, + "POLISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pl" + } + }, + "PORTUGUESE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt" + } + }, + "ROMANIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ro" + } + }, + "RUSSIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ru" + } + }, + "SANSKRIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa" + } + }, + "SERBIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sr" + } + }, + "SETSWANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tn" + } + }, + "SINHALA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "si" + } + }, + "SLOVAK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sk" + } + }, + "SLOVENIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sl" + } + }, + "SPANISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es" + } + }, + "SWEDISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sv" + } + }, + "TAGALOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tl" + } + }, + "TAMIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ta" + } + }, + "TATAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tt" + } + }, + "TELUGU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "te" + } + }, + "TURKISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tr" + } + }, + "UKRAINIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uk" + } + }, + "URDU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ur" + } + }, + "YORUBA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "yo" + } + }, + "LIGURIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lij" + } + }, + "MULTI_LANGUAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xx" + } + } + } + }, + "com.amazonaws.sagemaker#ClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[ -~]+$" + } + }, + "com.amazonaws.sagemaker#ClientSecret": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[ -~]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sagemaker#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#ClusterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ClusterAvailabilityZone": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-[a-z]+-\\d[a-z]$" + } + }, + "com.amazonaws.sagemaker#ClusterAvailabilityZoneId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{3}\\d-az\\d$" + } + }, + "com.amazonaws.sagemaker#ClusterEbsVolumeConfig": { + "type": "structure", + "members": { + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The size in gigabytes (GB) of the additional EBS volume to be attached to the instances\n in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each\n instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS)\n volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" + } + }, + "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 6758 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupDetails": { + "type": "structure", + "members": { + "CurrentCount": { + "target": "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances that are currently in the instance group of a SageMaker HyperPod\n cluster.
" + } + }, + "TargetCount": { + "target": "com.amazonaws.sagemaker#ClusterInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances you specified to add to the instance group of a SageMaker HyperPod\n cluster.
" + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "The name of the instance group of a SageMaker HyperPod cluster.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#documentation": "The instance type of the instance group of a SageMaker HyperPod cluster.
" + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#documentation": "Details of LifeCycle configuration for the instance group.
" + } + }, + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The execution role for the instance group to assume.
" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance\n group.
" + } + }, + "OnStartDeepHealthChecks": { + "target": "com.amazonaws.sagemaker#OnStartDeepHealthChecks", + "traits": { + "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#InstanceGroupStatus", + "traits": { + "smithy.api#documentation": "The current status of the cluster instance group.
\n\n InService: The instance group is active and healthy.
\n Creating: The instance group is being provisioned.
\n Updating: The instance group is being updated.
\n Failed: The instance group has failed to provision or is no longer\n healthy.
\n Degraded: The instance group is degraded, meaning that some instances\n have failed to provision or are no longer healthy.
\n Deleting: The instance group is being deleted.
The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The current status of the training plan associated with this cluster instance\n group.
" + } + }, + "OverrideVpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "Details of an instance group in a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetails" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ClusterInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the number of instances to add to the instance group of a SageMaker HyperPod\n cluster.
", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the name of the instance group.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the instance type of the instance group.
", + "smithy.api#required": {} + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the LifeCycle configuration for the instance group.
", + "smithy.api#required": {} + } + }, + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies an IAM execution role to be assumed by the instance group.
", + "smithy.api#required": {} + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "Specifies the value for Threads per core. For instance\n types that support multithreading, you can specify 1 for disabling\n multithreading and 2 for enabling multithreading. For instance types that\n doesn't support multithreading, specify 1. For more information, see the\n reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster\n instance group.
" + } + }, + "OnStartDeepHealthChecks": { + "target": "com.amazonaws.sagemaker#OnStartDeepHealthChecks", + "traits": { + "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.
" + } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The specifications of an instance group that you need to define.
" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstancePlacement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#ClusterAvailabilityZone", + "traits": { + "smithy.api#documentation": "The Availability Zone where the node in the SageMaker HyperPod cluster is launched.
" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.sagemaker#ClusterAvailabilityZoneId", + "traits": { + "smithy.api#documentation": "The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster\n is launched.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the placement details for the node in the SageMaker HyperPod cluster, including the\n Availability Zone and the unique identifier (ID) of the Availability Zone.
" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failure" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "SHUTTING_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShuttingDown" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "DEEP_HEALTH_CHECK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeepHealthCheckInProgress" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStatusDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of an instance in a SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The message from an instance in a SageMaker HyperPod cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of an instance in a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStorageConfig": { + "type": "union", + "members": { + "EbsVolumeConfig": { + "target": "com.amazonaws.sagemaker#ClusterEbsVolumeConfig", + "traits": { + "smithy.api#documentation": "Defines the configuration for attaching additional Amazon Elastic Block Store (EBS)\n volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is\n attached to each instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
Defines the configuration for attaching additional storage to the instances in the\n SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStorageConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceType": { + "type": "enum", + "members": { + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_C5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.large" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.12xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.24xlarge" + } + }, + "ML_C5N_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.large" + } + }, + "ML_C5N_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.2xlarge" + } + }, + "ML_C5N_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.4xlarge" + } + }, + "ML_C5N_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.9xlarge" + } + }, + "ML_C5N_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.18xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.8xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.16xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_GR6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.gr6.4xlarge" + } + }, + "ML_GR6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.gr6.8xlarge" + } + }, + "ML_G6E_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.xlarge" + } + }, + "ML_G6E_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.2xlarge" + } + }, + "ML_G6E_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.4xlarge" + } + }, + "ML_G6E_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.8xlarge" + } + }, + "ML_G6E_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.16xlarge" + } + }, + "ML_G6E_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.12xlarge" + } + }, + "ML_G6E_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.24xlarge" + } + }, + "ML_G6E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.48xlarge" + } + }, + "ML_P5E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5e.48xlarge" + } + }, + "ML_P5EN_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5en.48xlarge" + } + }, + "ML_TRN2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn2.48xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterLifeCycleConfig": { + "type": "structure", + "members": { + "SourceS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An Amazon S3 bucket path where your lifecycle scripts are stored.
\nMake sure that the S3 bucket path starts with s3://sagemaker-. The\n IAM role for SageMaker HyperPod has the managed \n AmazonSageMakerClusterInstanceRolePolicy\n attached, which\n allows access to S3 buckets with the specific prefix sagemaker-.
The file name of the entrypoint script of lifecycle scripts under\n SourceS3Uri. This entrypoint script runs during cluster creation.
The lifecycle configuration for a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#ClusterLifeCycleConfigFileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#ClusterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ClusterNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" + } + }, + "com.amazonaws.sagemaker#ClusterNodeDetails": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "The instance group name in which the instance is.
" + } + }, + "InstanceId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The ID of the instance.
" + } + }, + "InstanceStatus": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", + "traits": { + "smithy.api#documentation": "The status of the instance.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#documentation": "The type of the instance.
" + } + }, + "LaunchTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the instance is launched.
" + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#documentation": "The LifeCycle configuration applied to the instance.
" + } + }, + "OverrideVpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "The number of threads per CPU core you specified under\n CreateCluster.
The configurations of additional storage specified to the instance group where the\n instance (node) is launched.
" + } + }, + "PrivatePrimaryIp": { + "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp", + "traits": { + "smithy.api#documentation": "The private primary IP address of the SageMaker HyperPod cluster node.
" + } + }, + "PrivatePrimaryIpv6": { + "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIpv6", + "traits": { + "smithy.api#documentation": "The private primary IPv6 address of the SageMaker HyperPod cluster node.
" + } + }, + "PrivateDnsHostname": { + "target": "com.amazonaws.sagemaker#ClusterPrivateDnsHostname", + "traits": { + "smithy.api#documentation": "The private DNS hostname of the SageMaker HyperPod cluster node.
" + } + }, + "Placement": { + "target": "com.amazonaws.sagemaker#ClusterInstancePlacement", + "traits": { + "smithy.api#documentation": "The placement details of the SageMaker HyperPod cluster node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of an instance (also called a node interchangeably) in a\n SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#ClusterNodeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$" + } + }, + "com.amazonaws.sagemaker#ClusterNodeIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterNodeId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 99 + } + } + }, + "com.amazonaws.sagemaker#ClusterNodeRecovery": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automatic" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterNodeSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterNodeSummary" + } + }, + "com.amazonaws.sagemaker#ClusterNodeSummary": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the instance group in which the instance is.
", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the instance.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of the instance.
", + "smithy.api#required": {} + } + }, + "LaunchTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the instance is launched.
", + "smithy.api#required": {} + } + }, + "InstanceStatus": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Lists a summary of the properties of an instance (also called a\n node interchangeably) of a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ClusterOrchestrator": { + "type": "structure", + "members": { + "Eks": { + "target": "com.amazonaws.sagemaker#ClusterOrchestratorEksConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The type of orchestrator used for the SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#ClusterOrchestratorEksConfig": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#EksClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod\n cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration settings for the Amazon EKS cluster used as the orchestrator for the\n SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#ClusterPrivateDnsHostname": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ip-((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)-?\\b){4}\\..*$" + } + }, + "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$" + } + }, + "com.amazonaws.sagemaker#ClusterPrivatePrimaryIpv6": { + "type": "string" + }, + "com.amazonaws.sagemaker#ClusterSchedulerConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerConfigId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 12 + }, + "smithy.api#pattern": "^[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerConfigSummary": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "Version of the cluster policy.
" + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the cluster policy.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Creation time of the cluster policy.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Last modified time of the cluster policy.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Status of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "ARN of the cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of the cluster policy.
" + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ClusterSchedulerPriorityClassName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" + } + }, + "com.amazonaws.sagemaker#ClusterSortBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "INSERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "ROLLINGBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollingBack" + } + }, + "SYSTEMUPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterSummary" + } + }, + "com.amazonaws.sagemaker#ClusterSummary": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the SageMaker HyperPod cluster is created.
", + "smithy.api#required": {} + } + }, + "ClusterStatus": { + "target": "com.amazonaws.sagemaker#ClusterStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "TrainingPlanArns": { + "target": "com.amazonaws.sagemaker#TrainingPlanArns", + "traits": { + "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) of the training plans associated with this\n cluster.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Lists a summary of the properties of a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#ClusterThreadsPerCore": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#CodeEditorAppImageConfig": { + "type": "structure", + "members": { + "FileSystemConfig": { + "target": "com.amazonaws.sagemaker#FileSystemConfig" + }, + "ContainerConfig": { + "target": "com.amazonaws.sagemaker#ContainerConfig" + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. \n The FileSystemConfig object is not supported.
A list of custom SageMaker images that are configured to run as a Code Editor app.
" + } + }, + "LifecycleConfigArns": { + "target": "com.amazonaws.sagemaker#LifecycleConfigArns", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Code Editor application \n lifecycle configuration.
" + } + }, + "AppLifecycleManagement": { + "target": "com.amazonaws.sagemaker#AppLifecycleManagement", + "traits": { + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of CodeEditor\n applications.
" + } + }, + "BuiltInLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Code Editor application settings.
\nFor more information about Code Editor, see Get started with Code \n Editor in Amazon SageMaker.
" + } + }, + "com.amazonaws.sagemaker#CodeRepositories": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CodeRepository" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#CodeRepository": { + "type": "structure", + "members": { + "RepositoryUrl": { + "target": "com.amazonaws.sagemaker#RepositoryUrl", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URL of the Git repository.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A Git repository that SageMaker AI automatically displays to users for cloning in the\n JupyterServer application.
" + } + }, + "com.amazonaws.sagemaker#CodeRepositoryArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#CodeRepositoryContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#CodeRepositoryNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#CodeRepositorySortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LAST_MODIFIED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + } + } + }, + "com.amazonaws.sagemaker#CodeRepositorySortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#CodeRepositorySummary": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Git repository.
", + "smithy.api#required": {} + } + }, + "CodeRepositoryArn": { + "target": "com.amazonaws.sagemaker#CodeRepositoryArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Git repository.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the Git repository was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the Git repository was last modified.
", + "smithy.api#required": {} + } + }, + "GitConfig": { + "target": "com.amazonaws.sagemaker#GitConfig", + "traits": { + "smithy.api#documentation": "Configuration details for the Git repository, including the URL where it is located\n and the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies summary information about a Git repository.
" + } + }, + "com.amazonaws.sagemaker#CodeRepositorySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CodeRepositorySummary" + } + }, + "com.amazonaws.sagemaker#CognitoConfig": { + "type": "structure", + "members": { + "UserPool": { + "target": "com.amazonaws.sagemaker#CognitoUserPool", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A \n user pool is a user directory in Amazon Cognito. \n With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. \n Your users can also sign in through social identity providers like \n Google, Facebook, Amazon, or Apple, and through SAML identity providers.
", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.sagemaker#ClientId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The client ID for your Amazon Cognito user pool.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Use this parameter to configure your Amazon Cognito workforce. \n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.
" + } + }, + "com.amazonaws.sagemaker#CognitoMemberDefinition": { + "type": "structure", + "members": { + "UserPool": { + "target": "com.amazonaws.sagemaker#CognitoUserPool", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An identifier for a user pool. The user pool must be in the same region as the service\n that you are calling.
", + "smithy.api#required": {} + } + }, + "UserGroup": { + "target": "com.amazonaws.sagemaker#CognitoUserGroup", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An identifier for a user group.
", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.sagemaker#ClientId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An identifier for an application client. You must create the app client ID using\n Amazon Cognito.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Identifies a Amazon Cognito user group. A user group can be used in on or more work\n teams.
" + } + }, + "com.amazonaws.sagemaker#CognitoUserGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" + } + }, + "com.amazonaws.sagemaker#CognitoUserPool": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 55 + }, + "smithy.api#pattern": "^[\\w-]+_[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#CollectionConfig": { + "type": "union", + "members": { + "VectorConfig": { + "target": "com.amazonaws.sagemaker#VectorConfig", + "traits": { + "smithy.api#documentation": "Configuration for your vector collection type.
\n\n Dimension: The number of elements in your vector.
Configuration for your collection.
" + } + }, + "com.amazonaws.sagemaker#CollectionConfiguration": { + "type": "structure", + "members": { + "CollectionName": { + "target": "com.amazonaws.sagemaker#CollectionName", + "traits": { + "smithy.api#documentation": "The name of the tensor collection. The name must be unique relative to other rule configuration names.
" + } + }, + "CollectionParameters": { + "target": "com.amazonaws.sagemaker#CollectionParameters", + "traits": { + "smithy.api#documentation": "Parameter values for the tensor collection. The allowed parameters are\n \"name\", \"include_regex\", \"reduction_config\",\n \"save_config\", \"tensor_names\", and\n \"save_histogram\".
Configuration information for the Amazon SageMaker Debugger output tensor collections.
" + } + }, + "com.amazonaws.sagemaker#CollectionConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CollectionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#CollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#CollectionParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ConfigKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#CollectionType": { + "type": "enum", + "members": { + "LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "List" + } + }, + "SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Set" + } + }, + "VECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Vector" + } + } + } + }, + "com.amazonaws.sagemaker#CompilationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/" + } + }, + "com.amazonaws.sagemaker#CompilationJobStatus": { + "type": "enum", + "members": { + "INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#CompilationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CompilationJobSummary" + } + }, + "com.amazonaws.sagemaker#CompilationJobSummary": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model compilation job that you want a summary for.
", + "smithy.api#required": {} + } + }, + "CompilationJobArn": { + "target": "com.amazonaws.sagemaker#CompilationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model compilation job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the model compilation job was created.
", + "smithy.api#required": {} + } + }, + "CompilationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the model compilation job started.
" + } + }, + "CompilationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the model compilation job completed.
" + } + }, + "CompilationTargetDevice": { + "target": "com.amazonaws.sagemaker#TargetDevice", + "traits": { + "smithy.api#documentation": "The type of device that the model will run on after the compilation job has\n completed.
" + } + }, + "CompilationTargetPlatformOs": { + "target": "com.amazonaws.sagemaker#TargetPlatformOs", + "traits": { + "smithy.api#documentation": "The type of OS that the model will run on after the compilation job has\n completed.
" + } + }, + "CompilationTargetPlatformArch": { + "target": "com.amazonaws.sagemaker#TargetPlatformArch", + "traits": { + "smithy.api#documentation": "The type of architecture that the model will run on after the compilation job has\n completed.
" + } + }, + "CompilationTargetPlatformAccelerator": { + "target": "com.amazonaws.sagemaker#TargetPlatformAccelerator", + "traits": { + "smithy.api#documentation": "The type of accelerator that the model will run on after the compilation job has\n completed.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "The time when the model compilation job was last modified.
" + } + }, + "CompilationJobStatus": { + "target": "com.amazonaws.sagemaker#CompilationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the model compilation job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a model compilation job.
" + } + }, + "com.amazonaws.sagemaker#CompilerOptions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#CompleteOnConvergence": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + } + } + }, + "com.amazonaws.sagemaker#CompressionType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gzip" + } + } + } + }, + "com.amazonaws.sagemaker#CompressionTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CompressionType" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaConfig": { + "type": "structure", + "members": { + "ComputeQuotaResources": { + "target": "com.amazonaws.sagemaker#ComputeQuotaResourceConfigList", + "traits": { + "smithy.api#documentation": "Allocate compute resources by instance types.
" + } + }, + "ResourceSharingConfig": { + "target": "com.amazonaws.sagemaker#ResourceSharingConfig", + "traits": { + "smithy.api#documentation": "Resource sharing configuration. This defines how an entity can lend and borrow idle\n compute with other entities within the cluster.
" + } + }, + "PreemptTeamTasks": { + "target": "com.amazonaws.sagemaker#PreemptTeamTasks", + "traits": { + "smithy.api#documentation": "Allows workloads from within an entity to preempt same-team workloads. When set to\n LowerPriority, the entity's lower priority tasks are preempted by their own\n higher priority tasks.
Default is LowerPriority.
Configuration of the compute allocation definition for an entity. This includes the\n resource sharing option and the setting to preempt low priority tasks.
" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaResourceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance type of the instance group for the cluster.
", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.sagemaker#InstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of instances to add to the instance group of a SageMaker HyperPod\n cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration of the resources used for the compute allocation definition.
" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaResourceConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ComputeQuotaResourceConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.sagemaker#ComputeQuotaSummary": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "Version of the compute allocation definition.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Status of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "ARN of the cluster.
" + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target entity to allocate compute resources to.
", + "smithy.api#required": {} + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Creation time of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Last modified time of the compute allocation definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of the compute allocation definition.
" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ComputeQuotaSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ComputeQuotaTarget": { + "type": "structure", + "members": { + "TeamName": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTargetTeamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the team to allocate compute resources to.
", + "smithy.api#required": {} + } + }, + "FairShareWeight": { + "target": "com.amazonaws.sagemaker#FairShareWeight", + "traits": { + "smithy.api#documentation": "Assigned entity fair-share weight. Idle compute will be shared across entities based on\n these assigned weights. This weight is only used when FairShare is\n enabled.
A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The target entity to allocate compute resources to.
" + } + }, + "com.amazonaws.sagemaker#ComputeQuotaTargetTeamName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" + } + }, + "com.amazonaws.sagemaker#ConditionOutcome": { + "type": "enum", + "members": { + "TRUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "True" + } + }, + "FALSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "False" + } + } + } + }, + "com.amazonaws.sagemaker#ConditionStepMetadata": { + "type": "structure", + "members": { + "Outcome": { + "target": "com.amazonaws.sagemaker#ConditionOutcome", + "traits": { + "smithy.api#documentation": "The outcome of the Condition step evaluation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for a Condition step.
" + } + }, + "com.amazonaws.sagemaker#ConfigKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ConfigValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sagemaker#FailureReason" + } + }, + "traits": { + "smithy.api#documentation": "There was a conflict when you attempted to modify a SageMaker entity such as an\n Experiment or Artifact.
The arguments for the container when you're running the application.
" + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#CustomImageContainerEntrypoint", + "traits": { + "smithy.api#documentation": "The entrypoint used to run the application in the container.
" + } + }, + "ContainerEnvironmentVariables": { + "target": "com.amazonaws.sagemaker#CustomImageContainerEnvironmentVariables", + "traits": { + "smithy.api#documentation": "The environment variables to set in the container
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration used to run the application image container.
" + } + }, + "com.amazonaws.sagemaker#ContainerDefinition": { + "type": "structure", + "members": { + "ContainerHostname": { + "target": "com.amazonaws.sagemaker#ContainerHostname", + "traits": { + "smithy.api#documentation": "This parameter is ignored for models that contain only a\n PrimaryContainer.
When a ContainerDefinition is part of an inference pipeline, the value of\n the parameter uniquely identifies the container for the purposes of logging and metrics.\n For information, see Use Logs and Metrics\n to Monitor an Inference Pipeline. If you don't specify a value for this\n parameter for a ContainerDefinition that is part of an inference pipeline,\n a unique name is automatically assigned based on the position of the\n ContainerDefinition in the pipeline. If you specify a value for the\n ContainerHostName for any ContainerDefinition that is part\n of an inference pipeline, you must specify a value for the\n ContainerHostName parameter of every ContainerDefinition\n in that pipeline.
The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.
The model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nSpecifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a\n private Docker registry, see Use a\n Private Docker Registry for Real-Time Inference Containers.
\nThe model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nWhether the container hosts a single model or multiple models.
" + } + }, + "ModelDataUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.
\nThe model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.
\nIf you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token\n Service to download model artifacts from the S3 path you provide. Amazon Web Services STS\n is activated in your Amazon Web Services account by default. If you previously\n deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nIf you use a built-in algorithm to create a model, SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.
Specifies the location of ML model data to deploy.
\nCurrently you cannot use ModelDataSource in conjunction with SageMaker\n batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.
Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.
The environment variables to set in the Docker container. Don't include any\n sensitive data in your environment variables.
\nThe maximum length of each key and value in the Environment map is\n 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If\n you pass multiple containers to a CreateModel request, then the maximum\n length of all of their maps, combined, is also 32 KB.
The name or Amazon Resource Name (ARN) of the model package to use to create the\n model.
" + } + }, + "InferenceSpecificationName": { + "target": "com.amazonaws.sagemaker#InferenceSpecificationName", + "traits": { + "smithy.api#documentation": "The inference specification name in the model package version.
" + } + }, + "MultiModelConfig": { + "target": "com.amazonaws.sagemaker#MultiModelConfig", + "traits": { + "smithy.api#documentation": "Specifies additional configuration for multi-model endpoints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the container, as part of model definition.
" + } + }, + "com.amazonaws.sagemaker#ContainerDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContainerDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.sagemaker#ContainerEntrypoint": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContainerEntrypointString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ContainerEntrypointString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ContainerHostname": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ContainerImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.sagemaker#ContainerMode": { + "type": "enum", + "members": { + "SINGLE_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SingleModel" + } + }, + "MULTI_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultiModel" + } + } + } + }, + "com.amazonaws.sagemaker#ContentClassifier": { + "type": "enum", + "members": { + "FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeOfPersonallyIdentifiableInformation" + } + }, + "FREE_OF_ADULT_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeOfAdultContent" + } + } + } + }, + "com.amazonaws.sagemaker#ContentClassifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContentClassifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ContentColumn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ContentDigest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 72 + }, + "smithy.api#pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" + } + }, + "com.amazonaws.sagemaker#ContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContentType" + } + }, + "com.amazonaws.sagemaker#ContextArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/" + } + }, + "com.amazonaws.sagemaker#ContextName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 120 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}$" + } + }, + "com.amazonaws.sagemaker#ContextNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context\\/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119})$" + } + }, + "com.amazonaws.sagemaker#ContextSource": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the source.
", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the source.
" + } + }, + "SourceId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The ID of the source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure describing the source of a context.
" + } + }, + "com.amazonaws.sagemaker#ContextSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContextSummary" + } + }, + "com.amazonaws.sagemaker#ContextSummary": { + "type": "structure", + "members": { + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" + } + }, + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#documentation": "The name of the context.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ContextSource", + "traits": { + "smithy.api#documentation": "The source of the context.
" + } + }, + "ContextType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the context.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the context was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the context was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Lists a summary of the properties of a context. A context provides a logical grouping\n of other entities.
" + } + }, + "com.amazonaws.sagemaker#ContinuousParameterRange": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the continuous hyperparameter to tune.
", + "smithy.api#required": {} + } + }, + "MinValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The minimum value for the hyperparameter.\n The\n tuning job uses floating-point values between this value and MaxValuefor\n tuning.
The maximum value for the hyperparameter. The tuning job uses floating-point values\n between MinValue value and this value for tuning.
The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
\nSageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.
\nLogarithmic scaling works only for ranges that have only values greater\n than 0.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.
\nReverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.
\nA list of continuous hyperparameters to tune.
" + } + }, + "com.amazonaws.sagemaker#ContinuousParameterRangeSpecification": { + "type": "structure", + "members": { + "MinValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The minimum floating-point value allowed.
", + "smithy.api#required": {} + } + }, + "MaxValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The maximum floating-point value allowed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the possible values for a continuous hyperparameter.
" + } + }, + "com.amazonaws.sagemaker#ContinuousParameterRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContinuousParameterRange" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#ConvergenceDetected": { + "type": "structure", + "members": { + "CompleteOnConvergence": { + "target": "com.amazonaws.sagemaker#CompleteOnConvergence", + "traits": { + "smithy.api#documentation": "A flag to stop a tuning job once AMT has detected that the job has converged.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A flag to indicating that automatic model tuning (AMT) has detected model convergence,\n defined as a lack of significant improvement (1% or less) against an objective\n metric.
" + } + }, + "com.amazonaws.sagemaker#CountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[A-Z]{2}$" + } + }, + "com.amazonaws.sagemaker#CreateAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateActionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an action. An action is a lineage tracking entity that\n represents an action or activity. For example, a model deployment or an HPO job.\n Generally, an action involves at least one input or output artifact. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" + } + }, + "com.amazonaws.sagemaker#CreateActionRequest": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the action. Must be unique to your account in an Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ActionSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The source type, ID, and URI.
", + "smithy.api#required": {} + } + }, + "ActionType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The action type.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "The description of the action.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action.
" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "A list of properties to add to the action.
" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the action.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateActionResponse": { + "type": "structure", + "members": { + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateAlgorithm": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAlgorithmInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAlgorithmOutput" + }, + "traits": { + "smithy.api#documentation": "Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
" + } + }, + "com.amazonaws.sagemaker#CreateAlgorithmInput": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the algorithm.
", + "smithy.api#required": {} + } + }, + "AlgorithmDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A description of the algorithm.
" + } + }, + "TrainingSpecification": { + "target": "com.amazonaws.sagemaker#TrainingSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies details about training jobs run by this algorithm, including the\n following:
\nThe Amazon ECR path of the container and the version digest of the\n algorithm.
\nThe hyperparameters that the algorithm supports.
\nThe instance types that the algorithm supports for training.
\nWhether the algorithm supports distributed training.
\nThe metrics that the algorithm emits to Amazon CloudWatch.
\nWhich metrics that the algorithm emits can be used as the objective metric for\n hyperparameter tuning jobs.
\nThe input channels that the algorithm supports for training data. For example,\n an algorithm might support train, validation, and\n test channels.
Specifies details about inference jobs that the algorithm runs, including the\n following:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the algorithm supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the algorithm supports for\n inference.
\nSpecifies configurations for one or more training jobs and that SageMaker runs to test the\n algorithm's training code and, optionally, one or more batch transform jobs that SageMaker\n runs to test the algorithm's inference code.
" + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "Whether to certify the algorithm so that it can be listed in Amazon Web Services\n Marketplace.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateAlgorithmOutput": { + "type": "structure", + "members": { + "AlgorithmArn": { + "target": "com.amazonaws.sagemaker#AlgorithmArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new algorithm.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active\n simultaneously.
" + } + }, + "com.amazonaws.sagemaker#CreateAppImageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAppImageConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAppImageConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "Creates a configuration for running a SageMaker AI image as a KernelGateway app. The\n configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the\n kernels in the image.
" + } + }, + "com.amazonaws.sagemaker#CreateAppImageConfigRequest": { + "type": "structure", + "members": { + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the AppImageConfig. Must be unique to your account.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the AppImageConfig.
" + } + }, + "KernelGatewayImageConfig": { + "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", + "traits": { + "smithy.api#documentation": "The KernelGatewayImageConfig. You can only specify one image kernel in the \n AppImageConfig API. This kernel will be shown to users before the \n image starts. Once the image runs, all kernels are visible in JupyterLab.
" + } + }, + "JupyterLabAppImageConfig": { + "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", + "traits": { + "smithy.api#documentation": "The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.
The CodeEditorAppImageConfig. You can only specify one image kernel \n in the AppImageConfig API. This kernel is shown to users before the image starts. \n After the image runs, all kernels are visible in Code Editor.
The ARN of the AppImageConfig.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateAppRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The domain ID.
", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be\n set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
The type of app.
", + "smithy.api#required": {} + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" + } + }, + "ResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", + "traits": { + "smithy.api#documentation": "The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image\n created on the instance.
\nThe value of InstanceType passed as part of the ResourceSpec\n in the CreateApp call overrides the value passed as part of the\n ResourceSpec configured for the user profile or the domain. If\n InstanceType is not specified in any of those three ResourceSpec\n values for a KernelGateway app, the CreateApp call fails with a\n request validation error.
The Amazon Resource Name (ARN) of the app.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateArtifact": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateArtifactRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateArtifactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an artifact. An artifact is a lineage tracking entity that\n represents a URI addressable object or data. Some examples are the S3 URI of a dataset and\n the ECR registry path of an image. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" + } + }, + "com.amazonaws.sagemaker#CreateArtifactRequest": { + "type": "structure", + "members": { + "ArtifactName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the artifact. Must be unique to your account in an Amazon Web Services Region.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ArtifactSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID, ID type, and URI of the source.
", + "smithy.api#required": {} + } + }, + "ArtifactType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The artifact type.
", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#ArtifactProperties", + "traits": { + "smithy.api#documentation": "A list of properties to add to the artifact.
" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the artifact.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateArtifactResponse": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAutoMLJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAutoMLJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
\nAn AutoML job in SageMaker AI is a fully automated process that allows you to build machine\n learning models with minimal effort and machine learning expertise. When initiating an\n AutoML job, you provide your data and optionally specify parameters tailored to your use\n case. SageMaker AI then automates the entire model development lifecycle, including data\n preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify\n and accelerate the model building process by automating various tasks and exploring\n different combinations of machine learning algorithms, data preprocessing techniques, and\n hyperparameter values. The output of an AutoML job comprises one or more trained models\n ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate\n model leaderboard, allowing you to select the best-performing model for deployment.
\nFor more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html\n in the SageMaker AI developer guide.
\nWe recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.
\n\n CreateAutoMLJobV2 can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob, as well as time-series forecasting,\n non-tabular problem types such as image or text classification, and text generation\n (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.
" + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobRequest": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies an Autopilot job. The name must be unique to your account and is case\n insensitive.
", + "smithy.api#required": {} + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of channel objects that describes the input data and its location. Each channel\n is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A\n minimum of 500 rows is required for the training dataset. There is not a minimum number of\n rows required for the validation dataset.
Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job. Format(s) supported: CSV.
", + "smithy.api#required": {} + } + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "Defines the type of supervised learning problem available for the candidates. For more\n information, see \n SageMaker Autopilot problem types.
" + } + }, + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective", + "traits": { + "smithy.api#documentation": "Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.
" + } + }, + "AutoMLJobConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobConfig", + "traits": { + "smithy.api#documentation": "A collection of settings used to configure an AutoML job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the role that is used to access the data.
", + "smithy.api#required": {} + } + }, + "GenerateCandidateDefinitionsOnly": { + "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", + "traits": { + "smithy.api#documentation": "Generates possible candidates without training the models. A candidate is a combination\n of data preprocessors, algorithms, and algorithm parameter settings.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per\n resource.
" + } + }, + "ModelDeployConfig": { + "target": "com.amazonaws.sagemaker#ModelDeployConfig", + "traits": { + "smithy.api#documentation": "Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobResponse": { + "type": "structure", + "members": { + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique ARN assigned to the AutoML job when it is created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateAutoMLJobV2Request" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateAutoMLJobV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
\nAn AutoML job in SageMaker AI is a fully automated process that allows you to build machine\n learning models with minimal effort and machine learning expertise. When initiating an\n AutoML job, you provide your data and optionally specify parameters tailored to your use\n case. SageMaker AI then automates the entire model development lifecycle, including data\n preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify\n and accelerate the model building process by automating various tasks and exploring\n different combinations of machine learning algorithms, data preprocessing techniques, and\n hyperparameter values. The output of an AutoML job comprises one or more trained models\n ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate\n model leaderboard, allowing you to select the best-performing model for deployment.
\nFor more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html\n in the SageMaker AI developer guide.
\nAutoML jobs V2 support various problem types such as regression, binary, and multiclass\n classification with tabular data, text and image classification, time-series forecasting,\n and fine-tuning of large language models (LLMs) for text generation.
\n\n CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob\n and DescribeAutoMLJob which offer backward compatibility.
\n\n CreateAutoMLJobV2 can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob, as well as time-series forecasting,\n non-tabular problem types such as image or text classification, and text generation\n (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
For the list of available problem types supported by CreateAutoMLJobV2, see\n AutoMLProblemTypeConfig.
You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.
" + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobV2Request": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies an Autopilot job. The name must be unique to your account and is case\n insensitive.
", + "smithy.api#required": {} + } + }, + "AutoMLJobInputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobInputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of channel objects describing the input data and their location. Each channel\n is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters.\n The supported formats depend on the problem type:
For tabular problem types: S3Prefix,\n ManifestFile.
For image classification: S3Prefix, ManifestFile,\n AugmentedManifestFile.
For text classification: S3Prefix.
For time-series forecasting: S3Prefix.
For text generation (LLMs fine-tuning): S3Prefix.
Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job.
", + "smithy.api#required": {} + } + }, + "AutoMLProblemTypeConfig": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Defines the configuration settings of one of the supported problem types.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the role that is used to access the data.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, such as by purpose, owner, or environment. For more\n information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per\n resource.
" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", + "traits": { + "smithy.api#documentation": "The security configuration for traffic encryption or Amazon VPC settings.
" + } + }, + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective", + "traits": { + "smithy.api#documentation": "Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. For the list of default values\n per problem type, see AutoMLJobObjective.
\nFor tabular problem types: You must either provide both the\n AutoMLJobObjective and indicate the type of supervised learning\n problem in AutoMLProblemTypeConfig\n (TabularJobConfig.ProblemType), or none at all.
For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.
Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.
" + } + }, + "DataSplitConfig": { + "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", + "traits": { + "smithy.api#documentation": "This structure specifies how to split the data into train and validation\n datasets.
\nThe validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.
This attribute must not be set for the time-series forecasting problem type, as Autopilot\n automatically splits the input dataset into training and validation sets.
\nSpecifies the compute configuration for the AutoML job V2.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateAutoMLJobV2Response": { + "type": "structure", + "members": { + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique ARN assigned to the AutoMLJob when it is created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the\n Amazon SageMaker Developer Guide.
" + } + }, + "com.amazonaws.sagemaker#CreateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name for the new SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance groups to be created in the SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging\n Amazon Web Services Resources User Guide.
" + } + }, + "Orchestrator": { + "target": "com.amazonaws.sagemaker#ClusterOrchestrator", + "traits": { + "smithy.api#documentation": "The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported\n value is \"eks\", which is to use an Amazon Elastic Kubernetes Service (EKS)\n cluster as the orchestrator.
The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic,\n SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set\n to None, cluster administrators will need to manually manage any faulty\n cluster instances.
The Amazon Resource Name (ARN) of the cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateClusterSchedulerConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Create cluster policy configuration. This policy is used for task prioritization and\n fair-share allocation of idle compute. This helps prioritize critical workloads and distributes\n idle compute across entities.
" + } + }, + "com.amazonaws.sagemaker#CreateClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name for the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster.
", + "smithy.api#required": {} + } + }, + "SchedulerConfig": { + "target": "com.amazonaws.sagemaker#SchedulerConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configuration about the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the cluster policy.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Tags of the cluster policy.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateClusterSchedulerConfigResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateCodeRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateCodeRepositoryInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateCodeRepositoryOutput" + }, + "traits": { + "smithy.api#documentation": "Creates a Git repository as a resource in your SageMaker AI account. You can\n associate the repository with notebook instances so that you can use Git source control\n for the notebooks you create. The Git repository is a resource in your SageMaker AI\n account, so it can be associated with more than one notebook instance, and it persists\n independently from the lifecycle of any notebook instances it is associated with.
\nThe repository can be hosted either in Amazon Web Services CodeCommit\n or in any other Git repository.
" + } + }, + "com.amazonaws.sagemaker#CreateCodeRepositoryInput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Git repository. The name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#required": {} + } + }, + "GitConfig": { + "target": "com.amazonaws.sagemaker#GitConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies details about the repository, including the URL where the repository is\n located, the default branch, and credentials to use to access the repository.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateCodeRepositoryOutput": { + "type": "structure", + "members": { + "CodeRepositoryArn": { + "target": "com.amazonaws.sagemaker#CodeRepositoryArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new repository.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateCompilationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateCompilationJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateCompilationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI saves the\n resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
\nIf\n you choose to host your model using Amazon SageMaker AI hosting services, you can use the resulting\n model artifacts as part of the model. You can also use the artifacts with\n Amazon Web Services IoT Greengrass. In that case, deploy them as an ML\n resource.
\nIn the request body, you provide the following:
\nA name for the compilation job
\nInformation about the input model artifacts
\nThe output location for the compiled model and the device (target) that the\n model runs on
\nThe Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker AI assumes to perform\n the model compilation job.
\nYou can also provide a Tag to track the model compilation job's resource\n use and costs. The response body contains the\n CompilationJobArn\n for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation\n job, use DescribeCompilationJob. To get information about multiple model compilation\n jobs, use ListCompilationJobs.
" + } + }, + "com.amazonaws.sagemaker#CreateCompilationJobRequest": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on\n your behalf.
\nDuring model compilation, Amazon SageMaker AI needs your permission to:
\nRead input data from an S3 bucket
\nWrite model artifacts to an S3 bucket
\nWrite logs to Amazon CloudWatch Logs
\nPublish metrics to Amazon CloudWatch
\nYou grant permissions for all of these tasks to an IAM role. To pass this role to\n Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For\n more information, see Amazon SageMaker AI\n Roles.\n
The Amazon Resource Name (ARN) of a versioned model package. Provide either a \n ModelPackageVersionArn or an InputConfig object in the \n request syntax. The presence of both objects in the CreateCompilationJob \n request will return an exception.
Provides information about the location of input model artifacts, the name and shape\n of the expected data inputs, and the framework in which the model was trained.
" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Provides information about the output location for the compiled model and the target\n device the model runs on.
", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#NeoVpcConfig", + "traits": { + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your compilation job\n to connect to. Control access to your models by configuring the VPC. For more\n information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies a limit to how long a model compilation job can run. When the job reaches\n the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training\n costs.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateCompilationJobResponse": { + "type": "structure", + "members": { + "CompilationJobArn": { + "target": "com.amazonaws.sagemaker#CompilationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker AI returns\n the following data in JSON format:
\n\n CompilationJobArn: The Amazon Resource Name (ARN) of the compiled\n job.
Create compute allocation definition. This defines how compute is allocated, shared, and\n borrowed for specified entities. Specifically, how to lend and borrow idle compute and\n assign a fair-share weight to the specified entities.
" + } + }, + "com.amazonaws.sagemaker#CreateComputeQuotaRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name to the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the compute allocation definition.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target entity to allocate compute resources to.
", + "smithy.api#required": {} + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Tags of the compute allocation definition.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateComputeQuotaResponse": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateContext": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateContextRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateContextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a context. A context is a lineage tracking entity that\n represents a logical grouping of other tracking or experiment entities. Some examples are\n an endpoint and a model package. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" + } + }, + "com.amazonaws.sagemaker#CreateContextRequest": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the context. Must be unique to your account in an Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ContextSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The source type, ID, and URI.
", + "smithy.api#required": {} + } + }, + "ContextType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The context type.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "The description of the context.
" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "A list of properties to add to the context.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the context.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateContextResponse": { + "type": "structure", + "members": { + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateDataQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a definition for a job that monitors data quality and drift. For information\n about model monitor, see Amazon SageMaker AI Model\n Monitor.
" + } + }, + "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name for the monitoring job definition.
", + "smithy.api#required": {} + } + }, + "DataQualityBaselineConfig": { + "target": "com.amazonaws.sagemaker#DataQualityBaselineConfig", + "traits": { + "smithy.api#documentation": "Configures the constraints and baselines for the monitoring job.
" + } + }, + "DataQualityAppSpecification": { + "target": "com.amazonaws.sagemaker#DataQualityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the container that runs the monitoring job.
", + "smithy.api#required": {} + } + }, + "DataQualityJobInput": { + "target": "com.amazonaws.sagemaker#DataQualityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of inputs for the monitoring job. Currently endpoints are supported as monitoring\n inputs.
", + "smithy.api#required": {} + } + }, + "DataQualityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "Specifies networking configuration for the monitoring job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job definition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateDeviceFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateDeviceFleetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a device fleet.
" + } + }, + "com.amazonaws.sagemaker#CreateDeviceFleetRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet that the device belongs to.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceFleetDescription", + "traits": { + "smithy.api#documentation": "A description of the fleet.
" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The output configuration for storing sample data collected by the fleet.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Creates tags for the specified fleet.
" + } + }, + "EnableIotRoleAlias": { + "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", + "traits": { + "smithy.api#documentation": "Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".
\nFor example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateDomainRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Domain. A domain consists of an associated Amazon Elastic File System\n volume, a list of authorized users, and a variety of security, application, policy, and\n Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files\n and other artifacts with each other.
\n EFS storage\n
\nWhen a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks, Git\n repositories, and data files.
\nSageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services\n KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key\n by default. For more control, you can specify a customer managed key. For more information,\n see Protect Data\n at Rest Using Encryption.
\n\n VPC configuration\n
\nAll traffic between the domain and the Amazon EFS volume is through the specified\n VPC and subnets. For other traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to the domain. The following options are available:
\n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker AI, which allows internet access. This is the default value.
\n VpcOnly - All traffic is through the specified VPC and subnets. Internet\n access is disabled by default. To allow internet access, you must specify a NAT\n gateway.
When internet access is disabled, you won't be able to run a Amazon SageMaker AI\n Studio notebook or to train or host models unless your VPC has an interface endpoint to\n the SageMaker AI API and runtime or a NAT gateway and your security groups allow\n outbound connections.
\nNFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a Amazon SageMaker AI Studio app successfully.
\nFor more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.
" + } + }, + "com.amazonaws.sagemaker#CreateDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.sagemaker#DomainName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A name for the domain.
", + "smithy.api#required": {} + } + }, + "AuthMode": { + "target": "com.amazonaws.sagemaker#AuthMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The mode of authentication that members use to access the domain.
", + "smithy.api#required": {} + } + }, + "DefaultUserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The default settings to use to create a user profile when UserSettings isn't\n specified in the call to the CreateUserProfile API.
\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.
A collection of Domain settings.
The VPC subnets that the domain uses for communication.
", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.sagemaker#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag\n keys must be unique per resource. Tags are searchable using the Search\n API.
Tags that you specify for the Domain are also added to all Apps that the Domain\n launches.
" + } + }, + "AppNetworkAccessType": { + "target": "com.amazonaws.sagemaker#AppNetworkAccessType", + "traits": { + "smithy.api#documentation": "Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Use KmsKeyId.
SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to\n the domain with an Amazon Web Services managed key by default. For more control, specify a\n customer managed key.
" + } + }, + "AppSecurityGroupManagement": { + "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", + "traits": { + "smithy.api#documentation": "The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.
Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.
The default settings for shared spaces that users create in the domain.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateDomainResponse": { + "type": "structure", + "members": { + "DomainArn": { + "target": "com.amazonaws.sagemaker#DomainArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created domain.
" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The URL to the created domain.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an edge deployment plan, consisting of multiple stages. Each stage may have a\n different deployment configuration and devices.
" + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "ModelConfigs": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentModelConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List of models associated with the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The device fleet used for this edge deployment plan.
", + "smithy.api#required": {} + } + }, + "Stages": { + "target": "com.amazonaws.sagemaker#DeploymentStages", + "traits": { + "smithy.api#documentation": "List of stages of the edge deployment plan. The number of stages is limited to 10 per\n deployment.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "List of tags with which to tag the edge deployment plan.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanResponse": { + "type": "structure", + "members": { + "EdgeDeploymentPlanArn": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the edge deployment plan.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateEdgeDeploymentStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new stage in an existing edge deployment plan.
" + } + }, + "com.amazonaws.sagemaker#CreateEdgeDeploymentStageRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "Stages": { + "target": "com.amazonaws.sagemaker#DeploymentStages", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List of stages to be added to the edge deployment plan.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEdgePackagingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateEdgePackagingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
" + } + }, + "com.amazonaws.sagemaker#CreateEdgePackagingJobRequest": { + "type": "structure", + "members": { + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge packaging job.
", + "smithy.api#required": {} + } + }, + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
", + "smithy.api#required": {} + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model.
", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the model.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Provides information about the output location for the packaged model.
", + "smithy.api#required": {} + } + }, + "ResourceKey": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Creates tags for the packaging job.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateEndpointInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateEndpointOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.
\nUse this API to deploy models using SageMaker hosting services.
\n You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.
\nWhen it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.
\nWhen you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services\n account by default. If you previously deactivated Amazon Web Services STS for a region,\n you need to reactivate Amazon Web Services STS for that region. For more information, see\n Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nTo add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the\n role.
\nOption 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:
\n\n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n
\n \"Resource\": [\n
\n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n
\n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n
\n ]\n
For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.
\nCreates an endpoint configuration that SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want SageMaker to\n provision. Then you call the CreateEndpoint\n API.
Use this API if you want to use SageMaker hosting services to deploy models into\n production.
\nIn the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.
The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
", + "smithy.api#required": {} + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that\n hosts the endpoint.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n
Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nSpecifies configuration for how an endpoint performs asynchronous inference. This is a\n required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
" + } + }, + "ExplainerConfig": { + "target": "com.amazonaws.sagemaker#ExplainerConfig", + "traits": { + "smithy.api#documentation": "A member of CreateEndpointConfig that enables explainers.
An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants. If you use this field, you can only\n specify one variant for ProductionVariants and one variant for\n ShadowProductionVariants.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. For more information, see SageMaker AI\n Roles.
\nTo be able to pass this role to Amazon SageMaker AI, the caller of this action must\n have the iam:PassRole permission.
Sets whether all model containers deployed to the endpoint are isolated. If they are, no\n inbound or outbound network calls can be made to or from the model containers.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEndpointConfigOutput": { + "type": "structure", + "members": { + "EndpointConfigArn": { + "target": "com.amazonaws.sagemaker#EndpointConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateEndpointInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint.The name must be unique within an Amazon Web Services\n Region in your Amazon Web Services account. The name is case-insensitive in\n CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.
The name of an endpoint configuration. For more information, see CreateEndpointConfig.
", + "smithy.api#required": {} + } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#DeploymentConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateEndpointOutput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.
\nIn the Studio UI, trials are referred to as run groups and trial\n components are referred to as runs.
\nThe goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
\nTo add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
" + } + }, + "com.amazonaws.sagemaker#CreateExperimentRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the experiment. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment as displayed. The name doesn't need to be unique. If you don't\n specify DisplayName, the value in ExperimentName is\n displayed.
The description of the experiment.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to associate with the experiment. You can use Search API\n to search on the tags.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateExperimentResponse": { + "type": "structure", + "members": { + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateFeatureGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateFeatureGroupRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateFeatureGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Create a new FeatureGroup. A FeatureGroup is a group of\n Features defined in the FeatureStore to describe a\n Record.
The FeatureGroup defines the schema and features contained in the\n FeatureGroup. A FeatureGroup definition is composed of a list\n of Features, a RecordIdentifierFeatureName, an\n EventTimeFeatureName and configurations for its OnlineStore\n and OfflineStore. Check Amazon Web Services service\n quotas to see the FeatureGroups quota for your Amazon Web Services\n account.
Note that it can take approximately 10-15 minutes to provision an\n OnlineStore\n FeatureGroup with the InMemory\n StorageType.
You must include at least one of OnlineStoreConfig and\n OfflineStoreConfig to create a FeatureGroup.
The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
The name:
\nMust start with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe name of the Feature whose value uniquely identifies a\n Record defined in the FeatureStore. Only the latest record per\n identifier value will be stored in the OnlineStore.\n RecordIdentifierFeatureName must be one of feature definitions'\n names.
You use the RecordIdentifierFeatureName to access data in a\n FeatureStore.
This name:
\nMust start with an alphanumeric character.
\nCan only contains alphanumeric characters, hyphens, underscores. Spaces are not\n allowed.
\nThe name of the feature that stores the EventTime of a Record\n in a FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds to\n the creation or update of a Record in a FeatureGroup. All\n Records in the FeatureGroup must have a corresponding\n EventTime.
An EventTime can be a String or Fractional.
\n Fractional: EventTime feature values must be a Unix\n timestamp in seconds.
\n String: EventTime feature values must be an ISO-8601\n string in the format. The following formats are supported\n yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ\n where yyyy, MM, and dd represent the year,\n month, and day respectively and HH, mm, ss,\n and if applicable, SSS represent the hour, month, second and\n milliseconds respsectively. 'T' and Z are constants.
A list of Feature names and types. Name and Type\n is compulsory per Feature.
Valid feature FeatureTypes are Integral,\n Fractional and String.
\n FeatureNames cannot be any of the following: is_deleted,\n write_time, api_invocation_time\n
You can create up to 2,500 FeatureDefinitions per\n FeatureGroup.
You can turn the OnlineStore on or off by specifying True for\n the EnableOnlineStore flag in OnlineStoreConfig.
You can also include an Amazon Web Services KMS key ID (KMSKeyId) for\n at-rest encryption of the OnlineStore.
The default value is False.
Use this to configure an OfflineFeatureStore. This parameter allows you to\n specify:
The Amazon Simple Storage Service (Amazon S3) location of an\n OfflineStore.
A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data\n catalog.
\nAn KMS encryption key to encrypt the Amazon S3 location used for\n OfflineStore. If KMS encryption key is not specified, by default we\n encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level\n key for SSE, you can reduce Amazon Web Services KMS requests costs by up to\n 99 percent.
Format for the offline store table. Supported formats are Glue (Default) and\n Apache Iceberg.
\nTo learn more about this parameter, see OfflineStoreConfig.
" + } + }, + "ThroughputConfig": { + "target": "com.amazonaws.sagemaker#ThroughputConfig" + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the\n OfflineStore if an OfflineStoreConfig is provided.
A free-form description of a FeatureGroup.
Tags used to identify Features in each FeatureGroup.
The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique\n identifier for the feature group.
Creates a flow definition.
" + } + }, + "com.amazonaws.sagemaker#CreateFlowDefinitionRequest": { + "type": "structure", + "members": { + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of your flow definition.
", + "smithy.api#required": {} + } + }, + "HumanLoopRequestSource": { + "target": "com.amazonaws.sagemaker#HumanLoopRequestSource", + "traits": { + "smithy.api#documentation": "Container for configuring the source of human task requests. Use to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.
" + } + }, + "HumanLoopActivationConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopActivationConfig", + "traits": { + "smithy.api#documentation": "An object containing information about the events that trigger a human workflow.
" + } + }, + "HumanLoopConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopConfig", + "traits": { + "smithy.api#documentation": "An object containing information about the tasks the human reviewers will perform.
" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object containing information about where the human review results will be uploaded.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateFlowDefinitionResponse": { + "type": "structure", + "members": { + "FlowDefinitionArn": { + "target": "com.amazonaws.sagemaker#FlowDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow definition you create.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateHubRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateHubResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Create a hub.
" + } + }, + "com.amazonaws.sagemaker#CreateHubContentReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateHubContentReferenceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateHubContentReferenceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.
" + } + }, + "com.amazonaws.sagemaker#CreateHubContentReferenceRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub to add the hub content reference to.
", + "smithy.api#required": {} + } + }, + "SageMakerPublicHubContentArn": { + "target": "com.amazonaws.sagemaker#SageMakerPublicHubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the public hub content to reference.
", + "smithy.api#required": {} + } + }, + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#documentation": "The name of the hub content to reference.
" + } + }, + "MinVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#documentation": "The minimum version of the hub content to reference.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Any tags associated with the hub content to reference.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateHubContentReferenceResponse": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the hub that the hub content reference was added to.
", + "smithy.api#required": {} + } + }, + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the hub content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateHubRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub to create.
", + "smithy.api#required": {} + } + }, + "HubDescription": { + "target": "com.amazonaws.sagemaker#HubDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A description of the hub.
", + "smithy.api#required": {} + } + }, + "HubDisplayName": { + "target": "com.amazonaws.sagemaker#HubDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the hub.
" + } + }, + "HubSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubSearchKeywordList", + "traits": { + "smithy.api#documentation": "The searchable keywords for the hub.
" + } + }, + "S3StorageConfig": { + "target": "com.amazonaws.sagemaker#HubS3StorageConfig", + "traits": { + "smithy.api#documentation": "The Amazon S3 storage configuration for the hub.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Any tags to associate with the hub.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateHubResponse": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateHumanTaskUi": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateHumanTaskUiRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateHumanTaskUiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
" + } + }, + "com.amazonaws.sagemaker#CreateHumanTaskUiRequest": { + "type": "structure", + "members": { + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the user interface you are creating.
", + "smithy.api#required": {} + } + }, + "UiTemplate": { + "target": "com.amazonaws.sagemaker#UiTemplate", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateHumanTaskUiResponse": { + "type": "structure", + "members": { + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human review workflow user interface you create.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateHyperParameterTuningJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateHyperParameterTuningJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateHyperParameterTuningJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version\n of a model by running many training jobs on your dataset using the algorithm you choose\n and values for hyperparameters within ranges that you specify. It then chooses the\n hyperparameter values that result in a model that performs the best, as measured by an\n objective metric that you choose.
\nA hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and\n trial components for each training job that it runs. You can view these entities in\n Amazon SageMaker Studio. For more information, see View\n Experiments, Trials, and Trial Components.
\nDo not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.
\nThe name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid\n characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case\n sensitive.
", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The HyperParameterTuningJobConfig object that describes the tuning job,\n including the search strategy, the objective metric used to evaluate training jobs,\n ranges of parameters to search, and resource limits for the tuning job. For more\n information, see How\n Hyperparameter Tuning Works.
", + "smithy.api#required": {} + } + }, + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", + "traits": { + "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that describes the training jobs\n that this tuning job launches, including static hyperparameters, input data\n configuration, output data configuration, resource configuration, and stopping\n condition.
" + } + }, + "TrainingJobDefinitions": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", + "traits": { + "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.
" + } + }, + "WarmStartConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig", + "traits": { + "smithy.api#documentation": "Specifies the configuration for starting the hyperparameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.
\nAll training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the\n WarmStartType value for the warm start configuration, the training job\n that performs the best in the new tuning job is compared to the best training jobs from\n the parent tuning jobs. From these, the training job that performs the best as measured\n by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.
\nAn array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
\nTags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.
" + } + }, + "Autotune": { + "target": "com.amazonaws.sagemaker#Autotune", + "traits": { + "smithy.api#documentation": "Configures SageMaker Automatic model tuning (AMT) to automatically find optimal\n parameters for the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.
\nThe Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a\n hyperparameter tuning job when you create it.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateImageRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image\n version represents a container image stored in Amazon ECR. For more information, see\n Bring your own SageMaker AI image.
" + } + }, + "com.amazonaws.sagemaker#CreateImageRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.sagemaker#ImageDescription", + "traits": { + "smithy.api#documentation": "The description of the image.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ImageDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the image. If not provided, ImageName is displayed.
The name of the image. Must be unique to your account.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the image.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateImageResponse": { + "type": "structure", + "members": { + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "The ARN of the image.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateImageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateImageVersionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateImageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates a version of the SageMaker AI image specified by ImageName. The version\n represents the Amazon ECR container image specified by BaseImage.
The registry path of the container image to use as the starting point for this\n version. The path is an Amazon ECR URI in the following format:
\n\n
A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python\n (Boto3), add a unique value to the call.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ImageName of the Image to create a version of.
A list of aliases created with the image version.
" + } + }, + "VendorGuidance": { + "target": "com.amazonaws.sagemaker#VendorGuidance", + "traits": { + "smithy.api#documentation": "The stability of the image version, specified by the maintainer.
\n\n NOT_PROVIDED: The maintainers did not provide a status for image version stability.
\n STABLE: The image version is stable.
\n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
\n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
\n\n TRAINING: The image version is compatible with SageMaker AI training jobs.
\n INFERENCE: The image version is compatible with SageMaker AI inference jobs.
\n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
The machine learning framework vended in the image version.
" + } + }, + "ProgrammingLang": { + "target": "com.amazonaws.sagemaker#ProgrammingLang", + "traits": { + "smithy.api#documentation": "The supported programming language and its version.
" + } + }, + "Processor": { + "target": "com.amazonaws.sagemaker#Processor", + "traits": { + "smithy.api#documentation": "Indicates CPU or GPU compatibility.
\n\n CPU: The image version is compatible with CPU.
\n GPU: The image version is compatible with GPU.
Indicates Horovod compatibility.
" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.sagemaker#ReleaseNotes", + "traits": { + "smithy.api#documentation": "The maintainer description of the image version.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateImageVersionResponse": { + "type": "structure", + "members": { + "ImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the image version.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateInferenceComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an inference component, which is a SageMaker AI hosting object that you can\n use to deploy a model to an endpoint. In the inference component settings, you specify the\n model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You\n can optimize resource utilization by tailoring how the required CPU cores, accelerators,\n and memory are allocated. You can deploy multiple inference components to an endpoint,\n where each inference component contains one model and the resource utilization needs for\n that individual model. After you deploy an inference component, you can directly invoke the\n associated model when you use the InvokeEndpoint API action.
" + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique name to assign to the inference component.
", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of an existing endpoint where you host the inference component.
", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "The name of an existing production variant where you host the inference\n component.
" + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.
", + "smithy.api#required": {} + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General\n Reference.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "\n Creates an inference experiment using the configurations specified in the request.\n
\n\n Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For\n more information about inference experiments, see Shadow tests.\n
\n\n Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based\n on your specified configuration.\n
\n\n While the experiment is in progress or after it has concluded, you can view metrics that compare your model\n variants. For more information, see View, monitor, and edit shadow tests.\n
" + } + }, + "com.amazonaws.sagemaker#CreateInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name for the inference experiment.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#InferenceExperimentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The type of the inference experiment that you want to run. The following types of experiments are possible:\n
\n\n ShadowMode: You can use this type to validate a shadow variant. For more information,\n see Shadow tests.\n
\n The duration for which you want the inference experiment to run. If you don't specify this field, the\n experiment automatically starts immediately upon creation and concludes after 7 days.\n
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#InferenceExperimentDescription", + "traits": { + "smithy.api#documentation": "A description for the inference experiment.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n
", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.\n
", + "smithy.api#required": {} + } + }, + "ModelVariants": { + "target": "com.amazonaws.sagemaker#ModelVariantConfigList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n An array of ModelVariantConfig objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfig object in the array describes the infrastructure\n configuration for the corresponding variant.\n
\n The Amazon S3 location and configuration for storing inference request and response data.\n
\n\n This is an optional parameter that you can use for data capture. For more information, see Capture data.\n
" + } + }, + "ShadowModeConfig": { + "target": "com.amazonaws.sagemaker#ShadowModeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n
\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can\n be any of the following formats:\n
KMS key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
KMS key Alias
\n\n \"alias/ExampleAlias\"\n
Amazon Resource Name (ARN) of a KMS key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
\n If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to\n call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for\n your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for\n OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that\n only allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed Encryption Keys\n in the Amazon Simple Storage Service Developer Guide.\n
\n The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.\n
\n Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different\n ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceExperimentResponse": { + "type": "structure", + "members": { + "InferenceExperimentArn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN for your inference experiment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceRecommendationsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Starts a recommendation job. You can create either an instance \n recommendation or load test job.
" + } + }, + "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A name for the recommendation job. The name must be unique within \n the Amazon Web Services Region and within your Amazon Web Services account.\n The job name is passed down to the resources created by the recommendation job.\n The names of resources (such as the model, endpoint configuration, endpoint, and compilation)\n that are prefixed with the job name are truncated at 40 characters.
", + "smithy.api#required": {} + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#RecommendationJobType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Defines the type of recommendation job. Specify Default to initiate an instance \n recommendation and Advanced to initiate a load test. If left unspecified, \n Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Provides information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations.
", + "smithy.api#required": {} + } + }, + "JobDescription": { + "target": "com.amazonaws.sagemaker#RecommendationJobDescription", + "traits": { + "smithy.api#documentation": "Description of the recommendation job.
" + } + }, + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#RecommendationJobStoppingConditions", + "traits": { + "smithy.api#documentation": "A set of conditions for stopping a recommendation job. If any of \n the conditions are met, the job is automatically stopped.
" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobOutputConfig", + "traits": { + "smithy.api#documentation": "Provides information about the output artifacts and the KMS key \n to use for Amazon S3 server-side encryption.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "The metadata that you apply to Amazon Web Services resources to help you \n categorize and organize them. Each tag consists of a key and a value, both of \n which you define. For more information, see \n Tagging Amazon Web Services Resources \n in the Amazon Web Services General Reference.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobResponse": { + "type": "structure", + "members": { + "JobArn": { + "target": "com.amazonaws.sagemaker#RecommendationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommendation job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateLabelingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateLabelingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateLabelingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a job that uses workers to label the data objects in your input dataset. You\n can use the labeled data to train machine learning models.
\nYou can select your workforce from one of three providers:
\nA private workforce that you create. It can include employees, contractors,\n and outside experts. Use a private workforce when want the data to stay within\n your organization or when a specific set of skills is required.
\nOne or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide\n expertise in specific areas.
\nThe Amazon Mechanical Turk workforce. This is the largest workforce, but it\n should only be used for public data or data that has been stripped of any\n personally identifiable information.
\nYou can also use automated data labeling to reduce the number of\n data objects that need to be labeled by a human. Automated data labeling uses\n active learning to determine if a data object can be labeled by\n machine or if it needs to be sent to a human worker. For more information, see Using\n Automated Data Labeling.
\nThe data objects to be labeled are contained in an Amazon S3 bucket. You create a\n manifest file that describes the location of each object. For\n more information, see Using Input and Output Data.
\nThe output can be used as the manifest file for another labeling job or as training\n data for your machine learning models.
\nYou can use this operation to create a static labeling job or a streaming labeling\n job. A static labeling job stops if all data objects in the input manifest file\n identified in ManifestS3Uri have been labeled. A streaming labeling job\n runs perpetually until it is manually stopped, or remains idle for 10 days. You can send\n new data objects to an active (InProgress) streaming labeling job in real\n time. To learn how to create a static labeling job, see Create a Labeling Job\n (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming\n labeling job, see Create a Streaming Labeling\n Job.
The name of the labeling job. This name is used to identify the job in a list of\n labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region.\n LabelingJobName is not case sensitive. For example, Example-job and\n example-job are considered the same labeling job name by Ground Truth.
The attribute name to use for the label in the output manifest file. This is the key\n for the key/value pair formed with the label that a worker assigns to the object. The\n LabelAttributeName must meet the following requirements.
The name can't end with \"-metadata\".
\nIf you are using one of the following built-in task types,\n the attribute name must end with \"-ref\". If the task type\n you are using is not listed below, the attribute name must\n not end with \"-ref\".
\nImage semantic segmentation (SemanticSegmentation), and\n adjustment (AdjustmentSemanticSegmentation) and\n verification (VerificationSemanticSegmentation) labeling\n jobs for this task type.
Video frame object detection (VideoObjectDetection), and\n adjustment and verification\n (AdjustmentVideoObjectDetection) labeling jobs for this\n task type.
Video frame object tracking (VideoObjectTracking), and\n adjustment and verification (AdjustmentVideoObjectTracking)\n labeling jobs for this task type.
3D point cloud semantic segmentation\n (3DPointCloudSemanticSegmentation), and adjustment and\n verification (Adjustment3DPointCloudSemanticSegmentation)\n labeling jobs for this task type.
3D point cloud object tracking\n (3DPointCloudObjectTracking), and adjustment and\n verification (Adjustment3DPointCloudObjectTracking)\n labeling jobs for this task type.
If you are creating an adjustment or verification labeling job, you must use a\n different\n LabelAttributeName than the one used in the original labeling job. The\n original labeling job is the Ground Truth labeling job that produced the labels that you\n want verified or adjusted. To learn more about adjustment and verification labeling\n jobs, see Verify and Adjust\n Labels.
Input data for the labeling job, such as the Amazon S3 location of the data objects and the\n location of the manifest file that describes the data objects.
\nYou must specify at least one of the following: S3DataSource or\n SnsDataSource.
Use SnsDataSource to specify an SNS input topic for a streaming\n labeling job. If you do not specify and SNS input topic ARN, Ground Truth will\n create a one-time labeling job that stops after all data objects in the input\n manifest file have been labeled.
Use S3DataSource to specify an input manifest file for both\n streaming and one-time labeling jobs. Adding an S3DataSource is\n optional if you use SnsDataSource to create a streaming labeling\n job.
If you use the Amazon Mechanical Turk workforce, your input data should not include\n confidential information, personal information or protected health information. Use\n ContentClassifiers to specify that your data is free of personally\n identifiable information and adult content.
The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt\n the output data, if any.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf\n during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker\n can successfully complete data labeling.
", + "smithy.api#required": {} + } + }, + "LabelCategoryConfigS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI of the file, referred to as a label category configuration\n file, that defines the categories used to label the data objects.
\nFor 3D point cloud and video frame task types, you can add label category attributes\n and frame attributes to your label category configuration file. To learn how, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
\nFor named entity recognition jobs, in addition to Add Instructions Add additional instructions.\"labels\", you must\n provide worker instructions in the label category configuration file using the\n \"instructions\" parameter: \"instructions\":\n {\"shortInstruction\":\". For details\n and an example, see Create a\n Named Entity Recognition Labeling Job (API) .Add header
For all other built-in task types and custom\n tasks, your label category configuration file must be a JSON file in the\n following format. Identify the labels you want to use by replacing label_1,\n label_2,...,label_n with your label\n categories.
\n { \n
\n \"document-version\": \"2018-11-28\",\n
\n \"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\":\n \"label_n\"}]\n
\n }\n
Note the following about the label category configuration file:
\nFor image classification and text classification (single and multi-label) you\n must specify at least two label categories. For all other task types, the\n minimum number of label categories required is one.
\nEach label category must be unique, you cannot specify duplicate label\n categories.
\nIf you create a 3D point cloud or video frame adjustment or verification\n labeling job, you must include auditLabelAttributeName in the label\n category configuration. Use this parameter to enter the \n LabelAttributeName\n of the labeling job you want to\n adjust or verify annotations of.
A set of conditions for stopping the labeling job. If any of the conditions are met,\n the job is automatically stopped. You can use these conditions to control the cost of\n data labeling.
" + } + }, + "LabelingJobAlgorithmsConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig", + "traits": { + "smithy.api#documentation": "Configures the information required to perform automated data labeling.
" + } + }, + "HumanTaskConfig": { + "target": "com.amazonaws.sagemaker#HumanTaskConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateLabelingJobResponse": { + "type": "structure", + "members": { + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the\n labeling job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact\n store. For more information, see Create an MLflow Tracking\n Server.
" + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique string identifying the tracking server name. This string is part of the tracking server\n ARN.
", + "smithy.api#required": {} + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact\n store.
", + "smithy.api#required": {} + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "The size of the tracking server you want to create. You can choose between\n \"Small\", \"Medium\", and \"Large\". The default MLflow\n Tracking Server configuration size is \"Small\". You can choose a size depending on\n the projected use of the tracking server such as the volume of data logged, number of users,\n and frequency of use.
We recommend using a small tracking server for teams of up to 25 users, a medium tracking\n server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "The version of MLflow that the tracking server uses. To see which MLflow versions are\n available to use, see How it works.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to\n access the artifact store in Amazon S3. The role should have AmazonS3FullAccess\n permissions. For more information on IAM permissions for tracking server creation, see\n Set up IAM permissions for MLflow.
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Tags consisting of key-value pairs used to manage metadata for the tracking server.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the tracking server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.
\nUse this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.
\nTo host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.
To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.
In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
" + } + }, + "com.amazonaws.sagemaker#CreateModelBiasJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates the definition for a model bias job.
" + } + }, + "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "ModelBiasBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelBiasBaselineConfig", + "traits": { + "smithy.api#documentation": "The baseline configuration for a model bias job.
" + } + }, + "ModelBiasAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelBiasAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configures the model bias job to run a specified Docker container image.
", + "smithy.api#required": {} + } + }, + "ModelBiasJobInput": { + "target": "com.amazonaws.sagemaker#ModelBiasJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Inputs for the model bias job.
", + "smithy.api#required": {} + } + }, + "ModelBiasJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "Networking options for a model bias job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelBiasJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model bias job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelCard": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelCardRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelCardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon SageMaker Model Card.
\nFor information about how to use model cards, see Amazon SageMaker Model Card.
" + } + }, + "com.amazonaws.sagemaker#CreateModelCardExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelCardExportJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelCardExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon SageMaker Model Card export job.
" + } + }, + "com.amazonaws.sagemaker#CreateModelCardExportJobRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model card to export.
", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.
" + } + }, + "ModelCardExportJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model card export job.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#ModelCardExportOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The model card output configuration that specifies the Amazon S3 path for exporting.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelCardExportJobResponse": { + "type": "structure", + "members": { + "ModelCardExportJobArn": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card export job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelCardRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique name of the model card.
", + "smithy.api#required": {} + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelCardSecurityConfig", + "traits": { + "smithy.api#documentation": "An optional Key Management Service \n key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with\n highly sensitive data.
" + } + }, + "Content": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The content of the model card. Content must be in model card JSON schema and provided as a string.
", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
Key-value pairs used to manage metadata for model cards.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelCardResponse": { + "type": "structure", + "members": { + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the successfully created model card.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates the definition for a model explainability job.
" + } + }, + "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "ModelExplainabilityBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityBaselineConfig", + "traits": { + "smithy.api#documentation": "The baseline configuration for a model explainability job.
" + } + }, + "ModelExplainabilityAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configures the model explainability job to run a specified Docker container image.
", + "smithy.api#required": {} + } + }, + "ModelExplainabilityJobInput": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Inputs for the model explainability job.
", + "smithy.api#required": {} + } + }, + "ModelExplainabilityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "Networking options for a model explainability job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelExplainabilityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model explainability job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelInput": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the new model.
", + "smithy.api#required": {} + } + }, + "PrimaryContainer": { + "target": "com.amazonaws.sagemaker#ContainerDefinition", + "traits": { + "smithy.api#documentation": "The location of the primary docker image containing inference code, associated\n artifacts, and custom environment map that the inference code uses when the model is\n deployed for predictions.
" + } + }, + "Containers": { + "target": "com.amazonaws.sagemaker#ContainerDefinitionList", + "traits": { + "smithy.api#documentation": "Specifies the containers in the inference pipeline.
" + } + }, + "InferenceExecutionConfig": { + "target": "com.amazonaws.sagemaker#InferenceExecutionConfig", + "traits": { + "smithy.api#documentation": "Specifies details of how containers in a multi-container endpoint are called.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.
\nTo be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your model to connect\n to. Control access to and from your model container by configuring the VPC.\n VpcConfig is used in hosting services and in batch transform. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch\n Transform Jobs by Using an Amazon Virtual Private Cloud.
Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelOutput": { + "type": "structure", + "members": { + "ModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the model created in SageMaker.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelPackageInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a model package that you can use to create SageMaker models or list on Amazon Web Services\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
\nTo create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.
There are two types of model packages:
\nVersioned - a model that is part of a model group in the model\n registry.
\nUnversioned - a model package that is not part of a model group.
\nCreates a model group. A model group contains a group of model versions.
" + } + }, + "com.amazonaws.sagemaker#CreateModelPackageGroupInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model group.
", + "smithy.api#required": {} + } + }, + "ModelPackageGroupDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A description for the model group.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of key value pairs associated with the model group. For more information, see\n Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelPackageGroupOutput": { + "type": "structure", + "members": { + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the model package. The name must have 1 to 63 characters. Valid characters\n are a-z, A-Z, 0-9, and - (hyphen).
\nThis parameter is required for unversioned models. It is not applicable to versioned\n models.
" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
\nThis parameter is required for versioned models, and does not apply to unversioned\n models.
" + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A description of the model package.
" + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "Specifies details about inference jobs that you can run with models based on this model\n package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nSpecifies configurations for one or more transform jobs that SageMaker runs to test the\n model package.
" + } + }, + "SourceAlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", + "traits": { + "smithy.api#documentation": "Details about the algorithm that was used to create the model package.
" + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "Whether to certify the model package for listing on Amazon Web Services Marketplace.
\nThis parameter is optional for unversioned models, and does not apply to versioned\n models.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
\nIf you supply ModelPackageGroupName, your model package belongs to the model group\n\t you specify and uses the tags associated with the model group. In this case, you cannot\n\t supply a tag argument.\n
Whether the model is approved for deployment.
\nThis parameter is optional for versioned models, and does not apply to unversioned\n models.
\nFor versioned models, the value of this parameter must be set to Approved\n to deploy the model.
A structure that contains model metrics reports.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "A unique token that guarantees that the call to this API is idempotent.
", + "smithy.api#idempotencyToken": {} + } + }, + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.
" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification. The following\n tasks are supported by Inference Recommender:\n \"IMAGE_CLASSIFICATION\" | \"OBJECT_DETECTION\" | \"TEXT_GENERATION\" |\"IMAGE_SEGMENTATION\" |\n \"FILL_MASK\" | \"CLASSIFICATION\" | \"REGRESSION\" | \"OTHER\".
Specify \"OTHER\" if none of the tasks listed fit your use case.
" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point\n to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files\n that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the\n InvokeEndpoint call.
" + } + }, + "CustomerMetadataProperties": { + "target": "com.amazonaws.sagemaker#CustomerMetadataMap", + "traits": { + "smithy.api#documentation": "The metadata properties associated with the model package versions.
" + } + }, + "DriftCheckBaselines": { + "target": "com.amazonaws.sagemaker#DriftCheckBaselines", + "traits": { + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.\n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n
" + } + }, + "AdditionalInferenceSpecifications": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the\n compiled artifacts.
" + } + }, + "SkipModelValidation": { + "target": "com.amazonaws.sagemaker#SkipModelValidation", + "traits": { + "smithy.api#documentation": "Indicates if you want to skip model validation.
" + } + }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "The URI of the source for the model package. If you want to clone a model package,\n set it to the model package Amazon Resource Name (ARN). If you want to register a model,\n set it to the model ARN.
" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", + "traits": { + "smithy.api#documentation": "The KMS Key ID (KMSKeyId) used for encryption of model package information.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
\n A structure describing the current state of the model in its life cycle.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelPackageOutput": { + "type": "structure", + "members": { + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new model package.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateModelQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a definition for a job that monitors model quality and drift. For information\n about model monitor, see Amazon SageMaker AI Model\n Monitor.
" + } + }, + "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the monitoring job definition.
", + "smithy.api#required": {} + } + }, + "ModelQualityBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelQualityBaselineConfig", + "traits": { + "smithy.api#documentation": "Specifies the constraints and baselines for the monitoring job.
" + } + }, + "ModelQualityAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelQualityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The container that runs the monitoring job.
", + "smithy.api#required": {} + } + }, + "ModelQualityJobInput": { + "target": "com.amazonaws.sagemaker#ModelQualityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of the inputs that are monitored. Currently endpoints are supported.
", + "smithy.api#required": {} + } + }, + "ModelQualityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "Specifies the network configuration for the monitoring job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model quality monitoring job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateMonitoringScheduleRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateMonitoringScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to\n monitor the data captured for an Amazon SageMaker AI Endpoint.
" + } + }, + "com.amazonaws.sagemaker#CreateMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost\n Management User Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateMonitoringScheduleResponse": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateNotebookInstanceInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateNotebookInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an SageMaker AI notebook instance. A notebook instance is a machine\n learning (ML) compute instance running on a Jupyter notebook.
\nIn a CreateNotebookInstance request, specify the type of ML compute\n instance that you want to run. SageMaker AI launches the instance, installs common\n libraries that you can use to explore datasets for model training, and attaches an ML\n storage volume to the notebook instance.
SageMaker AI also provides a set of example notebooks. Each notebook\n demonstrates how to use SageMaker AI with a specific algorithm or with a machine\n learning framework.
\nAfter receiving the request, SageMaker AI does the following:
\nCreates a network interface in the SageMaker AI VPC.
\n(Option) If you specified SubnetId, SageMaker AI creates\n a network interface in your own VPC, which is inferred from the subnet ID that\n you provide in the input. When creating this network interface, SageMaker AI attaches the security group that you specified in the request to the network\n interface that it creates in your VPC.
Launches an EC2 instance of the type specified in the request in the\n SageMaker AI VPC. If you specified SubnetId of your VPC,\n SageMaker AI specifies both network interfaces when launching this\n instance. This enables inbound traffic from your own VPC to the notebook\n instance, assuming that the security groups allow it.
After creating the notebook instance, SageMaker AI returns its Amazon Resource\n Name (ARN). You can't change the name of a notebook instance after you create\n it.
\nAfter SageMaker AI creates the notebook instance, you can connect to the\n Jupyter server and work in Jupyter notebooks. For example, you can write code to explore\n a dataset that you can use for model training, train a model, host models by creating\n SageMaker AI endpoints, and validate hosted models.
\nFor more information, see How It Works.
" + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the new notebook instance.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of ML compute instance to launch for the notebook instance.
", + "smithy.api#required": {} + } + }, + "SubnetId": { + "target": "com.amazonaws.sagemaker#SubnetId", + "traits": { + "smithy.api#documentation": "The ID of the subnet in a VPC to which you would like to have a connectivity from\n your ML compute instance.
" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be\n for the same VPC as specified in the subnet.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "When you send any requests to Amazon Web Services resources from the notebook\n instance, SageMaker AI assumes this role to perform tasks on your behalf. You must\n grant this role necessary permissions so SageMaker AI can perform these tasks. The\n policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com)\n permissions to assume this role. For more information, see SageMaker AI Roles.
\nTo be able to pass this role to SageMaker AI, the caller of this API must\n have the iam:PassRole permission.
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker AI uses to encrypt data on the storage volume attached to your\n notebook instance. The KMS key you provide must be enabled. For information, see Enabling and\n Disabling Keys in the Amazon Web Services Key Management Service\n Developer Guide.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + }, + "LifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.
" + } + }, + "DirectInternetAccess": { + "target": "com.amazonaws.sagemaker#DirectInternetAccess", + "traits": { + "smithy.api#documentation": "Sets whether SageMaker AI provides internet access to the notebook instance. If\n you set this to Disabled this notebook instance is able to access resources\n only in your VPC, and is not be able to connect to SageMaker AI training and\n endpoint services unless you configure a NAT Gateway in your VPC.
For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.
The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB.
" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", + "traits": { + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of EI instance types to associate with this\n notebook instance.
" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "traits": { + "smithy.api#documentation": "An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + } + }, + "RootAccess": { + "target": "com.amazonaws.sagemaker#RootAccess", + "traits": { + "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.
Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.
\nThe platform identifier of the notebook instance runtime environment.
" + } + }, + "InstanceMetadataServiceConfiguration": { + "target": "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration", + "traits": { + "smithy.api#documentation": "Information on the IMDS configuration of the notebook instance
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a lifecycle configuration that you can associate with a notebook instance. A\n lifecycle configuration is a collection of shell scripts that\n run when you create or start a notebook instance.
\nEach lifecycle configuration script has a limit of 16384 characters.
\nThe value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log\n group /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigInput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the lifecycle configuration.
", + "smithy.api#required": {} + } + }, + "OnCreate": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "A shell script that runs only once, when you create a notebook instance. The shell\n script must be a base64-encoded string.
" + } + }, + "OnStart": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "A shell script that runs every time you start a notebook instance, including when you\n create the notebook instance. The shell script must be a base64-encoded string.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigOutput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateNotebookInstanceOutput": { + "type": "structure", + "members": { + "NotebookInstanceArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the notebook instance.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateOptimizationJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateOptimizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a job that optimizes a model for inference performance. To create the job, you\n provide the location of a source model, and you provide the settings for the optimization\n techniques that you want the job to apply. When the job completes successfully, SageMaker\n uploads the new optimized model to the output destination that you specify.
\nFor more information about how to use this action, and about the supported optimization\n techniques, see Optimize model inference with Amazon SageMaker.
" + } + }, + "com.amazonaws.sagemaker#CreateOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A custom name for the new optimization job.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
\nDuring model optimization, Amazon SageMaker AI needs your permission to:
\nRead input data from an S3 bucket
\nWrite model artifacts to an S3 bucket
\nWrite logs to Amazon CloudWatch Logs
\nPublish metrics to Amazon CloudWatch
\nYou grant permissions for all of these tasks to an IAM role. To pass this\n role to Amazon SageMaker AI, the caller of this API must have the\n iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.\n
The location of the source model to optimize with an optimization job.
", + "smithy.api#required": {} + } + }, + "DeploymentInstanceType": { + "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of instance that hosts the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "The environment variables to set in the model container.
" + } + }, + "OptimizationConfigs": { + "target": "com.amazonaws.sagemaker#OptimizationConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Settings for each of the optimization techniques that the job applies.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OptimizationJobOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Details for where to store the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of key-value pairs associated with the optimization job. For more information,\n see Tagging Amazon Web Services resources in the Amazon Web Services General Reference\n Guide.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#OptimizationVpcConfig", + "traits": { + "smithy.api#documentation": "A VPC in Amazon VPC that your optimized model has access to.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateOptimizationJobResponse": { + "type": "structure", + "members": { + "OptimizationJobArn": { + "target": "com.amazonaws.sagemaker#OptimizationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates a presigned URL to access an Amazon SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to create the presigned URL for.
", + "smithy.api#required": {} + } + }, + "ExpiresInSeconds": { + "target": "com.amazonaws.sagemaker#ExpiresInSeconds", + "traits": { + "smithy.api#documentation": "The time that will pass before the presigned URL expires.
" + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppPresignedUrlResponse": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.sagemaker#String2048", + "traits": { + "smithy.api#documentation": "The presigned URL that you can use to access the SageMaker Partner AI App.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#PartnerAppName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name to give the SageMaker Partner AI App.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#PartnerAppType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The ARN of the IAM role that the partner application uses.
", + "smithy.api#required": {} + } + }, + "MaintenanceConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", + "traits": { + "smithy.api#documentation": "Maintenance configuration settings for the SageMaker Partner AI App.
" + } + }, + "Tier": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
", + "smithy.api#required": {} + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" + } + }, + "AuthType": { + "target": "com.amazonaws.sagemaker#PartnerAppAuthType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The authorization type that users use to access the SageMaker Partner AI App.
", + "smithy.api#required": {} + } + }, + "EnableIamSessionBasedIdentity": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
A unique token that guarantees that the call to this API is idempotent.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePipelineRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates a pipeline using a JSON pipeline definition.
" + } + }, + "com.amazonaws.sagemaker#CreatePipelineRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the pipeline.
", + "smithy.api#required": {} + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline.
" + } + }, + "PipelineDefinition": { + "target": "com.amazonaws.sagemaker#PipelineDefinition", + "traits": { + "smithy.api#documentation": "The JSON \n pipeline definition of the pipeline.
" + } + }, + "PipelineDefinitionS3Location": { + "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", + "traits": { + "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.
" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "A description of the pipeline.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the created pipeline.
" + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "This is the configuration that controls the parallelism of the pipeline. \n If specified, it applies to all runs of this pipeline by default.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePipelineResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created pipeline.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedDomainUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePresignedDomainUrlRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePresignedDomainUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the\n user will be automatically signed in to the domain, and granted access to all of the Apps and\n files associated with the Domain's Amazon Elastic File System volume. This operation can only be\n called when the authentication mode equals IAM.
\nThe IAM role or user passed to this API defines the permissions to access\n the app. Once the presigned URL is created, no additional permission is required to access\n this URL. IAM authorization policies for this API are also enforced for every\n HTTP request and WebSocket frame that attempts to connect to the app.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker AI\n Studio Through an Interface VPC Endpoint .
\nThe URL that you get from a call to CreatePresignedDomainUrl has a\n default timeout of 5 minutes. You can configure this value using\n ExpiresInSeconds. If you try to use the URL after the timeout limit\n expires, you are directed to the Amazon Web Services console sign-in page.
The JupyterLab session default expiration time is 12 hours. You can configure this\n value using SessionExpirationDurationInSeconds.
\nThe domain ID.
", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the UserProfile to sign-in as.
", + "smithy.api#required": {} + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "The session expiration duration in seconds. This value defaults to 43200.
" + } + }, + "ExpiresInSeconds": { + "target": "com.amazonaws.sagemaker#ExpiresInSeconds", + "traits": { + "smithy.api#documentation": "The number of seconds until the pre-signed URL expires. This value defaults to 300.
" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "The name of the space.
" + } + }, + "LandingUri": { + "target": "com.amazonaws.sagemaker#LandingUri", + "traits": { + "smithy.api#documentation": "The landing page that the user is directed to when accessing the presigned URL. Using this\n value, users can access Studio or Studio Classic, even if it is not the default experience for\n the domain. The supported values are:
\n\n studio::relative/path: Directs users to the relative path in\n Studio.
\n app:JupyterServer:relative/path: Directs users to the relative path in\n the Studio Classic application.
\n app:JupyterLab:relative/path: Directs users to the relative path in the\n JupyterLab application.
\n app:RStudioServerPro:relative/path: Directs users to the relative path in\n the RStudio application.
\n app:CodeEditor:relative/path: Directs users to the relative path in the\n Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
\n app:Canvas:relative/path: Directs users to the relative path in the\n Canvas application.
The presigned URL.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns a presigned URL that you can use to connect to the MLflow UI attached to your\n tracking server. For more information, see Launch the MLflow UI using a presigned URL.
" + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tracking server to connect to your MLflow UI.
", + "smithy.api#required": {} + } + }, + "ExpiresInSeconds": { + "target": "com.amazonaws.sagemaker#ExpiresInSeconds", + "traits": { + "smithy.api#documentation": "The duration in seconds that your presigned URL is valid. The presigned URL can be used\n only once.
" + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "The duration in seconds that your MLflow UI session is valid.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse": { + "type": "structure", + "members": { + "AuthorizedUrl": { + "target": "com.amazonaws.sagemaker#TrackingServerUrl", + "traits": { + "smithy.api#documentation": "A presigned URL with an authorization token.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput" + }, + "traits": { + "smithy.api#documentation": "Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker AI console, when you choose Open next to a\n notebook instance, SageMaker AI opens a new tab showing the Jupyter server home\n page from the notebook instance. The console uses this API to get the URL and show the\n page.
The IAM role or user used to call this API defines the permissions to\n access the notebook instance. Once the presigned URL is created, no additional\n permission is required to access this URL. IAM authorization policies for\n this API are also enforced for every HTTP request and WebSocket frame that attempts to\n connect to the notebook instance.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you\n try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.
\nThe name of the notebook instance.
", + "smithy.api#required": {} + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "The duration of the session, in seconds. The default is 12 hours.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput": { + "type": "structure", + "members": { + "AuthorizedUrl": { + "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", + "traits": { + "smithy.api#documentation": "A JSON object that contains the URL string.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateProcessingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateProcessingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateProcessingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates a processing job.
" + } + }, + "com.amazonaws.sagemaker#CreateProcessingJobRequest": { + "type": "structure", + "members": { + "ProcessingInputs": { + "target": "com.amazonaws.sagemaker#ProcessingInputs", + "traits": { + "smithy.api#documentation": "An array of inputs configuring the data to download into the \n processing container.
" + } + }, + "ProcessingOutputConfig": { + "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", + "traits": { + "smithy.api#documentation": "Output configuration for the processing job.
" + } + }, + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "ProcessingResources": { + "target": "com.amazonaws.sagemaker#ProcessingResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", + "traits": { + "smithy.api#documentation": "The time limit for how long the processing job is allowed to run.
" + } + }, + "AppSpecification": { + "target": "com.amazonaws.sagemaker#AppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configures the processing job to run a specified Docker container image.
", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container. Up to \n 100 key and values entries in the map are supported.
" + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig", + "traits": { + "smithy.api#documentation": "Networking options for a processing job, such as whether to allow inbound and \n outbound network calls to and from processing containers, and the VPC subnets and \n security groups to use for VPC-enabled processing jobs.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.
" + } + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateProcessingJobResponse": { + "type": "structure", + "members": { + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateProjectInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateProjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a machine learning (ML) project that can contain one or more templates that set\n up an ML pipeline from training to deploying an approved model.
" + } + }, + "com.amazonaws.sagemaker#CreateProjectInput": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the project.
", + "smithy.api#required": {} + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A description for the project.
" + } + }, + "ServiceCatalogProvisioningDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. The provisioning \n artifact ID will default to the latest provisioning artifact ID of the product, if you don't \n provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service\n Catalog.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs that you want to use to organize and track your Amazon Web Services\n resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateProjectOutput": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
", + "smithy.api#required": {} + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#ProjectId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the new project.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateSpace": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateSpaceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateSpaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a private space or a space used for real time collaboration in a domain.
" + } + }, + "com.amazonaws.sagemaker#CreateSpaceRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the associated domain.
", + "smithy.api#required": {} + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the space.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Tags to associated with the space. Each tag consists of a key and an optional value. Tag\n keys must be unique for each resource. Tags are searchable using the Search\n API.
A collection of space settings.
" + } + }, + "OwnershipSettings": { + "target": "com.amazonaws.sagemaker#OwnershipSettings", + "traits": { + "smithy.api#documentation": "A collection of ownership settings.
" + } + }, + "SpaceSharingSettings": { + "target": "com.amazonaws.sagemaker#SpaceSharingSettings", + "traits": { + "smithy.api#documentation": "A collection of space sharing settings.
" + } + }, + "SpaceDisplayName": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The name of the space that appears in the SageMaker Studio UI.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateSpaceResponse": { + "type": "structure", + "members": { + "SpaceArn": { + "target": "com.amazonaws.sagemaker#SpaceArn", + "traits": { + "smithy.api#documentation": "The space's Amazon Resource Name (ARN).
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateStudioLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateStudioLifecycleConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateStudioLifecycleConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.
" + } + }, + "com.amazonaws.sagemaker#CreateStudioLifecycleConfigRequest": { + "type": "structure", + "members": { + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create.
", + "smithy.api#required": {} + } + }, + "StudioLifecycleConfigContent": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This\n content must be base64 encoded.
", + "smithy.api#required": {} + } + }, + "StudioLifecycleConfigAppType": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The App type that the Lifecycle Configuration is attached to.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an\n optional value. Tag keys must be unique per resource. Tags are searchable using the Search\n API.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateStudioLifecycleConfigResponse": { + "type": "structure", + "members": { + "StudioLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "The ARN of your created Lifecycle Configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTrainingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTrainingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.
\nIf you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n
\nIn the request body, you provide the following:
\n\n AlgorithmSpecification - Identifies the training algorithm to\n use.\n
\n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access\n IDs, secrets or tokens in any hyperparameter field. If the use of\n security-sensitive credentials are detected, SageMaker will reject your training\n job request and return an exception error.
\n\n InputDataConfig - Describes the input required by the training\n job and the Amazon S3, EFS, or FSx location where it is stored.
\n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.
\n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.
\n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.
\n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.
\n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.
\n Environment - The environment variables to set in the Docker\n container.
\n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" + } + }, + "com.amazonaws.sagemaker#CreateTrainingJobRequest": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the training job. The name must be unique within an Amazon Web Services\n Region in an Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
\nYou can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.
Do not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.
\nThe registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform\n tasks on your behalf.
\nDuring model training, SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see SageMaker\n Roles.
\nTo be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.
An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.
Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be downloaded.
\nYour input must be in the same Amazon Web Services region as your training\n job.
" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the path to the S3 location where you want to store model artifacts. SageMaker\n creates subfolders for the artifacts.
", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The resources, including the ML compute instances and ML storage volumes, to use\n for model training.
\nML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.
A VpcConfig object that specifies the VPC that you want your training job to\n connect to. Control access to and from your training container by configuring the VPC.\n For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n you enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
" + } + }, + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training. For more information, see Protect Communications Between ML\n Compute Instances in a Distributed Training Job.
To train models using managed spot training, choose True. Managed spot\n training provides a fully managed and scalable infrastructure for training machine\n learning models. this option is useful when training jobs can be interrupted and when\n there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be\n used as a starting point to train models incrementally. Amazon SageMaker provides metrics and\n logs in CloudWatch. They can be used to see when managed spot training jobs are running,\n interrupted, resumed, or completed.
" + } + }, + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig", + "traits": { + "smithy.api#documentation": "Contains information about the output location for managed spot training checkpoint\n data.
" + } + }, + "DebugHookConfig": { + "target": "com.amazonaws.sagemaker#DebugHookConfig" + }, + "DebugRuleConfigurations": { + "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", + "traits": { + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
" + } + }, + "TensorBoardOutputConfig": { + "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "ProfilerConfig": { + "target": "com.amazonaws.sagemaker#ProfilerConfig" + }, + "ProfilerRuleConfigurations": { + "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", + "traits": { + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.
" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container.
" + } + }, + "RetryStrategy": { + "target": "com.amazonaws.sagemaker#RetryStrategy", + "traits": { + "smithy.api#documentation": "The number of times to retry the job when the job fails due to an\n InternalServerError.
Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" + } + }, + "InfraCheckConfig": { + "target": "com.amazonaws.sagemaker#InfraCheckConfig", + "traits": { + "smithy.api#documentation": "Contains information about the infrastructure health check configuration for the training job.
" + } + }, + "SessionChainingConfig": { + "target": "com.amazonaws.sagemaker#SessionChainingConfig", + "traits": { + "smithy.api#documentation": "Contains information about attribute-based access control (ABAC) for the training\n job.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTrainingJobResponse": { + "type": "structure", + "members": { + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTrainingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTrainingPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTrainingPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new training plan in SageMaker to reserve compute capacity.
\nAmazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU\n capacity for large-scale AI model training. It provides a way to secure predictable access\n to computational resources within specific timelines and budgets, without the need to\n manage underlying infrastructure.
\n\n How it works\n
\nPlans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod\n clusters, automatically provisioning resources, setting up infrastructure, executing\n workloads, and handling infrastructure failures.
\n\n Plan creation workflow\n
\nUsers search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration) using the \n SearchTrainingPlanOfferings\n API operation.
They create a plan that best matches their needs using the ID of the plan offering\n they want to use.
\nAfter successful upfront payment, the plan's status becomes\n Scheduled.
The plan can be used to:
\nQueue training jobs.
\nAllocate to an instance group of a SageMaker HyperPod cluster.
\nWhen the plan start date arrives, it becomes Active. Based on\n available reserved capacity:
Training jobs are launched.
\nInstance groups are provisioned.
\n\n Plan composition\n
\nA plan can consist of one or more Reserved Capacities, each defined by a specific\n instance type, quantity, Availability Zone, duration, and start and end times. For more\n information about Reserved Capacity, see \n ReservedCapacitySummary\n .
The name of the training plan to create.
", + "smithy.api#required": {} + } + }, + "TrainingPlanOfferingId": { + "target": "com.amazonaws.sagemaker#TrainingPlanOfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the training plan offering to use for creating this\n plan.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs to apply to this training plan.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTrainingPlanResponse": { + "type": "structure", + "members": { + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the created training plan.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTransformJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTransformJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTransformJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.
\nTo perform batch transformations, you create a transform job and use the data that you\n have readily available.
\nIn the request body, you provide the following:
\n\n TransformJobName - Identifies the transform job. The name must be\n unique within an Amazon Web Services Region in an Amazon Web Services account.
\n ModelName - Identifies the model to use. ModelName\n must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services\n\t\t account. For information on creating a model, see CreateModel.
\n TransformInput - Describes the dataset to be transformed and the\n Amazon S3 location where it is stored.
\n TransformOutput - Identifies the Amazon S3 location where you want\n Amazon SageMaker to save the results from the transform job.
\n TransformResources - Identifies the ML compute instances for the\n transform job.
For more information about how batch transformation works, see Batch\n Transform.
" + } + }, + "com.amazonaws.sagemaker#CreateTransformJobRequest": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the transform job. The name must be unique within an Amazon Web Services Region in an\n Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model that you want to use for the transform job.\n ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services\n Region in an Amazon Web Services account.
The maximum number of parallel requests that can be sent to each instance in a\n transform job. If MaxConcurrentTransforms is set to 0 or left\n unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your\n chosen algorithm. If the execution-parameters endpoint is not enabled, the default value\n is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to\n set a value for MaxConcurrentTransforms.
Configures the timeout and maximum number of retries for processing a transform job\n invocation.
" + } + }, + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "traits": { + "smithy.api#documentation": "The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n
The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify\n the MaxConcurrentTransforms parameter, the value of\n (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100\n MB.
For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.
Specifies the number of records to include in a mini-batch for an HTTP inference\n request. A record\n is a single unit of input data that\n inference can be made on. For example, a single line in a CSV file is a record.
\nTo enable the batch strategy, you must set the SplitType property to\n Line, RecordIO, or TFRecord.
To use only one record when making an HTTP invocation request to a container, set\n BatchStrategy to SingleRecord and SplitType\n to Line.
To fit as many records in a mini-batch as can fit within the\n MaxPayloadInMB limit, set BatchStrategy to\n MultiRecord and SplitType to Line.
The environment variables to set in the Docker container. Don't include any\n sensitive data in your environment variables. We support up to 16 key and\n values entries in the map.
" + } + }, + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes the input source and\n the\n way the transform job consumes it.
", + "smithy.api#required": {} + } + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes the results of the transform job.
", + "smithy.api#required": {} + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig", + "traits": { + "smithy.api#documentation": "Configuration to control how SageMaker captures inference data.
" + } + }, + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes the resources, including\n ML\n instance types and ML instance count, to use for the transform\n job.
", + "smithy.api#required": {} + } + }, + "DataProcessing": { + "target": "com.amazonaws.sagemaker#DataProcessing", + "traits": { + "smithy.api#documentation": "The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "(Optional)\n An\n array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.
" + } + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTransformJobResponse": { + "type": "structure", + "members": { + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTrial": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTrialRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTrialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates an SageMaker trial. A trial is a set of steps called\n trial components that produce a machine learning model. A trial is part\n of a single SageMaker experiment.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to a trial and then use the Search API to search for\n the tags.
\nTo get a list of all your trials, call the ListTrials API. To view a\n trial's properties, call the DescribeTrial API. To create a trial component,\n call the CreateTrialComponent API.
" + } + }, + "com.amazonaws.sagemaker#CreateTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a trial component, which is a stage of a machine learning\n trial. A trial is composed of one or more trial components. A trial\n component can be used in multiple trials.
\nTrial components include pre-processing jobs, training jobs, and batch transform\n jobs.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to a trial component and then use the Search API to\n search for the tags.
" + } + }, + "com.amazonaws.sagemaker#CreateTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the component. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.
The status of the component. States include:
\nInProgress
\nCompleted
\nFailed
\nWhen the component started.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component ended.
" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "traits": { + "smithy.api#documentation": "The hyperparameters for the component.
" + } + }, + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "The input artifacts for the component. Examples of input artifacts are datasets,\n algorithms, hyperparameters, source code, and instance types.
" + } + }, + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "The output artifacts for the component. Examples of output artifacts are metrics,\n snapshots, logs, and images.
" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to associate with the component. You can use Search API\n to search on the tags.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateTrialRequest": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the trial. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.
The name of the experiment to associate the trial with.
", + "smithy.api#required": {} + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to associate with the trial. You can use Search API to\n search on the tags.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateTrialResponse": { + "type": "structure", + "members": { + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateUserProfileRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateUserProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to a domain. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user\n profile is automatically created. A user profile is the primary holder of settings for an\n individual user and has a reference to the user's private Amazon Elastic File System home\n directory.
" + } + }, + "com.amazonaws.sagemaker#CreateUserProfileRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the associated Domain.
", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A name for the UserProfile. This value is not case sensitive.
", + "smithy.api#required": {} + } + }, + "SingleSignOnUserIdentifier": { + "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", + "traits": { + "smithy.api#documentation": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only\n supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is\n required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.\n
" + } + }, + "SingleSignOnUserValue": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The username of the associated Amazon Web Services Single Sign-On User for this\n UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must\n match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
\nTags that you specify for the User Profile are also added to all Apps that the User\n Profile launches.
" + } + }, + "UserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "A collection of settings.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateUserProfileResponse": { + "type": "structure", + "members": { + "UserProfileArn": { + "target": "com.amazonaws.sagemaker#UserProfileArn", + "traits": { + "smithy.api#documentation": "The user profile Amazon Resource Name (ARN).
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateWorkforce": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateWorkforceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateWorkforceResponse" + }, + "traits": { + "smithy.api#documentation": "Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the Amazon Web Services Region that you specify. You can only\n create one workforce in each Amazon Web Services Region per Amazon Web Services account.
\nIf you want to create a new workforce in an Amazon Web Services Region where \n a workforce already exists, use the DeleteWorkforce API\n operation to delete the existing workforce and then use CreateWorkforce \n to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. Your OIDC IdP must support groups\n because groups are used by Ground Truth and Amazon A2I to create work teams. \n For more information, see \n Create a Private Workforce (OIDC IdP).
Use this parameter to configure an Amazon Cognito private workforce.\n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.
\nDo not use OidcConfig if you specify values for \n CognitoConfig.
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
\nDo not use CognitoConfig if you specify values for \n OidcConfig.
The name of the private workforce.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs that contain metadata to help you categorize and \n organize our workforce. Each tag consists of a key and a value, \n both of which you define.
" + } + }, + "WorkforceVpcConfig": { + "target": "com.amazonaws.sagemaker#WorkforceVpcConfigRequest", + "traits": { + "smithy.api#documentation": "Use this parameter to configure a workforce using VPC.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateWorkforceResponse": { + "type": "structure", + "members": { + "WorkforceArn": { + "target": "com.amazonaws.sagemaker#WorkforceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workforce.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreateWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateWorkteamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new work team for labeling your data. A work team is defined by one or more\n Amazon Cognito user pools. You must first create the user pools before you can create a work\n team.
\nYou cannot create more than 25 work teams in an account and region.
" + } + }, + "com.amazonaws.sagemaker#CreateWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the work team. Use this name to identify the work team.
", + "smithy.api#required": {} + } + }, + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#documentation": "The name of the workforce.
" + } + }, + "MemberDefinitions": { + "target": "com.amazonaws.sagemaker#MemberDefinitions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For\n private workforces created using Amazon Cognito use CognitoMemberDefinition. For\n workforces created using your own OIDC identity provider (IdP) use\n OidcMemberDefinition. Do not provide input for both of these parameters\n in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to \n include in your private work team in OidcMemberDefinition by listing those groups\n in Groups.
A description of the work team.
", + "smithy.api#required": {} + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.sagemaker#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "Configures notification of workers regarding available or expiring work items.
" + } + }, + "WorkerAccessConfiguration": { + "target": "com.amazonaws.sagemaker#WorkerAccessConfiguration", + "traits": { + "smithy.api#documentation": "Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs.
\nFor more information, see Resource\n Tag and Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateWorkteamResponse": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the\n work team.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#CreationTime": { + "type": "timestamp" + }, + "com.amazonaws.sagemaker#CrossAccountFilterOption": { + "type": "enum", + "members": { + "SAME_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SameAccount" + } + }, + "CROSS_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CrossAccount" + } + } + } + }, + "com.amazonaws.sagemaker#CsvContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*$" + } + }, + "com.amazonaws.sagemaker#CsvContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CsvContentType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#CurrencyCode": { + "type": "string" + }, + "com.amazonaws.sagemaker#CustomFileSystem": { + "type": "union", + "members": { + "EFSFileSystem": { + "target": "com.amazonaws.sagemaker#EFSFileSystem", + "traits": { + "smithy.api#documentation": "A custom file system in Amazon EFS.
" + } + }, + "FSxLustreFileSystem": { + "target": "com.amazonaws.sagemaker#FSxLustreFileSystem", + "traits": { + "smithy.api#documentation": "A custom file system in Amazon FSx for Lustre.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\n Studio.
" + } + }, + "com.amazonaws.sagemaker#CustomFileSystemConfig": { + "type": "union", + "members": { + "EFSFileSystemConfig": { + "target": "com.amazonaws.sagemaker#EFSFileSystemConfig", + "traits": { + "smithy.api#documentation": "The settings for a custom Amazon EFS file system.
" + } + }, + "FSxLustreFileSystemConfig": { + "target": "com.amazonaws.sagemaker#FSxLustreFileSystemConfig", + "traits": { + "smithy.api#documentation": "The settings for a custom Amazon FSx for Lustre file system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\n Studio.
" + } + }, + "com.amazonaws.sagemaker#CustomFileSystemConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CustomFileSystemConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#CustomFileSystems": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CustomFileSystem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#CustomImage": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the CustomImage. Must be unique to your account.
", + "smithy.api#required": {} + } + }, + "ImageVersionNumber": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the CustomImage.
" + } + }, + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the AppImageConfig.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A custom SageMaker AI image. For more information, see\n Bring your own SageMaker AI image.
" + } + }, + "com.amazonaws.sagemaker#CustomImageContainerArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NonEmptyString64" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#CustomImageContainerEntrypoint": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#CustomImageContainerEnvironmentVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "value": { + "target": "com.amazonaws.sagemaker#String256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#CustomImages": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CustomImage" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.sagemaker#CustomPosixUserConfig": { + "type": "structure", + "members": { + "Uid": { + "target": "com.amazonaws.sagemaker#Uid", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The POSIX user ID.
", + "smithy.api#required": {} + } + }, + "Gid": { + "target": "com.amazonaws.sagemaker#Gid", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The POSIX group ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the POSIX identity that is used for file system operations.
" + } + }, + "com.amazonaws.sagemaker#CustomerMetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}$" + } + }, + "com.amazonaws.sagemaker#CustomerMetadataKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CustomerMetadataKey" + } + }, + "com.amazonaws.sagemaker#CustomerMetadataMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#CustomerMetadataKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#CustomerMetadataValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#CustomerMetadataValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}$" + } + }, + "com.amazonaws.sagemaker#CustomizedMetricSpecification": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The name of the customized metric.
" + } + }, + "Namespace": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The namespace of the customized metric.
" + } + }, + "Statistic": { + "target": "com.amazonaws.sagemaker#Statistic", + "traits": { + "smithy.api#documentation": "The statistic of the customized metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A customized metric.
" + } + }, + "com.amazonaws.sagemaker#DataCaptureConfig": { + "type": "structure", + "members": { + "EnableCapture": { + "target": "com.amazonaws.sagemaker#EnableCapture", + "traits": { + "smithy.api#documentation": "Whether data capture should be enabled or disabled (defaults to enabled).
" + } + }, + "InitialSamplingPercentage": { + "target": "com.amazonaws.sagemaker#SamplingPercentage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The percentage of requests SageMaker AI will capture. A lower value is recommended\n for Endpoints with high traffic.
", + "smithy.api#required": {} + } + }, + "DestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 location used to capture the data.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI\n uses to encrypt the captured data at rest using Amazon S3 server-side\n encryption.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
Specifies data Model Monitor will capture. You can configure whether to collect only\n input, only output, or both
", + "smithy.api#required": {} + } + }, + "CaptureContentTypeHeader": { + "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader", + "traits": { + "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified\n SageMaker AI will by default base64 encode when capturing the data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration to control how SageMaker AI captures inference data.
" + } + }, + "com.amazonaws.sagemaker#DataCaptureConfigSummary": { + "type": "structure", + "members": { + "EnableCapture": { + "target": "com.amazonaws.sagemaker#EnableCapture", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether data capture is enabled or disabled.
", + "smithy.api#required": {} + } + }, + "CaptureStatus": { + "target": "com.amazonaws.sagemaker#CaptureStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether data capture is currently functional.
", + "smithy.api#required": {} + } + }, + "CurrentSamplingPercentage": { + "target": "com.amazonaws.sagemaker#SamplingPercentage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The percentage of requests being captured by your Endpoint.
", + "smithy.api#required": {} + } + }, + "DestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 location being used to capture the data.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The KMS key being used to encrypt the data in Amazon S3.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The currently active data capture configuration used by your Endpoint.
" + } + }, + "com.amazonaws.sagemaker#DataCatalogConfig": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.sagemaker#TableName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Glue table.
", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.sagemaker#Catalog", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Glue table catalog.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.sagemaker#Database", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Glue table database.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The meta data of the Glue table which serves as data catalog for the\n OfflineStore.
A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.
Examples: \"$\", \"$[1:]\", \"$.features\"\n
A JSONPath expression used to select a portion of the joined dataset to save\n in the output file for a batch transform job. If you want SageMaker to store the entire input\n dataset in the output file, leave the default value, $. If you specify\n indexes that aren't within the dimension size of the joined dataset, you get an\n error.
Examples: \"$\", \"$[0,5:]\",\n \"$['id','SageMakerOutput']\"\n
Specifies the source of the data to join with the transformed data. The valid values\n are None and Input. The default value is None,\n which specifies not to join the input with the transformed data. If you want the batch\n transform job to join the original input data with the transformed data, set\n JoinSource to Input. You can specify\n OutputFilter as an additional filter to select a portion of the joined\n dataset and store it in the output file.
For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to\n the input JSON object in an attribute called SageMakerOutput. The joined\n result for JSON must be a key-value pair object. If the input is not a key-value pair\n object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored\n under the SageMakerInput key and the results are stored in\n SageMakerOutput.
For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with\n the input by appending each transformed row to the end of the input. The joined data has\n the original input data followed by the transformed data and the output is a CSV\n file.
\nFor information on how joining in applied, see Workflow for Associating Inferences with Input Records.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.
" + } + }, + "com.amazonaws.sagemaker#DataQualityAppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The container image that the data quality monitoring job runs.
", + "smithy.api#required": {} + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "traits": { + "smithy.api#documentation": "The entrypoint for a container used to run a monitoring job.
" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", + "traits": { + "smithy.api#documentation": "The arguments to send to the container that the monitoring job runs.
" + } + }, + "RecordPreprocessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" + } + }, + "PostAnalyticsProcessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "Sets the environment variables in the container that the monitoring job runs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the container that a data quality monitoring job runs.
" + } + }, + "com.amazonaws.sagemaker#DataQualityBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "The name of the job that performs baselining for the data quality monitoring job.
" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" + }, + "StatisticsResource": { + "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" + } + }, + "com.amazonaws.sagemaker#DataQualityJobInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "Input object for the batch transform job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the data quality monitoring job. Currently endpoints are supported for\n input.
" + } + }, + "com.amazonaws.sagemaker#DataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#S3DataSource", + "traits": { + "smithy.api#documentation": "The S3 location of the data source that is associated with a channel.
" + } + }, + "FileSystemDataSource": { + "target": "com.amazonaws.sagemaker#FileSystemDataSource", + "traits": { + "smithy.api#documentation": "The file system that is associated with a channel.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the location of the channel data.
" + } + }, + "com.amazonaws.sagemaker#DataSourceName": { + "type": "enum", + "members": { + "SalesforceGenie": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SalesforceGenie" + } + }, + "Snowflake": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Snowflake" + } + } + } + }, + "com.amazonaws.sagemaker#Database": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.sagemaker#DatasetDefinition": { + "type": "structure", + "members": { + "AthenaDatasetDefinition": { + "target": "com.amazonaws.sagemaker#AthenaDatasetDefinition" + }, + "RedshiftDatasetDefinition": { + "target": "com.amazonaws.sagemaker#RedshiftDatasetDefinition" + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#documentation": "The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a\n processing job. LocalPath is an absolute path to the input data. This is a required\n parameter when AppManaged is False (default).
Whether the generated dataset is FullyReplicated or\n ShardedByS3Key (default).
Whether to use File or Pipe input mode. In File (default) mode,\n Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store\n (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used\n input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your\n algorithm without using the EBS volume.
Configuration for Dataset Definition inputs. The Dataset Definition input must specify\n exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition\n types.
Path to local storage location for metrics and tensors. Defaults to\n /opt/ml/output/tensors/.
Path to Amazon S3 storage location for metrics and tensors.
", + "smithy.api#required": {} + } + }, + "HookParameters": { + "target": "com.amazonaws.sagemaker#HookParameters", + "traits": { + "smithy.api#documentation": "Configuration information for the Amazon SageMaker Debugger hook parameters.
" + } + }, + "CollectionConfigurations": { + "target": "com.amazonaws.sagemaker#CollectionConfigurations", + "traits": { + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about\n how to configure the CollectionConfiguration parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n
Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and\n storage paths. To learn more about\n how to configure the DebugHookConfig parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the rule configuration. It must be unique relative to other rule\n configuration names.
", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "Path to local storage location for output of rules. Defaults to\n /opt/ml/processing/output/rule/.
Path to Amazon S3 storage location for rules.
" + } + }, + "RuleEvaluatorImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "traits": { + "smithy.api#documentation": "The instance type to deploy a custom rule for debugging a training job.
" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to the processing instance.
" + } + }, + "RuleParameters": { + "target": "com.amazonaws.sagemaker#RuleParameters", + "traits": { + "smithy.api#documentation": "Runtime configuration for rule container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information for SageMaker Debugger rules for debugging. To learn more about\n how to configure the DebugRuleConfiguration parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the rule configuration.
" + } + }, + "RuleEvaluationJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule evaluation job.
" + } + }, + "RuleEvaluationStatus": { + "target": "com.amazonaws.sagemaker#RuleEvaluationStatus", + "traits": { + "smithy.api#documentation": "Status of the rule evaluation.
" + } + }, + "StatusDetails": { + "target": "com.amazonaws.sagemaker#StatusDetails", + "traits": { + "smithy.api#documentation": "Details from the rule evaluation.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp when the rule evaluation status was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the status of the rule evaluation.
" + } + }, + "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#DeepHealthCheckType": { + "type": "enum", + "members": { + "INSTANCE_STRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceStress" + } + }, + "INSTANCE_CONNECTIVITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceConnectivity" + } + } + } + }, + "com.amazonaws.sagemaker#DefaultEbsStorageSettings": { + "type": "structure", + "members": { + "DefaultEbsVolumeSizeInGb": { + "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The default size of the EBS storage volume for a space.
", + "smithy.api#required": {} + } + }, + "MaximumEbsVolumeSizeInGb": { + "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The maximum size of the EBS storage volume for a space.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
" + } + }, + "com.amazonaws.sagemaker#DefaultGid": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.sagemaker#DefaultSpaceSettings": { + "type": "structure", + "members": { + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the execution role for the space.
" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "The security group IDs for the Amazon VPC that the space uses for\n communication.
" + } + }, + "JupyterServerAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterServerAppSettings" + }, + "KernelGatewayAppSettings": { + "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings" + }, + "JupyterLabAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterLabAppSettings" + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings" + }, + "CustomPosixUserConfig": { + "target": "com.amazonaws.sagemaker#CustomPosixUserConfig" + }, + "CustomFileSystemConfigs": { + "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", + "traits": { + "smithy.api#documentation": "The settings for assigning a custom file system to a domain. Permitted users can access\n this file system in Amazon SageMaker AI Studio.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default settings for shared spaces that users create in the domain.
\nSageMaker applies these settings only to shared spaces. It doesn't apply them to private\n spaces.
" + } + }, + "com.amazonaws.sagemaker#DefaultSpaceStorageSettings": { + "type": "structure", + "members": { + "DefaultEbsStorageSettings": { + "target": "com.amazonaws.sagemaker#DefaultEbsStorageSettings", + "traits": { + "smithy.api#documentation": "The default EBS storage settings for a space.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default storage settings for a space.
" + } + }, + "com.amazonaws.sagemaker#DefaultUid": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.sagemaker#DeleteAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteActionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an action.
" + } + }, + "com.amazonaws.sagemaker#DeleteActionRequest": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the action to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteActionResponse": { + "type": "structure", + "members": { + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteAlgorithm": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteAlgorithmInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specified algorithm from your account.
" + } + }, + "com.amazonaws.sagemaker#DeleteAlgorithmInput": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the algorithm to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteAppRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Used to stop and delete an app.
" + } + }, + "com.amazonaws.sagemaker#DeleteAppImageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteAppImageConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an AppImageConfig.
" + } + }, + "com.amazonaws.sagemaker#DeleteAppImageConfigRequest": { + "type": "structure", + "members": { + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the AppImageConfig to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteAppRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The domain ID.
", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be\n set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
The type of app.
", + "smithy.api#required": {} + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteArtifact": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteArtifactRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteArtifactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an artifact. Either ArtifactArn or Source must be\n specified.
The Amazon Resource Name (ARN) of the artifact to delete.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ArtifactSource", + "traits": { + "smithy.api#documentation": "The URI of the source.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteArtifactResponse": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteAssociationRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an association.
" + } + }, + "com.amazonaws.sagemaker#DeleteAssociationRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the source.
", + "smithy.api#required": {} + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteAssociationResponse": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "The ARN of the source.
" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Delete a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#DeleteClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteClusterSchedulerConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the cluster policy of the cluster.
" + } + }, + "com.amazonaws.sagemaker#DeleteClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteCodeRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteCodeRepositoryInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Deletes the specified Git repository from your account.
" + } + }, + "com.amazonaws.sagemaker#DeleteCodeRepositoryInput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Git repository to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteCompilationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteCompilationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified compilation job. This action deletes only the compilation job\n resource in Amazon SageMaker AI. It doesn't delete other resources that are related to\n that job, such as the model artifacts that the job creates, the compilation logs in\n CloudWatch, the compiled model, or the IAM role.
\nYou can delete a compilation job only if its current status is COMPLETED,\n FAILED, or STOPPED. If the job status is\n STARTING or INPROGRESS, stop the job, and then delete it\n after its status becomes STOPPED.
The name of the compilation job to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteComputeQuotaRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the compute allocation from the cluster.
" + } + }, + "com.amazonaws.sagemaker#DeleteComputeQuotaRequest": { + "type": "structure", + "members": { + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteContext": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteContextRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteContextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an context.
" + } + }, + "com.amazonaws.sagemaker#DeleteContextRequest": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the context to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteContextResponse": { + "type": "structure", + "members": { + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteDataQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteDataQualityJobDefinitionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a data quality monitoring job definition.
" + } + }, + "com.amazonaws.sagemaker#DeleteDataQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the data quality monitoring job definition to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteDeviceFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteDeviceFleetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a fleet.
" + } + }, + "com.amazonaws.sagemaker#DeleteDeviceFleetRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteDomainRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Used to delete a domain. If you onboarded with IAM mode, you will need to delete your\n domain to onboard again using IAM Identity Center. Use with caution. All of the members of the\n domain will lose access to their EFS volume, including data, notebooks, and other artifacts.\n
" + } + }, + "com.amazonaws.sagemaker#DeleteDomainRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The domain ID.
", + "smithy.api#required": {} + } + }, + "RetentionPolicy": { + "target": "com.amazonaws.sagemaker#RetentionPolicy", + "traits": { + "smithy.api#documentation": "The retention policy for this domain, which specifies whether resources will be retained\n after the Domain is deleted. By default, all resources are retained (not automatically\n deleted).
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlanRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an edge deployment plan if (and only if) all the stages in the plan are\n inactive or there are no stages in the plan.
" + } + }, + "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlanRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteEdgeDeploymentStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteEdgeDeploymentStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "Delete a stage in an edge deployment plan if (and only if) the stage is\n inactive.
" + } + }, + "com.amazonaws.sagemaker#DeleteEdgeDeploymentStageRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan from which the stage will be deleted.
", + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stage.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteEndpointInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the\n endpoint was created.
\nSageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.
\nWhen you delete your endpoint, SageMaker asynchronously deletes associated endpoint\n resources such as KMS key grants. You might still see these resources in your account\n for a few minutes after deleting your endpoint. Do not delete or revoke the permissions\n for your \n ExecutionRoleArn\n , otherwise SageMaker cannot delete these\n resources.
Deletes an endpoint configuration. The DeleteEndpointConfig API\n deletes only the specified configuration. It does not delete endpoints created using the\n configuration.
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint operations\n are being performed on the endpoint. If you delete the EndpointConfig of an\n endpoint that is active or being created or updated you may lose visibility into the\n instance type the endpoint is using. The endpoint must be deleted in order to stop\n incurring charges.
The name of the endpoint configuration that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteEndpointInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an SageMaker experiment. All trials associated with the experiment must be deleted\n first. Use the ListTrials API to get a list of the trials associated with\n the experiment.
" + } + }, + "com.amazonaws.sagemaker#DeleteExperimentRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the experiment to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteExperimentResponse": { + "type": "structure", + "members": { + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment that is being deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteFeatureGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteFeatureGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Delete the FeatureGroup and any data that was written to the\n OnlineStore of the FeatureGroup. Data cannot be accessed from\n the OnlineStore immediately after DeleteFeatureGroup is called.
Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your\n OfflineStore are not deleted.
Note that it can take approximately 10-15 minutes to delete an OnlineStore\n FeatureGroup with the InMemory\n StorageType.
The name of the FeatureGroup you want to delete. The name must be unique\n within an Amazon Web Services Region in an Amazon Web Services account.
Deletes the specified flow definition.
" + } + }, + "com.amazonaws.sagemaker#DeleteFlowDefinitionRequest": { + "type": "structure", + "members": { + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the flow definition you are deleting.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteFlowDefinitionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHubRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Delete a hub.
" + } + }, + "com.amazonaws.sagemaker#DeleteHubContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHubContentRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Delete the contents of a hub.
" + } + }, + "com.amazonaws.sagemaker#DeleteHubContentReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHubContentReferenceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Delete a hub content reference in order to remove a model from a private hub.
" + } + }, + "com.amazonaws.sagemaker#DeleteHubContentReferenceRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub to delete the hub content reference from.
", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of hub content reference to delete. The only supported type of hub content reference to delete is ModelReference.
The name of the hub content to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteHubContentRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub that you want to delete content in.
", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of content that you want to delete from a hub.
", + "smithy.api#required": {} + } + }, + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the content that you want to delete from a hub.
", + "smithy.api#required": {} + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the content that you want to delete from a hub.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteHubRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteHumanTaskUi": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHumanTaskUiRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteHumanTaskUiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Use this operation to delete a human task user interface (worker task template).
\n\n To see a list of human task user interfaces\n (work task templates) in your account, use ListHumanTaskUis.\n When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.
The name of the human task user interface (work task template) you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteHumanTaskUiResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteHyperParameterTuningJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteHyperParameterTuningJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob\n API deletes only the tuning job entry that was created in SageMaker when you called the\n CreateHyperParameterTuningJob API. It does not delete training jobs,\n artifacts, or the IAM role that you specified when creating the model.
The name of the hyperparameter tuning job that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteImageRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a SageMaker AI image and all versions of the image. The container images aren't\n deleted.
" + } + }, + "com.amazonaws.sagemaker#DeleteImageRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteImageResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteImageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteImageVersionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteImageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a version of a SageMaker AI image. The container image the version represents isn't\n deleted.
" + } + }, + "com.amazonaws.sagemaker#DeleteImageVersionRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image to delete.
", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "The version to delete.
" + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "The alias of the image to delete.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteImageVersionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteInferenceComponentInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Deletes an inference component.
" + } + }, + "com.amazonaws.sagemaker#DeleteInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference component to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an inference experiment.
\n\n This operation does not delete your endpoint, variants, or any underlying resources. This operation only\n deletes the metadata of your experiment.\n
\nThe name of the inference experiment you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteInferenceExperimentResponse": { + "type": "structure", + "members": { + "InferenceExperimentArn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the deleted inference experiment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
" + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the the tracking server to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "A TrackingServerArn object, the ARN of the tracking server that is deleted if\n successfully found.
Deletes a model. The DeleteModel API deletes only the model entry that\n was created in SageMaker when you called the CreateModel API. It does not delete\n model artifacts, inference code, or the IAM role that you specified when creating the\n model.
Deletes an Amazon SageMaker AI model bias job definition.
" + } + }, + "com.amazonaws.sagemaker#DeleteModelBiasJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model bias job definition to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelCard": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelCardRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon SageMaker Model Card.
" + } + }, + "com.amazonaws.sagemaker#DeleteModelCardRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model card to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinitionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon SageMaker AI model explainability job definition.
" + } + }, + "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model explainability job definition to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelInput": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelPackageInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a model package.
\nA model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can\n subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
" + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified model group.
" + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageGroupInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model group to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicyInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Deletes a model group resource policy.
" + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicyInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model group for which to delete the policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#VersionedArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to delete.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteModelQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteModelQualityJobDefinitionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the secified model quality monitoring job definition.
" + } + }, + "com.amazonaws.sagemaker#DeleteModelQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model quality monitoring job definition to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteMonitoringScheduleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a monitoring schedule. Also stops the schedule had not already been stopped.\n This does not delete the job execution history of the monitoring schedule.
" + } + }, + "com.amazonaws.sagemaker#DeleteMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the monitoring schedule to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": " Deletes an SageMaker AI notebook instance. Before you can delete a notebook\n instance, you must call the StopNotebookInstance API.
When you delete a notebook instance, you lose all of your data. SageMaker AI removes the ML compute instance, and deletes the ML storage volume and the\n network interface associated with the notebook instance.
\nThe name of the SageMaker AI notebook instance to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfigInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Deletes a notebook instance lifecycle configuration.
" + } + }, + "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfigInput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the lifecycle configuration to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteOptimizationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an optimization job.
" + } + }, + "com.amazonaws.sagemaker#DeleteOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeletePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeletePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeletePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#DeletePartnerAppRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to delete.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "A unique token that guarantees that the call to this API is idempotent.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeletePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App that was deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeletePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeletePipelineRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeletePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a pipeline if there are no running instances of the pipeline. To delete a\n pipeline, you must stop all running instances of the pipeline using the\n StopPipelineExecution API. When you delete a pipeline, all instances of the\n pipeline are deleted.
The name of the pipeline to delete.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeletePipelineResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline to delete.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteProjectInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "Delete the specified project.
" + } + }, + "com.amazonaws.sagemaker#DeleteProjectInput": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the project to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteSpace": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteSpaceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Used to delete a space.
" + } + }, + "com.amazonaws.sagemaker#DeleteSpaceRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the associated domain.
", + "smithy.api#required": {} + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the space.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteStudioLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the\n Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You\n must also remove the Lifecycle Configuration from UserSettings in all Domains and\n UserProfiles.
" + } + }, + "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest": { + "type": "structure", + "members": { + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteTagsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteTagsOutput" + }, + "traits": { + "smithy.api#documentation": "Deletes the specified tags from an SageMaker resource.
\nTo list a resource's tags, use the ListTags API.
When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.
\nWhen you call this API to delete tags from a SageMaker Domain or User Profile, the\n deleted tags are not removed from Apps that the SageMaker Domain or User Profile\n launched before you called this API.
\nThe Amazon Resource Name (ARN) of the resource whose tags you want to\n delete.
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.sagemaker#TagKeyList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array or one or more tag keys to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteTagsOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteTrial": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteTrialRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteTrialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified trial. All trial components that make up the trial must be deleted\n first. Use the DescribeTrialComponent API to get the list of trial\n components.
" + } + }, + "com.amazonaws.sagemaker#DeleteTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified trial component. A trial component must be disassociated from all\n trials before the trial component can be deleted. To disassociate a trial component from a\n trial, call the DisassociateTrialComponent API.
" + } + }, + "com.amazonaws.sagemaker#DeleteTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the component to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the component is being deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteTrialRequest": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the trial to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteTrialResponse": { + "type": "structure", + "members": { + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial that is being deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteUserProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a user profile. When a user profile is deleted, the user loses access to their EFS\n volume, including data, notebooks, and other artifacts.
" + } + }, + "com.amazonaws.sagemaker#DeleteUserProfileRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The domain ID.
", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The user profile name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteWorkforce": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteWorkforceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteWorkforceResponse" + }, + "traits": { + "smithy.api#documentation": "Use this operation to delete a workforce.
\nIf you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use CreateWorkforce\n to create a new workforce.
\nIf a private workforce contains one or more work teams, you must use \n the DeleteWorkteam\n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will receive a ResourceInUse error.
The name of the workforce.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteWorkforceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DeleteWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteWorkteamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing work team. This operation can't be undone.
" + } + }, + "com.amazonaws.sagemaker#DeleteWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the work team to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteWorkteamResponse": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.sagemaker#Success", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns true if the work team was successfully deleted; otherwise,\n returns false.
The image path you specified when you created the model.
" + } + }, + "ResolvedImage": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#documentation": "The specific digest path of the image hosted in this\n ProductionVariant.
The date and time when the image path for the model resolved to the\n ResolvedImage\n
Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.
\nIf you used the registry/repository[:tag] form to specify the image path\n of the primary container when you created the model hosted in this\n ProductionVariant, the path resolves to a path of the form\n registry/repository[@digest]. A digest is a hash value that identifies\n a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.
Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.
" + } + }, + "RollingUpdatePolicy": { + "target": "com.amazonaws.sagemaker#RollingUpdatePolicy", + "traits": { + "smithy.api#documentation": "Specifies a rolling deployment strategy for updating a SageMaker endpoint.
" + } + }, + "AutoRollbackConfiguration": { + "target": "com.amazonaws.sagemaker#AutoRollbackConfig", + "traits": { + "smithy.api#documentation": "Automatic rollback configuration for handling endpoint deployment failures and\n recovery.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.
" + } + }, + "com.amazonaws.sagemaker#DeploymentRecommendation": { + "type": "structure", + "members": { + "RecommendationStatus": { + "target": "com.amazonaws.sagemaker#RecommendationStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker\n is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS,\n retry your API call after a few seconds to get a COMPLETED deployment recommendation.
A list of RealTimeInferenceRecommendation items.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of recommended deployment configurations for the model. To get more advanced recommendations, see\n CreateInferenceRecommendationsJob\n to create an inference recommendation job.
" + } + }, + "com.amazonaws.sagemaker#DeploymentStage": { + "type": "structure", + "members": { + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stage.
", + "smithy.api#required": {} + } + }, + "DeviceSelectionConfig": { + "target": "com.amazonaws.sagemaker#DeviceSelectionConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configuration of the devices in the stage.
", + "smithy.api#required": {} + } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentConfig", + "traits": { + "smithy.api#documentation": "Configuration of the deployment details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a stage in an edge deployment plan.
" + } + }, + "com.amazonaws.sagemaker#DeploymentStageMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#DeploymentStageStatusSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeploymentStageStatusSummary" + } + }, + "com.amazonaws.sagemaker#DeploymentStageStatusSummary": { + "type": "structure", + "members": { + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stage.
", + "smithy.api#required": {} + } + }, + "DeviceSelectionConfig": { + "target": "com.amazonaws.sagemaker#DeviceSelectionConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configuration of the devices in the stage.
", + "smithy.api#required": {} + } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configuration of the deployment details.
", + "smithy.api#required": {} + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "General status of the current state.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information summarizing the deployment stage results.
" + } + }, + "com.amazonaws.sagemaker#DeploymentStages": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeploymentStage" + } + }, + "com.amazonaws.sagemaker#DeregisterDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeregisterDevicesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
" + } + }, + "com.amazonaws.sagemaker#DeregisterDevicesRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet the devices belong to.
", + "smithy.api#required": {} + } + }, + "DeviceNames": { + "target": "com.amazonaws.sagemaker#DeviceNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique IDs of the devices.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DerivedInformation": { + "type": "structure", + "members": { + "DerivedDataInputConfig": { + "target": "com.amazonaws.sagemaker#DataInputConfig", + "traits": { + "smithy.api#documentation": "The data input configuration that SageMaker Neo automatically derived for the model.\n When SageMaker Neo derives this information, you don't need to specify the data input\n configuration when you create a compilation job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information that SageMaker Neo automatically derived about the model.
" + } + }, + "com.amazonaws.sagemaker#DescribeAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeActionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes an action.
" + } + }, + "com.amazonaws.sagemaker#DescribeActionRequest": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the action to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeActionResponse": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the action.
" + } + }, + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ActionSource", + "traits": { + "smithy.api#documentation": "The source of the action.
" + } + }, + "ActionType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the action.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "The description of the action.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action.
" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "A list of the action's properties.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the action was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the action was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeAlgorithm": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAlgorithmInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAlgorithmOutput" + }, + "traits": { + "smithy.api#documentation": "Returns a description of the specified algorithm that is in your account.
" + } + }, + "com.amazonaws.sagemaker#DescribeAlgorithmInput": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the algorithm to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAlgorithmOutput": { + "type": "structure", + "members": { + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the algorithm being described.
", + "smithy.api#required": {} + } + }, + "AlgorithmArn": { + "target": "com.amazonaws.sagemaker#AlgorithmArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the algorithm.
", + "smithy.api#required": {} + } + }, + "AlgorithmDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A brief summary about the algorithm.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp specifying when the algorithm was created.
", + "smithy.api#required": {} + } + }, + "TrainingSpecification": { + "target": "com.amazonaws.sagemaker#TrainingSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Details about training jobs run by this algorithm.
", + "smithy.api#required": {} + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "Details about inference jobs that the algorithm runs.
" + } + }, + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmValidationSpecification", + "traits": { + "smithy.api#documentation": "Details about configurations for one or more training jobs that SageMaker runs to test the\n algorithm.
" + } + }, + "AlgorithmStatus": { + "target": "com.amazonaws.sagemaker#AlgorithmStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the algorithm.
", + "smithy.api#required": {} + } + }, + "AlgorithmStatusDetails": { + "target": "com.amazonaws.sagemaker#AlgorithmStatusDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Details about the current status of the algorithm.
", + "smithy.api#required": {} + } + }, + "ProductId": { + "target": "com.amazonaws.sagemaker#ProductId", + "traits": { + "smithy.api#documentation": "The product identifier of the algorithm.
" + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "Whether the algorithm is certified to be listed in Amazon Web Services\n Marketplace.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes the app.
" + } + }, + "com.amazonaws.sagemaker#DescribeAppImageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAppImageConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAppImageConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes an AppImageConfig.
" + } + }, + "com.amazonaws.sagemaker#DescribeAppImageConfigRequest": { + "type": "structure", + "members": { + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the AppImageConfig to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAppImageConfigResponse": { + "type": "structure", + "members": { + "AppImageConfigArn": { + "target": "com.amazonaws.sagemaker#AppImageConfigArn", + "traits": { + "smithy.api#documentation": "The ARN of the AppImageConfig.
" + } + }, + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#documentation": "The name of the AppImageConfig.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the AppImageConfig was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the AppImageConfig was last modified.
" + } + }, + "KernelGatewayImageConfig": { + "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", + "traits": { + "smithy.api#documentation": "The configuration of a KernelGateway app.
" + } + }, + "JupyterLabAppImageConfig": { + "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", + "traits": { + "smithy.api#documentation": "The configuration of the JupyterLab app.
" + } + }, + "CodeEditorAppImageConfig": { + "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", + "traits": { + "smithy.api#documentation": "The configuration of the Code Editor app.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeAppRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The domain ID.
", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be\n set.
The name of the space.
" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of app.
", + "smithy.api#required": {} + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAppResponse": { + "type": "structure", + "members": { + "AppArn": { + "target": "com.amazonaws.sagemaker#AppArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the app.
" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "The type of app.
" + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#documentation": "The name of the app.
" + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "The domain ID.
" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "The user profile name.
" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "The name of the space. If this value is not set, then UserProfileName must be\n set.
The status.
" + } + }, + "LastHealthCheckTimestamp": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last health check.
" + } + }, + "LastUserActivityTimestamp": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last user's activity. LastUserActivityTimestamp is also\n updated when SageMaker AI performs health checks without user activity. As a result, this\n value is set to the same value as LastHealthCheckTimestamp.
The creation time of the application.
\nAfter an application has been shut down for 24 hours, SageMaker AI deletes all\n metadata for the application. To be considered an update and retain application metadata,\n applications must be restarted within 24 hours after the previous application has been shut\n down. After this time window, creation of an application is considered a new application\n rather than an update of the previous application.
\nThe failure reason.
" + } + }, + "ResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", + "traits": { + "smithy.api#documentation": "The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image\n created on the instance.
" + } + }, + "BuiltInLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeArtifact": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeArtifactRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeArtifactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes an artifact.
" + } + }, + "com.amazonaws.sagemaker#DescribeArtifactRequest": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeArtifactResponse": { + "type": "structure", + "members": { + "ArtifactName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the artifact.
" + } + }, + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ArtifactSource", + "traits": { + "smithy.api#documentation": "The source of the artifact.
" + } + }, + "ArtifactType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the artifact.
" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "A list of the artifact's properties.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the artifact was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the artifact was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an AutoML job created by calling CreateAutoMLJob.
\nAutoML jobs created by calling CreateAutoMLJobV2 cannot be described by\n DescribeAutoMLJob.
Requests information about an AutoML job using its unique name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJobResponse": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the name of the AutoML job.
", + "smithy.api#required": {} + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the ARN of the AutoML job.
", + "smithy.api#required": {} + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the input data configuration for the AutoML job.
", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the job's output data config.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the IAM role that has read permission to the input data\n location and write permission to the output data location in Amazon S3.
", + "smithy.api#required": {} + } + }, + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective", + "traits": { + "smithy.api#documentation": "Returns the job's objective.
" + } + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "Returns the job's problem type.
" + } + }, + "AutoMLJobConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobConfig", + "traits": { + "smithy.api#documentation": "Returns the configuration for the AutoML job.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the creation time of the AutoML job.
", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Returns the end time of the AutoML job.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the job's last modified time.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "Returns the failure reason for an AutoML job, when applicable.
" + } + }, + "PartialFailureReasons": { + "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", + "traits": { + "smithy.api#documentation": "Returns a list of reasons for partial failures within an AutoML job.
" + } + }, + "BestCandidate": { + "target": "com.amazonaws.sagemaker#AutoMLCandidate", + "traits": { + "smithy.api#documentation": "The best model candidate selected by SageMaker AI Autopilot using both the best\n objective metric and lowest InferenceLatency for\n an experiment.
" + } + }, + "AutoMLJobStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the status of the AutoML job.
", + "smithy.api#required": {} + } + }, + "AutoMLJobSecondaryStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the secondary status of the AutoML job.
", + "smithy.api#required": {} + } + }, + "GenerateCandidateDefinitionsOnly": { + "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", + "traits": { + "smithy.api#documentation": "Indicates whether the output for an AutoML job generates candidate definitions\n only.
" + } + }, + "AutoMLJobArtifacts": { + "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts", + "traits": { + "smithy.api#documentation": "Returns information on the job's artifacts found in\n AutoMLJobArtifacts.
Contains ProblemType, AutoMLJobObjective, and\n CompletionCriteria. If you do not provide these values, they are\n inferred.
Indicates whether the model was deployed automatically to an endpoint and the name of\n that endpoint if deployed automatically.
" + } + }, + "ModelDeployResult": { + "target": "com.amazonaws.sagemaker#ModelDeployResult", + "traits": { + "smithy.api#documentation": "Provides information about endpoint for the model deployment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJobV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJobV2Request" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeAutoMLJobV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an AutoML job created by calling CreateAutoMLJobV2\n or CreateAutoMLJob.
" + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJobV2Request": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Requests information about an AutoML job V2 using its unique name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeAutoMLJobV2Response": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the name of the AutoML job V2.
", + "smithy.api#required": {} + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the Amazon Resource Name (ARN) of the AutoML job V2.
", + "smithy.api#required": {} + } + }, + "AutoMLJobInputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobInputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns an array of channel objects describing the input data and their location.
", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the job's output data config.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the IAM role that has read permission to the input data\n location and write permission to the output data location in Amazon S3.
", + "smithy.api#required": {} + } + }, + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective", + "traits": { + "smithy.api#documentation": "Returns the job's objective.
" + } + }, + "AutoMLProblemTypeConfig": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfig", + "traits": { + "smithy.api#documentation": "Returns the configuration settings of the problem type set for the AutoML job V2.
" + } + }, + "AutoMLProblemTypeConfigName": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfigName", + "traits": { + "smithy.api#documentation": "Returns the name of the problem type configuration set for the AutoML job V2.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the creation time of the AutoML job V2.
", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Returns the end time of the AutoML job V2.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the job's last modified time.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "Returns the reason for the failure of the AutoML job V2, when applicable.
" + } + }, + "PartialFailureReasons": { + "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", + "traits": { + "smithy.api#documentation": "Returns a list of reasons for partial failures within an AutoML job V2.
" + } + }, + "BestCandidate": { + "target": "com.amazonaws.sagemaker#AutoMLCandidate", + "traits": { + "smithy.api#documentation": "Information about the candidate produced by an AutoML training job V2, including its\n status, steps, and other properties.
" + } + }, + "AutoMLJobStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the status of the AutoML job V2.
", + "smithy.api#required": {} + } + }, + "AutoMLJobSecondaryStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns the secondary status of the AutoML job V2.
", + "smithy.api#required": {} + } + }, + "AutoMLJobArtifacts": { + "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts" + }, + "ResolvedAttributes": { + "target": "com.amazonaws.sagemaker#AutoMLResolvedAttributes", + "traits": { + "smithy.api#documentation": "Returns the resolved attributes used by the AutoML job V2.
" + } + }, + "ModelDeployConfig": { + "target": "com.amazonaws.sagemaker#ModelDeployConfig", + "traits": { + "smithy.api#documentation": "Indicates whether the model was deployed automatically to an endpoint and the name of\n that endpoint if deployed automatically.
" + } + }, + "ModelDeployResult": { + "target": "com.amazonaws.sagemaker#ModelDeployResult", + "traits": { + "smithy.api#documentation": "Provides information about endpoint for the model deployment.
" + } + }, + "DataSplitConfig": { + "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", + "traits": { + "smithy.api#documentation": "Returns the configuration settings of how the data are split into train and validation\n datasets.
" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", + "traits": { + "smithy.api#documentation": "Returns the security configuration for traffic encryption or Amazon VPC\n settings.
" + } + }, + "AutoMLComputeConfig": { + "target": "com.amazonaws.sagemaker#AutoMLComputeConfig", + "traits": { + "smithy.api#documentation": "The compute configuration used for the AutoML job V2.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information of a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#DescribeClusterNode": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterNodeRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterNodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information of a node (also called a instance\n interchangeably) of a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#DescribeClusterNodeRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.
", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the SageMaker HyperPod cluster node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterNodeResponse": { + "type": "structure", + "members": { + "NodeDetails": { + "target": "com.amazonaws.sagemaker#ClusterNodeDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The details of the SageMaker HyperPod cluster node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#documentation": "The name of the SageMaker HyperPod cluster.
" + } + }, + "ClusterStatus": { + "target": "com.amazonaws.sagemaker#ClusterStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the SageMaker Cluster is created.
" + } + }, + "FailureMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The failure message of the SageMaker HyperPod cluster.
" + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance groups of the SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "Orchestrator": { + "target": "com.amazonaws.sagemaker#ClusterOrchestrator", + "traits": { + "smithy.api#documentation": "The type of orchestrator used for the SageMaker HyperPod cluster.
" + } + }, + "NodeRecovery": { + "target": "com.amazonaws.sagemaker#ClusterNodeRecovery", + "traits": { + "smithy.api#documentation": "The node recovery mode configured for the SageMaker HyperPod cluster.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Description of the cluster policy. This policy is used for task prioritization and\n fair-share allocation. This helps prioritize critical workloads and distributes\n idle compute across entities.
" + } + }, + "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "Version of the cluster policy.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Version of the cluster policy.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Status of the cluster policy.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "Failure reason of the cluster policy.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "ARN of the cluster where the cluster policy is applied.
" + } + }, + "SchedulerConfig": { + "target": "com.amazonaws.sagemaker#SchedulerConfig", + "traits": { + "smithy.api#documentation": "Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the cluster policy.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Creation time of the cluster policy.
", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Last modified time of the cluster policy.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeCodeRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeCodeRepositoryInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeCodeRepositoryOutput" + }, + "traits": { + "smithy.api#documentation": "Gets details about the specified Git repository.
" + } + }, + "com.amazonaws.sagemaker#DescribeCodeRepositoryInput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Git repository to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeCodeRepositoryOutput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Git repository.
", + "smithy.api#required": {} + } + }, + "CodeRepositoryArn": { + "target": "com.amazonaws.sagemaker#CodeRepositoryArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Git repository.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the repository was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the repository was last changed.
", + "smithy.api#required": {} + } + }, + "GitConfig": { + "target": "com.amazonaws.sagemaker#GitConfig", + "traits": { + "smithy.api#documentation": "Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the\n repository.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeCompilationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeCompilationJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeCompilationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a model compilation job.
\nTo create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation\n jobs, use ListCompilationJobs.
" + } + }, + "com.amazonaws.sagemaker#DescribeCompilationJobRequest": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model compilation job that you want information about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeCompilationJobResponse": { + "type": "structure", + "members": { + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model compilation job.
", + "smithy.api#required": {} + } + }, + "CompilationJobArn": { + "target": "com.amazonaws.sagemaker#CompilationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model compilation job.
", + "smithy.api#required": {} + } + }, + "CompilationJobStatus": { + "target": "com.amazonaws.sagemaker#CompilationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the model compilation job.
", + "smithy.api#required": {} + } + }, + "CompilationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the model compilation job started the CompilationJob\n instances.
You are billed for the time between this timestamp and the timestamp in the\n CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later\n than this time. That's because it takes time to download the compilation job, which\n depends on the size of the compilation job container.
The time when the model compilation job on a compilation job instance ended. For a\n successful or stopped job, this is when the job's model artifacts have finished\n uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed.
" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies a limit to how long a model compilation job can run. When the job reaches\n the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training\n costs.
", + "smithy.api#required": {} + } + }, + "InferenceImage": { + "target": "com.amazonaws.sagemaker#InferenceImage", + "traits": { + "smithy.api#documentation": "The inference image to use when compiling a model. Specify an image only if the target\n device is a cloud instance.
" + } + }, + "ModelPackageVersionArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the versioned model package that was \n provided to SageMaker Neo when you initiated a compilation job.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time that the model compilation job was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time that the status\n of\n the model compilation job was last modified.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "If a model compilation job failed, the reason it failed.
", + "smithy.api#required": {} + } + }, + "ModelArtifacts": { + "target": "com.amazonaws.sagemaker#ModelArtifacts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the location in Amazon S3 that has been configured for storing the model\n artifacts used in the compilation job.
", + "smithy.api#required": {} + } + }, + "ModelDigests": { + "target": "com.amazonaws.sagemaker#ModelDigests", + "traits": { + "smithy.api#documentation": "Provides a BLAKE2 hash value that identifies the compiled model artifacts in\n Amazon S3.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model\n compilation job.
", + "smithy.api#required": {} + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#InputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the location in Amazon S3 of the input model artifacts, the name and\n shape of the expected data inputs, and the framework in which the model was\n trained.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the output location for the compiled model and the target device\n that the model runs on.
", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#NeoVpcConfig", + "traits": { + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your compilation job\n to connect to. Control access to your models by configuring the VPC. For more\n information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
" + } + }, + "DerivedInformation": { + "target": "com.amazonaws.sagemaker#DerivedInformation", + "traits": { + "smithy.api#documentation": "Information that SageMaker Neo automatically derived about the model.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeComputeQuotaRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeComputeQuotaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Description of the compute allocation definition.
" + } + }, + "com.amazonaws.sagemaker#DescribeComputeQuotaRequest": { + "type": "structure", + "members": { + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "Version of the compute allocation definition.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeComputeQuotaResponse": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the compute allocation definition.
" + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Version of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Status of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "Failure reason of the compute allocation definition.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "ARN of the cluster.
" + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target entity to allocate compute resources to.
", + "smithy.api#required": {} + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Creation time of the compute allocation configuration.
", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Last modified time of the compute allocation configuration.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeContext": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeContextRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeContextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes a context.
" + } + }, + "com.amazonaws.sagemaker#DescribeContextRequest": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the context to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeContextResponse": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#documentation": "The name of the context.
" + } + }, + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ContextSource", + "traits": { + "smithy.api#documentation": "The source of the context.
" + } + }, + "ContextType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the context.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "The description of the context.
" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "A list of the context's properties.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the context was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the context was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeDataQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details of a data quality monitoring job definition.
" + } + }, + "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the data quality monitoring job definition to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeDataQualityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data quality monitoring job definition.
", + "smithy.api#required": {} + } + }, + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the data quality monitoring job definition.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time that the data quality monitoring job definition was created.
", + "smithy.api#required": {} + } + }, + "DataQualityBaselineConfig": { + "target": "com.amazonaws.sagemaker#DataQualityBaselineConfig", + "traits": { + "smithy.api#documentation": "The constraints and baselines for the data quality monitoring job definition.
" + } + }, + "DataQualityAppSpecification": { + "target": "com.amazonaws.sagemaker#DataQualityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the container that runs the data quality monitoring job.
", + "smithy.api#required": {} + } + }, + "DataQualityJobInput": { + "target": "com.amazonaws.sagemaker#DataQualityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The list of inputs for the data quality monitoring job. Currently endpoints are\n supported.
", + "smithy.api#required": {} + } + }, + "DataQualityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "The networking configuration for the data quality monitoring job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeDeviceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes the device.
" + } + }, + "com.amazonaws.sagemaker#DescribeDeviceFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeDeviceFleetRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeDeviceFleetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "A description of the fleet the device belongs to.
" + } + }, + "com.amazonaws.sagemaker#DescribeDeviceFleetRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeDeviceFleetResponse": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "DeviceFleetArn": { + "target": "com.amazonaws.sagemaker#DeviceFleetArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The The Amazon Resource Name (ARN) of the fleet.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The output configuration for storing sampled data.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceFleetDescription", + "traits": { + "smithy.api#documentation": "A description of the fleet.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Timestamp of when the device fleet was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Timestamp of when the device fleet was last updated.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
" + } + }, + "IotRoleAlias": { + "target": "com.amazonaws.sagemaker#IotRoleAlias", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeDeviceRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "Next token of device description.
" + } + }, + "DeviceName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique ID of the device.
", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet the devices belong to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeDeviceResponse": { + "type": "structure", + "members": { + "DeviceArn": { + "target": "com.amazonaws.sagemaker#DeviceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the device.
" + } + }, + "DeviceName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the device.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceDescription", + "traits": { + "smithy.api#documentation": "A description of the device.
" + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet the device belongs to.
", + "smithy.api#required": {} + } + }, + "IotThingName": { + "target": "com.amazonaws.sagemaker#ThingName", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.
" + } + }, + "RegistrationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The timestamp of the last registration or de-reregistration.
", + "smithy.api#required": {} + } + }, + "LatestHeartbeat": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last heartbeat received from the device.
" + } + }, + "Models": { + "target": "com.amazonaws.sagemaker#EdgeModels", + "traits": { + "smithy.api#documentation": "Models on the device.
" + } + }, + "MaxModels": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of models.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" + } + }, + "AgentVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "Edge Manager agent version.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeDomainRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "The description of the domain.
" + } + }, + "com.amazonaws.sagemaker#DescribeDomainRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The domain ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeDomainResponse": { + "type": "structure", + "members": { + "DomainArn": { + "target": "com.amazonaws.sagemaker#DomainArn", + "traits": { + "smithy.api#documentation": "The domain's Amazon Resource Name (ARN).
" + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "The domain ID.
" + } + }, + "DomainName": { + "target": "com.amazonaws.sagemaker#DomainName", + "traits": { + "smithy.api#documentation": "The domain name.
" + } + }, + "HomeEfsFileSystemId": { + "target": "com.amazonaws.sagemaker#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Elastic File System managed by this Domain.
" + } + }, + "SingleSignOnManagedApplicationInstanceId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The IAM Identity Center managed application instance ID.
" + } + }, + "SingleSignOnApplicationArn": { + "target": "com.amazonaws.sagemaker#SingleSignOnApplicationArn", + "traits": { + "smithy.api#documentation": "The ARN of the application managed by SageMaker AI in IAM Identity Center. This value\n is only returned for domains created after October 1, 2023.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#DomainStatus", + "traits": { + "smithy.api#documentation": "The status.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "The creation time.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "The last modified time.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The failure reason.
" + } + }, + "SecurityGroupIdForDomainBoundary": { + "target": "com.amazonaws.sagemaker#SecurityGroupId", + "traits": { + "smithy.api#documentation": "The ID of the security group that authorizes traffic between the\n RSessionGateway apps and the RStudioServerPro app.
The domain's authentication mode.
" + } + }, + "DefaultUserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "Settings which are applied to UserProfiles in this domain if settings are not explicitly\n specified in a given UserProfile.
" + } + }, + "DomainSettings": { + "target": "com.amazonaws.sagemaker#DomainSettings", + "traits": { + "smithy.api#documentation": "A collection of Domain settings.
Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Use KmsKeyId.
The VPC subnets that the domain uses for communication.
" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The domain's URL.
" + } + }, + "VpcId": { + "target": "com.amazonaws.sagemaker#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to\n the domain.
" + } + }, + "AppSecurityGroupManagement": { + "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", + "traits": { + "smithy.api#documentation": "The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided.
Indicates whether custom tag propagation is supported for the domain.
" + } + }, + "DefaultSpaceSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceSettings", + "traits": { + "smithy.api#documentation": "The default settings for shared spaces that users create in the domain.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes an edge deployment plan with deployment status per stage.
" + } + }, + "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the deployment plan to describe.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the edge deployment plan has enough stages to require tokening, then this is the\n response from the last list of stages returned.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#DeploymentStageMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to select (50 by default).
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeEdgeDeploymentPlanResponse": { + "type": "structure", + "members": { + "EdgeDeploymentPlanArn": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of edge deployment plan.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "ModelConfigs": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentModelConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List of models associated with the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The device fleet used for this edge deployment plan.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentSuccess": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The number of edge devices with the successful deployment.
" + } + }, + "EdgeDeploymentPending": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The number of edge devices yet to pick up deployment, or in progress.
" + } + }, + "EdgeDeploymentFailed": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The number of edge devices that failed the deployment.
" + } + }, + "Stages": { + "target": "com.amazonaws.sagemaker#DeploymentStageStatusSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List of stages in the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "Token to use when calling the next set of stages in the edge deployment plan.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the edge deployment plan was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the edge deployment plan was last updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeEdgePackagingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeEdgePackagingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeEdgePackagingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "A description of edge packaging jobs.
" + } + }, + "com.amazonaws.sagemaker#DescribeEdgePackagingJobRequest": { + "type": "structure", + "members": { + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge packaging job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeEdgePackagingJobResponse": { + "type": "structure", + "members": { + "EdgePackagingJobArn": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the edge packaging job.
", + "smithy.api#required": {} + } + }, + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge packaging job.
", + "smithy.api#required": {} + } + }, + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.
" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the model.
" + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "The version of the model.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#documentation": "The output configuration for the edge packaging job.
" + } + }, + "ResourceKey": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.
" + } + }, + "EdgePackagingJobStatus": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the packaging job.
", + "smithy.api#required": {} + } + }, + "EdgePackagingJobStatusMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "Returns a message describing the job status and error messages.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the packaging job was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the job was last updated.
" + } + }, + "ModelArtifact": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage (S3) URI where model artifacts ares stored.
" + } + }, + "ModelSignature": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The signature document of files in the model artifact.
" + } + }, + "PresetDeploymentOutput": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentOutput", + "traits": { + "smithy.api#documentation": "The output of a SageMaker Edge Manager deployable resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeEndpointInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeEndpointOutput" + }, + "traits": { + "smithy.api#documentation": "Returns the description of an endpoint.
", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "EndpointDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ValidationException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "EndpointStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "EndpointInService": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "EndpointStatus", + "expected": "InService", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "EndpointStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeEndpointConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeEndpointConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeEndpointConfigOutput" + }, + "traits": { + "smithy.api#documentation": "Returns the description of an endpoint configuration created using the\n CreateEndpointConfig API.
The name of the endpoint configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeEndpointConfigOutput": { + "type": "structure", + "members": { + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the SageMaker endpoint configuration.
", + "smithy.api#required": {} + } + }, + "EndpointConfigArn": { + "target": "com.amazonaws.sagemaker#EndpointConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint configuration.
", + "smithy.api#required": {} + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of ProductionVariant objects, one for each model that you\n want to host at this endpoint.
Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML\n storage volume attached to the instance.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the endpoint configuration was created.
", + "smithy.api#required": {} + } + }, + "AsyncInferenceConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", + "traits": { + "smithy.api#documentation": "Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.
The configuration parameters for an explainer.
" + } + }, + "ShadowProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantList", + "traits": { + "smithy.api#documentation": "An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants.
The Amazon Resource Name (ARN) of the IAM role that you assigned to the\n endpoint configuration.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether all model containers deployed to the endpoint are isolated. If they\n are, no inbound or outbound network calls can be made to or from the model\n containers.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeEndpointInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeEndpointOutput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the endpoint.
", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", + "smithy.api#required": {} + } + }, + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#documentation": "The name of the endpoint configuration associated with this endpoint.
" + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "An array of ProductionVariantSummary objects, one for each model hosted behind this\n endpoint.
" + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#DataCaptureConfigSummary" + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
\n UpdateRollbackFailed: Both the rolling deployment and\n auto-rollback failed. Your endpoint is in service with a mix of the old and new\n endpoint configurations. For information about how to remedy this issue and\n restore the endpoint's status to InService, see Rolling\n Deployments.
If the status of the endpoint is Failed, the reason why it failed.\n
A timestamp that shows when the endpoint was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the endpoint was last modified.
", + "smithy.api#required": {} + } + }, + "LastDeploymentConfig": { + "target": "com.amazonaws.sagemaker#DeploymentConfig", + "traits": { + "smithy.api#documentation": "The most recent deployment configuration for the endpoint.
" + } + }, + "AsyncInferenceConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", + "traits": { + "smithy.api#documentation": "Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.
Returns the summary of an in-progress deployment. This field is only returned when the\n endpoint is creating or updating with a new endpoint configuration.
" + } + }, + "ExplainerConfig": { + "target": "com.amazonaws.sagemaker#ExplainerConfig", + "traits": { + "smithy.api#documentation": "The configuration parameters for an explainer.
" + } + }, + "ShadowProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "An array of ProductionVariantSummary objects, one for each model that you want to host\n at this endpoint in shadow mode with production traffic replicated from the model\n specified on ProductionVariants.
Provides a list of an experiment's properties.
" + } + }, + "com.amazonaws.sagemaker#DescribeExperimentRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the experiment to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeExperimentResponse": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment.
" + } + }, + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.
The Amazon Resource Name (ARN) of the source and, optionally, the type.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "The description of the experiment.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the experiment was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who created the experiment.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the experiment was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who last modified the experiment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeFeatureGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeFeatureGroupRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeFeatureGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Use this operation to describe a FeatureGroup. The response includes\n information on the creation time, FeatureGroup name, the unique identifier for\n each FeatureGroup, and more.
The name or Amazon Resource Name (ARN) of the FeatureGroup you want\n described.
A token to resume pagination of the list of Features\n (FeatureDefinitions). 2,500 Features are returned by\n default.
The Amazon Resource Name (ARN) of the FeatureGroup.
he name of the FeatureGroup.
The name of the Feature used for RecordIdentifier, whose value\n uniquely identifies a record stored in the feature store.
The name of the feature that stores the EventTime of a Record in a\n FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds\n to the creation or update of a Record in a FeatureGroup. All\n Records in the FeatureGroup have a corresponding\n EventTime.
A list of the Features in the FeatureGroup. Each feature is\n defined by a FeatureName and FeatureType.
A timestamp indicating when SageMaker created the FeatureGroup.
A timestamp indicating when the feature group was last updated.
" + } + }, + "OnlineStoreConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreConfig", + "traits": { + "smithy.api#documentation": "The configuration for the OnlineStore.
The configuration of the offline store. It includes the following configurations:
\nAmazon S3 location of the offline store.
\nConfiguration of the Glue data catalog.
\nTable format of the offline store.
\nOption to disable the automatic creation of a Glue table for the offline\n store.
\nEncryption configuration.
\nThe Amazon Resource Name (ARN) of the IAM execution role used to persist data into the\n OfflineStore if an OfflineStoreConfig is provided.
" + } + }, + "FeatureGroupStatus": { + "target": "com.amazonaws.sagemaker#FeatureGroupStatus", + "traits": { + "smithy.api#documentation": "The status of the feature group.
" + } + }, + "OfflineStoreStatus": { + "target": "com.amazonaws.sagemaker#OfflineStoreStatus", + "traits": { + "smithy.api#documentation": "The status of the OfflineStore. Notifies you if replicating data into the\n OfflineStore has failed. Returns either: Active or\n Blocked\n
A value indicating whether the update made to the feature group was successful.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The reason that the FeatureGroup failed to be replicated in the\n OfflineStore. This is failure can occur because:
The FeatureGroup could not be created in the\n OfflineStore.
The FeatureGroup could not be deleted from the\n OfflineStore.
A free form description of the feature group.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A token to resume pagination of the list of Features\n (FeatureDefinitions).
The size of the OnlineStore in bytes.
Shows the metadata for a feature within a feature group.
" + } + }, + "com.amazonaws.sagemaker#DescribeFeatureMetadataRequest": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the feature group containing the\n feature.
", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the feature.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeFeatureMetadataResponse": { + "type": "structure", + "members": { + "FeatureGroupArn": { + "target": "com.amazonaws.sagemaker#FeatureGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the feature group that contains the feature.
", + "smithy.api#required": {} + } + }, + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the feature group that you've specified.
", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the feature that you've specified.
", + "smithy.api#required": {} + } + }, + "FeatureType": { + "target": "com.amazonaws.sagemaker#FeatureType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The data type of the feature.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp indicating when the feature was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp indicating when the metadata for the feature group was modified. For\n example, if you add a parameter describing the feature, the timestamp changes to reflect\n the last time you
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#FeatureDescription", + "traits": { + "smithy.api#documentation": "The description you added to describe the feature.
" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#FeatureParameters", + "traits": { + "smithy.api#documentation": "The key-value pairs that you added to describe the feature.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeFlowDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeFlowDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeFlowDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the specified flow definition.
" + } + }, + "com.amazonaws.sagemaker#DescribeFlowDefinitionRequest": { + "type": "structure", + "members": { + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the flow definition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeFlowDefinitionResponse": { + "type": "structure", + "members": { + "FlowDefinitionArn": { + "target": "com.amazonaws.sagemaker#FlowDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow defintion.
", + "smithy.api#required": {} + } + }, + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow definition.
", + "smithy.api#required": {} + } + }, + "FlowDefinitionStatus": { + "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the flow definition. Valid values are listed below.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The timestamp when the flow definition was created.
", + "smithy.api#required": {} + } + }, + "HumanLoopRequestSource": { + "target": "com.amazonaws.sagemaker#HumanLoopRequestSource", + "traits": { + "smithy.api#documentation": "Container for configuring the source of human task requests. Used to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.
" + } + }, + "HumanLoopActivationConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopActivationConfig", + "traits": { + "smithy.api#documentation": "An object containing information about what triggers a human review workflow.
" + } + }, + "HumanLoopConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopConfig", + "traits": { + "smithy.api#documentation": "An object containing information about who works on the task, the workforce task price, and other task details.
" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object containing information about the output file.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The reason your flow definition failed.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeHubRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeHubResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes a hub.
" + } + }, + "com.amazonaws.sagemaker#DescribeHubContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeHubContentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeHubContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describe the content of a hub.
" + } + }, + "com.amazonaws.sagemaker#DescribeHubContentRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub that contains the content to describe.
", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of content in the hub.
", + "smithy.api#required": {} + } + }, + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the content to describe.
", + "smithy.api#required": {} + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#documentation": "The version of the content to describe.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeHubContentResponse": { + "type": "structure", + "members": { + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub content.
", + "smithy.api#required": {} + } + }, + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub content.
", + "smithy.api#required": {} + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the hub content.
", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of hub content.
", + "smithy.api#required": {} + } + }, + "DocumentSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The document schema version for the hub content.
", + "smithy.api#required": {} + } + }, + "HubName": { + "target": "com.amazonaws.sagemaker#HubName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub that contains the content.
", + "smithy.api#required": {} + } + }, + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub that contains the content.
", + "smithy.api#required": {} + } + }, + "HubContentDisplayName": { + "target": "com.amazonaws.sagemaker#HubContentDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the hub content.
" + } + }, + "HubContentDescription": { + "target": "com.amazonaws.sagemaker#HubContentDescription", + "traits": { + "smithy.api#documentation": "A description of the hub content.
" + } + }, + "HubContentMarkdown": { + "target": "com.amazonaws.sagemaker#HubContentMarkdown", + "traits": { + "smithy.api#documentation": "A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
" + } + }, + "HubContentDocument": { + "target": "com.amazonaws.sagemaker#HubContentDocument", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
", + "smithy.api#required": {} + } + }, + "SageMakerPublicHubContentArn": { + "target": "com.amazonaws.sagemaker#SageMakerPublicHubContentArn", + "traits": { + "smithy.api#documentation": "The ARN of the public hub content.
" + } + }, + "ReferenceMinVersion": { + "target": "com.amazonaws.sagemaker#ReferenceMinVersion", + "traits": { + "smithy.api#documentation": "The minimum version of the hub content.
" + } + }, + "SupportStatus": { + "target": "com.amazonaws.sagemaker#HubContentSupportStatus", + "traits": { + "smithy.api#documentation": "The support status of the hub content.
" + } + }, + "HubContentSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubContentSearchKeywordList", + "traits": { + "smithy.api#documentation": "The searchable keywords for the hub content.
" + } + }, + "HubContentDependencies": { + "target": "com.amazonaws.sagemaker#HubContentDependencyList", + "traits": { + "smithy.api#documentation": "The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
" + } + }, + "HubContentStatus": { + "target": "com.amazonaws.sagemaker#HubContentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the hub content.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The failure reason if importing hub content failed.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that hub content was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeHubRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeHubResponse": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub.
", + "smithy.api#required": {} + } + }, + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub.
", + "smithy.api#required": {} + } + }, + "HubDisplayName": { + "target": "com.amazonaws.sagemaker#HubDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the hub.
" + } + }, + "HubDescription": { + "target": "com.amazonaws.sagemaker#HubDescription", + "traits": { + "smithy.api#documentation": "A description of the hub.
" + } + }, + "HubSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubSearchKeywordList", + "traits": { + "smithy.api#documentation": "The searchable keywords for the hub.
" + } + }, + "S3StorageConfig": { + "target": "com.amazonaws.sagemaker#HubS3StorageConfig", + "traits": { + "smithy.api#documentation": "The Amazon S3 storage configuration for the hub.
" + } + }, + "HubStatus": { + "target": "com.amazonaws.sagemaker#HubStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the hub.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The failure reason if importing hub content failed.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the hub was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the hub was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeHumanTaskUi": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeHumanTaskUiRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeHumanTaskUiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the requested human task user interface (worker task template).
" + } + }, + "com.amazonaws.sagemaker#DescribeHumanTaskUiRequest": { + "type": "structure", + "members": { + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the human task user interface \n (worker task template) you want information about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeHumanTaskUiResponse": { + "type": "structure", + "members": { + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human task user interface (worker task template).
", + "smithy.api#required": {} + } + }, + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the human task user interface (worker task template).
", + "smithy.api#required": {} + } + }, + "HumanTaskUiStatus": { + "target": "com.amazonaws.sagemaker#HumanTaskUiStatus", + "traits": { + "smithy.api#documentation": "The status of the human task user interface (worker task template). Valid values are listed below.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The timestamp when the human task user interface was created.
", + "smithy.api#required": {} + } + }, + "UiTemplate": { + "target": "com.amazonaws.sagemaker#UiTemplateInfo", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeHyperParameterTuningJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns a description of a hyperparameter tuning job, depending on the fields\n selected. These fields can include the name, Amazon Resource Name (ARN), job status of\n your tuning job and more.
" + } + }, + "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobRequest": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tuning job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobResponse": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hyperparameter tuning job.
", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tuning job.
", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The HyperParameterTuningJobConfig object that specifies the configuration of\n the tuning job.
", + "smithy.api#required": {} + } + }, + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", + "traits": { + "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that specifies the definition of\n the training jobs that this tuning job launches.
" + } + }, + "TrainingJobDefinitions": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", + "traits": { + "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.
" + } + }, + "HyperParameterTuningJobStatus": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the tuning job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the tuning job started.
", + "smithy.api#required": {} + } + }, + "HyperParameterTuningEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the tuning job ended.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the status of the tuning job was modified.
" + } + }, + "TrainingJobStatusCounters": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the number of training\n jobs, categorized by status, that this tuning job launched.
", + "smithy.api#required": {} + } + }, + "ObjectiveStatusCounters": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the number of training jobs,\n categorized by the status of their final objective metric, that this tuning job\n launched.
", + "smithy.api#required": {} + } + }, + "BestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", + "traits": { + "smithy.api#documentation": "A TrainingJobSummary object that describes the training job that completed\n with the best current HyperParameterTuningJobObjective.
" + } + }, + "OverallBestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", + "traits": { + "smithy.api#documentation": "If the hyperparameter tuning job is an warm start tuning job with a\n WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the\n TrainingJobSummary for the training job with the best objective metric\n value of all training jobs launched by this tuning job and all parent jobs specified for\n the warm start tuning job.
The configuration for starting the hyperparameter parameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.
" + } + }, + "Autotune": { + "target": "com.amazonaws.sagemaker#Autotune", + "traits": { + "smithy.api#documentation": "A flag to indicate if autotune is enabled for the hyperparameter tuning job.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the tuning job failed, the reason it failed.
" + } + }, + "TuningJobCompletionDetails": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails", + "traits": { + "smithy.api#documentation": "Tuning job completion information returned as the response from a hyperparameter\n tuning job. This information tells if your tuning job has or has not converged. It also\n includes the number of training jobs that have not improved model performance as\n evaluated against the objective function.
" + } + }, + "ConsumedResources": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConsumedResources" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeImageRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes a SageMaker AI image.
", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ImageCreated": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "CREATED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + }, + "ImageDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + }, + "ImageUpdated": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "CREATED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageStatus", + "expected": "UPDATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeImageRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeImageResponse": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the image was created.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ImageDescription", + "traits": { + "smithy.api#documentation": "The description of the image.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ImageDisplayName", + "traits": { + "smithy.api#documentation": "The name of the image as displayed.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "When a create, update, or delete operation fails, the reason for the failure.
" + } + }, + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "The ARN of the image.
" + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#documentation": "The name of the image.
" + } + }, + "ImageStatus": { + "target": "com.amazonaws.sagemaker#ImageStatus", + "traits": { + "smithy.api#documentation": "The status of the image.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the image was last modified.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeImageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeImageVersionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeImageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes a version of a SageMaker AI image.
", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ImageVersionCreated": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImageVersionStatus", + "expected": "CREATED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageVersionStatus", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + }, + "ImageVersionDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageVersionStatus", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeImageVersionRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image.
", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "The version of the image. If not specified, the latest version is described.
" + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "The alias of the image version.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeImageVersionResponse": { + "type": "structure", + "members": { + "BaseImage": { + "target": "com.amazonaws.sagemaker#ImageBaseImage", + "traits": { + "smithy.api#documentation": "The registry path of the container image on which this image version is based.
" + } + }, + "ContainerImage": { + "target": "com.amazonaws.sagemaker#ImageContainerImage", + "traits": { + "smithy.api#documentation": "The registry path of the container image that contains this image version.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the version was created.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "When a create or delete operation fails, the reason for the failure.
" + } + }, + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "The ARN of the image the version is based on.
" + } + }, + "ImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the version.
" + } + }, + "ImageVersionStatus": { + "target": "com.amazonaws.sagemaker#ImageVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the version.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the version was last modified.
" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "The version number.
" + } + }, + "VendorGuidance": { + "target": "com.amazonaws.sagemaker#VendorGuidance", + "traits": { + "smithy.api#documentation": "The stability of the image version specified by the maintainer.
\n\n NOT_PROVIDED: The maintainers did not provide a status for image version stability.
\n STABLE: The image version is stable.
\n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
\n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
\n\n TRAINING: The image version is compatible with SageMaker AI training jobs.
\n INFERENCE: The image version is compatible with SageMaker AI inference jobs.
\n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
The machine learning framework vended in the image version.
" + } + }, + "ProgrammingLang": { + "target": "com.amazonaws.sagemaker#ProgrammingLang", + "traits": { + "smithy.api#documentation": "The supported programming language and its version.
" + } + }, + "Processor": { + "target": "com.amazonaws.sagemaker#Processor", + "traits": { + "smithy.api#documentation": "Indicates CPU or GPU compatibility.
\n\n CPU: The image version is compatible with CPU.
\n GPU: The image version is compatible with GPU.
Indicates Horovod compatibility.
" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.sagemaker#ReleaseNotes", + "traits": { + "smithy.api#documentation": "The maintainer description of the image version.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponentOutput" + }, + "traits": { + "smithy.api#documentation": "Returns information about an inference component.
" + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference component.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference component.
", + "smithy.api#required": {} + } + }, + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint that hosts the inference component.
", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "The name of the production variant that hosts the inference component.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the inference component status is Failed, the reason for the\n failure.
Details about the resources that are deployed with this inference component.
" + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary", + "traits": { + "smithy.api#documentation": "Details about the runtime settings for the model that is deployed with the inference\n component.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the inference component was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the inference component was last updated.
", + "smithy.api#required": {} + } + }, + "InferenceComponentStatus": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "The status of the inference component.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns details about an inference experiment.
" + } + }, + "com.amazonaws.sagemaker#DescribeInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference experiment to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceExperimentResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the inference experiment being described.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference experiment.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#InferenceExperimentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of the inference experiment.
", + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", + "traits": { + "smithy.api#documentation": "The duration for which the inference experiment ran or will run.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The status of the inference experiment. The following are the possible statuses for an inference\n experiment:\n
\n\n Creating - Amazon SageMaker is creating your experiment.\n
\n Created - Amazon SageMaker has finished the creation of your experiment and will begin the\n experiment at the scheduled time.\n
\n Updating - When you make changes to your experiment, your experiment shows as updating.\n
\n Starting - Amazon SageMaker is beginning your experiment.\n
\n Running - Your experiment is in progress.\n
\n Stopping - Amazon SageMaker is stopping your experiment.\n
\n Completed - Your experiment has completed.\n
\n Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows\n as cancelled.\n
\n The error message or client-specified Reason from the StopInferenceExperiment\n API, that explains the status of the inference experiment.\n
The description of the inference experiment.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which you created the inference experiment.
" + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "\n The timestamp at which the inference experiment was completed.\n
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which you last modified the inference experiment.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n
" + } + }, + "EndpointMetadata": { + "target": "com.amazonaws.sagemaker#EndpointMetadata", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The metadata of the endpoint on which the inference experiment ran.
", + "smithy.api#required": {} + } + }, + "ModelVariants": { + "target": "com.amazonaws.sagemaker#ModelVariantConfigSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n An array of ModelVariantConfigSummary objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure\n configuration for deploying the corresponding variant.\n
The Amazon S3 location and configuration for storing inference request and response data.
" + } + }, + "ShadowModeConfig": { + "target": "com.amazonaws.sagemaker#ShadowModeConfig", + "traits": { + "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type, which shows the production variant\n that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.\n
\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see\n CreateInferenceExperiment.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Provides the results of the Inference Recommender job. \n One or more recommendation jobs are returned.
" + } + }, + "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobResponse": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "JobDescription": { + "target": "com.amazonaws.sagemaker#RecommendationJobDescription", + "traits": { + "smithy.api#documentation": "The job description that you provided when you initiated the job.
" + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#RecommendationJobType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The job type that you provided when you initiated the job.
", + "smithy.api#required": {} + } + }, + "JobArn": { + "target": "com.amazonaws.sagemaker#RecommendationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services \n Identity and Access Management (IAM) role you provided when you initiated the job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the job was created.
", + "smithy.api#required": {} + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the job completed.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the job was last modified.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the job fails, provides information why the job failed.
" + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations you provided when you initiated the job.
", + "smithy.api#required": {} + } + }, + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#RecommendationJobStoppingConditions", + "traits": { + "smithy.api#documentation": "The stopping conditions that you provided when you initiated the job.
" + } + }, + "InferenceRecommendations": { + "target": "com.amazonaws.sagemaker#InferenceRecommendations", + "traits": { + "smithy.api#documentation": "The recommendations made by Inference Recommender.
" + } + }, + "EndpointPerformances": { + "target": "com.amazonaws.sagemaker#EndpointPerformances", + "traits": { + "smithy.api#documentation": "The performance results from running an Inference Recommender job on an existing endpoint.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeLabelingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeLabelingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeLabelingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a labeling job.
" + } + }, + "com.amazonaws.sagemaker#DescribeLabelingJobRequest": { + "type": "structure", + "members": { + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the labeling job to return information for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeLabelingJobResponse": { + "type": "structure", + "members": { + "LabelingJobStatus": { + "target": "com.amazonaws.sagemaker#LabelingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The processing status of the labeling job.
", + "smithy.api#required": {} + } + }, + "LabelCounters": { + "target": "com.amazonaws.sagemaker#LabelCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Provides a breakdown of the number of data objects labeled by humans, the number of\n objects labeled by machine, the number of objects than couldn't be labeled, and the\n total number of objects labeled.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the job failed, the reason that it failed.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the labeling job was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the labeling job was last updated.
", + "smithy.api#required": {} + } + }, + "JobReferenceCode": { + "target": "com.amazonaws.sagemaker#JobReferenceCode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique identifier for work done as part of a labeling job.
", + "smithy.api#required": {} + } + }, + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name assigned to the labeling job when it was created.
", + "smithy.api#required": {} + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the labeling job.
", + "smithy.api#required": {} + } + }, + "LabelAttributeName": { + "target": "com.amazonaws.sagemaker#LabelAttributeName", + "traits": { + "smithy.api#documentation": "The attribute used as the label in the output manifest file.
" + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Input configuration information for the labeling job, such as the Amazon S3 location of the\n data objects and the location of the manifest file that describes the data\n objects.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location of the job's output data and the Amazon Web Services Key Management\n Service key ID for the key used to encrypt the output data, if any.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf\n during data labeling.
", + "smithy.api#required": {} + } + }, + "LabelCategoryConfigS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 location of the JSON file that defines the categories used to label data\n objects. Please note the following label-category limits:
\nSemantic segmentation labeling jobs using automated labeling: 20 labels
\nBox bounding labeling jobs (all): 10 labels
\nThe file is a JSON structure in the following format:
\n\n {\n
\n \"document-version\": \"2018-11-28\"\n
\n \"labels\": [\n
\n {\n
\n \"label\": \"label 1\"\n
\n },\n
\n {\n
\n \"label\": \"label 2\"\n
\n },\n
\n ...\n
\n {\n
\n \"label\": \"label n\"\n
\n }\n
\n ]\n
\n }\n
A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped.
" + } + }, + "LabelingJobAlgorithmsConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig", + "traits": { + "smithy.api#documentation": "Configuration information for automated data labeling.
" + } + }, + "HumanTaskConfig": { + "target": "com.amazonaws.sagemaker#HumanTaskConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configuration information required for human workers to complete a labeling\n task.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + }, + "LabelingJobOutput": { + "target": "com.amazonaws.sagemaker#LabelingJobOutput", + "traits": { + "smithy.api#documentation": "The location of the output produced by the labeling job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeLineageGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeLineageGroupRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeLineageGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Provides a list of properties for the requested lineage group. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
" + } + }, + "com.amazonaws.sagemaker#DescribeLineageGroupRequest": { + "type": "structure", + "members": { + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the lineage group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeLineageGroupResponse": { + "type": "structure", + "members": { + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the lineage group.
" + } + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The display name of the lineage group.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "The description of the lineage group.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of lineage group.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last modified time of the lineage group.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the MLflow Tracking Server to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the described tracking server.
" + } + }, + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#documentation": "The name of the described tracking server.
" + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI of the general purpose bucket used as the MLflow Tracking Server\n artifact store.
" + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "The size of the described tracking server.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "The MLflow version used for the described tracking server.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server\n uses to access the artifact store in Amazon S3.
" + } + }, + "TrackingServerStatus": { + "target": "com.amazonaws.sagemaker#TrackingServerStatus", + "traits": { + "smithy.api#documentation": "The current creation status of the described MLflow Tracking Server.
" + } + }, + "IsActive": { + "target": "com.amazonaws.sagemaker#IsTrackingServerActive", + "traits": { + "smithy.api#documentation": "Whether the described MLflow Tracking Server is currently active.
" + } + }, + "TrackingServerUrl": { + "target": "com.amazonaws.sagemaker#TrackingServerUrl", + "traits": { + "smithy.api#documentation": "The URL to connect to the MLflow user interface for the described tracking server.
" + } + }, + "WeeklyMaintenanceWindowStart": { + "target": "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart", + "traits": { + "smithy.api#documentation": "The day and time of the week when weekly maintenance occurs on the described tracking server.
" + } + }, + "AutomaticModelRegistration": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the described MLflow Tracking Server was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the described MLflow Tracking Server was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelOutput" + }, + "traits": { + "smithy.api#documentation": "Describes a model that you created using the CreateModel\n API.
Returns a description of a model bias job definition.
" + } + }, + "com.amazonaws.sagemaker#DescribeModelBiasJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelBiasJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model bias job.
", + "smithy.api#required": {} + } + }, + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time at which the model bias job was created.
", + "smithy.api#required": {} + } + }, + "ModelBiasBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelBiasBaselineConfig", + "traits": { + "smithy.api#documentation": "The baseline configuration for a model bias job.
" + } + }, + "ModelBiasAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelBiasAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configures the model bias job to run a specified Docker container image.
", + "smithy.api#required": {} + } + }, + "ModelBiasJobInput": { + "target": "com.amazonaws.sagemaker#ModelBiasJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Inputs for the model bias job.
", + "smithy.api#required": {} + } + }, + "ModelBiasJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "Networking options for a model bias job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelCard": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelCardRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelCardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
" + } + }, + "com.amazonaws.sagemaker#DescribeModelCardExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelCardExportJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelCardExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes an Amazon SageMaker Model Card export job.
" + } + }, + "com.amazonaws.sagemaker#DescribeModelCardExportJobRequest": { + "type": "structure", + "members": { + "ModelCardExportJobArn": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card export job to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelCardExportJobResponse": { + "type": "structure", + "members": { + "ModelCardExportJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model card export job to describe.
", + "smithy.api#required": {} + } + }, + "ModelCardExportJobArn": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card export job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The completion status of the model card export job.
\n\n InProgress: The model card export job is in progress.
\n Completed: The model card export job is complete.
\n Failed: The model card export job failed. To see the reason for the failure, see\n the FailureReason field in the response to a\n DescribeModelCardExportJob call.
The name or Amazon Resource Name (ARN) of the model card that the model export job exports.
", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the model card that the model export job exports.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#ModelCardExportOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The export output details for the model card.
", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the model export job was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedAt": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the model export job was last modified.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The failure reason if the model export job fails.
" + } + }, + "ExportArtifacts": { + "target": "com.amazonaws.sagemaker#ModelCardExportArtifacts", + "traits": { + "smithy.api#documentation": "The exported model card artifacts.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelCardRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model card to describe.
", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelCardResponse": { + "type": "structure", + "members": { + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card.
", + "smithy.api#required": {} + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model card.
", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the model card.
", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The content of the model card.
", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The security configuration used to protect model card content.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time the model card was created.
", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the model card was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ModelCardProcessingStatus": { + "target": "com.amazonaws.sagemaker#ModelCardProcessingStatus", + "traits": { + "smithy.api#documentation": "The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
\n DeletePending: Model card deletion request received.
\n DeleteInProgress: Model card deletion is in progress.
\n ContentDeleted: Deleted model card content.
\n ExportJobsDeleted: Deleted all export jobs associated with the model card.
\n DeleteCompleted: Successfully deleted the model card.
\n DeleteFailed: The model card failed to delete.
Returns a description of a model explainability job definition.
" + } + }, + "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelExplainabilityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model explainability job.
", + "smithy.api#required": {} + } + }, + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time at which the model explainability job was created.
", + "smithy.api#required": {} + } + }, + "ModelExplainabilityBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityBaselineConfig", + "traits": { + "smithy.api#documentation": "The baseline configuration for a model explainability job.
" + } + }, + "ModelExplainabilityAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configures the model explainability job to run a specified Docker container image.
", + "smithy.api#required": {} + } + }, + "ModelExplainabilityJobInput": { + "target": "com.amazonaws.sagemaker#ModelExplainabilityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Inputs for the model explainability job.
", + "smithy.api#required": {} + } + }, + "ModelExplainabilityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "Networking options for a model explainability job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelInput": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelOutput": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the SageMaker model.
", + "smithy.api#required": {} + } + }, + "PrimaryContainer": { + "target": "com.amazonaws.sagemaker#ContainerDefinition", + "traits": { + "smithy.api#documentation": "The location of the primary inference code, associated artifacts, and custom\n environment map that the inference code uses when it is deployed in production.\n
" + } + }, + "Containers": { + "target": "com.amazonaws.sagemaker#ContainerDefinitionList", + "traits": { + "smithy.api#documentation": "The containers in the inference pipeline.
" + } + }, + "InferenceExecutionConfig": { + "target": "com.amazonaws.sagemaker#InferenceExecutionConfig", + "traits": { + "smithy.api#documentation": "Specifies details of how containers in a multi-container endpoint are called.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this model has access to. For\n more information, see Protect Endpoints by Using an Amazon Virtual\n Private Cloud\n
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the model was created.
", + "smithy.api#required": {} + } + }, + "ModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model.
", + "smithy.api#required": {} + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "If True, no inbound or outbound network calls can be made to or from the\n model container.
A set of recommended deployment configurations for the model.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelPackageInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelPackageOutput" + }, + "traits": { + "smithy.api#documentation": "Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.
\nIf you provided a KMS Key ID when you created your model package,\n you will see the KMS\n Decrypt API call in your CloudTrail logs when you use this API.
\nTo create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace.
" + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelPackageGroupInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelPackageGroupOutput" + }, + "traits": { + "smithy.api#documentation": "Gets a description for the specified model group.
" + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageGroupInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model group to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageGroupOutput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model group.
", + "smithy.api#required": {} + } + }, + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model group.
", + "smithy.api#required": {} + } + }, + "ModelPackageGroupDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A description of the model group.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time that the model group was created.
", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "ModelPackageGroupStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the model group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#VersionedArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to describe.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelPackageOutput": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model package being described.
", + "smithy.api#required": {} + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "If the model is a versioned model, the name of the model group that the versioned\n model belongs to.
" + } + }, + "ModelPackageVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageVersion", + "traits": { + "smithy.api#documentation": "The version of the model package.
" + } + }, + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
", + "smithy.api#required": {} + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A brief summary of the model package.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp specifying when the model package was created.
", + "smithy.api#required": {} + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "Details about inference jobs that you can run with models based on this model\n package.
" + } + }, + "SourceAlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", + "traits": { + "smithy.api#documentation": "Details about the algorithm that was used to create the model package.
" + } + }, + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", + "traits": { + "smithy.api#documentation": "Configurations for one or more transform jobs that SageMaker runs to test the model\n package.
" + } + }, + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the model package.
", + "smithy.api#required": {} + } + }, + "ModelPackageStatusDetails": { + "target": "com.amazonaws.sagemaker#ModelPackageStatusDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Details about the current status of the model package.
", + "smithy.api#required": {} + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "Whether the model package is certified for listing on Amazon Web Services Marketplace.
" + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "The approval status of the model package.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "ModelMetrics": { + "target": "com.amazonaws.sagemaker#ModelMetrics", + "traits": { + "smithy.api#documentation": "Metrics for the model.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the model package was modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ApprovalDescription": { + "target": "com.amazonaws.sagemaker#ApprovalDescription", + "traits": { + "smithy.api#documentation": "A description provided for the model approval.
" + } + }, + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning domain of the model package you specified. Common machine\n learning domains include computer vision and natural language processing.
" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning task you specified that your model package accomplishes.\n Common machine learning tasks include object detection and image classification.
" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single\n gzip compressed tar archive (.tar.gz suffix).
" + } + }, + "CustomerMetadataProperties": { + "target": "com.amazonaws.sagemaker#CustomerMetadataMap", + "traits": { + "smithy.api#documentation": "The metadata properties associated with the model package versions.
" + } + }, + "DriftCheckBaselines": { + "target": "com.amazonaws.sagemaker#DriftCheckBaselines", + "traits": { + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package. \n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n
" + } + }, + "AdditionalInferenceSpecifications": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
" + } + }, + "SkipModelValidation": { + "target": "com.amazonaws.sagemaker#SkipModelValidation", + "traits": { + "smithy.api#documentation": "Indicates if you want to skip model validation.
" + } + }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "The URI of the source for the model package.
" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", + "traits": { + "smithy.api#documentation": "The KMS Key ID (KMSKeyId) used for encryption of model package information.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
\n A structure describing the current state of the model in its life cycle.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelQualityJobDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns a description of a model quality job definition.
" + } + }, + "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionRequest": { + "type": "structure", + "members": { + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model quality job. The name must be unique within an Amazon Web Services\n Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeModelQualityJobDefinitionResponse": { + "type": "structure", + "members": { + "JobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model quality job.
", + "smithy.api#required": {} + } + }, + "JobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time at which the model quality job was created.
", + "smithy.api#required": {} + } + }, + "ModelQualityBaselineConfig": { + "target": "com.amazonaws.sagemaker#ModelQualityBaselineConfig", + "traits": { + "smithy.api#documentation": "The baseline configuration for a model quality job.
" + } + }, + "ModelQualityAppSpecification": { + "target": "com.amazonaws.sagemaker#ModelQualityAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configures the model quality job to run a specified Docker container image.
", + "smithy.api#required": {} + } + }, + "ModelQualityJobInput": { + "target": "com.amazonaws.sagemaker#ModelQualityJobInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Inputs for the model quality job.
", + "smithy.api#required": {} + } + }, + "ModelQualityJobOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "JobResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#MonitoringNetworkConfig", + "traits": { + "smithy.api#documentation": "Networking options for a model quality job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeMonitoringScheduleRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeMonitoringScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes the schedule for a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#DescribeMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of a previously created monitoring schedule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeMonitoringScheduleResponse": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "MonitoringScheduleStatus": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of an monitoring job.
", + "smithy.api#required": {} + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "The type of the monitoring job that this schedule runs. This is one of the following\n values.
\n\n DATA_QUALITY - The schedule is for a data quality monitoring\n job.
\n MODEL_QUALITY - The schedule is for a model quality monitoring\n job.
\n MODEL_BIAS - The schedule is for a bias monitoring job.
\n MODEL_EXPLAINABILITY - The schedule is for an explainability\n monitoring job.
A string, up to one KB in size, that contains the reason a monitoring job failed, if it\n failed.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time at which the monitoring job was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time at which the monitoring job was last modified.
", + "smithy.api#required": {} + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the endpoint for the monitoring job.
" + } + }, + "LastMonitoringExecutionSummary": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary", + "traits": { + "smithy.api#documentation": "Describes metadata on the last execution to run, if there was one.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceOutput" + }, + "traits": { + "smithy.api#documentation": "Returns information about a notebook instance.
", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "NotebookInstanceDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ValidationException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "NotebookInstanceInService": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "InService", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "NotebookInstanceStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the notebook instance that you want information about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigOutput" + }, + "traits": { + "smithy.api#documentation": "Returns a description of a notebook instance lifecycle configuration.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigInput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the lifecycle configuration to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigOutput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle configuration.
" + } + }, + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "The name of the lifecycle configuration.
" + } + }, + "OnCreate": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "The shell script that runs only once, when you create a notebook instance.
" + } + }, + "OnStart": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A timestamp that tells when the lifecycle configuration was last modified.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A timestamp that tells when the lifecycle configuration was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeNotebookInstanceOutput": { + "type": "structure", + "members": { + "NotebookInstanceArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the notebook instance.
" + } + }, + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#documentation": "The name of the SageMaker AI notebook instance.
" + } + }, + "NotebookInstanceStatus": { + "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "traits": { + "smithy.api#documentation": "The status of the notebook instance.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If status is Failed, the reason it failed.
The URL that you use to connect to the Jupyter notebook that is running in your\n notebook instance.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", + "traits": { + "smithy.api#documentation": "The type of ML compute instance running on the notebook instance.
" + } + }, + "SubnetId": { + "target": "com.amazonaws.sagemaker#SubnetId", + "traits": { + "smithy.api#documentation": "The ID of the VPC subnet.
" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "The IDs of the VPC security groups.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the instance.\n
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when\n storing it on the ML storage volume attached to the instance.
" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.sagemaker#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "The network interface IDs that SageMaker AI created at the time of creating\n the instance.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A timestamp. Use this parameter to retrieve the time when the notebook instance was\n last modified.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A timestamp. Use this parameter to return the time when the notebook instance was\n created
" + } + }, + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "Returns the name of a notebook instance lifecycle configuration.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance\n
" + } + }, + "DirectInternetAccess": { + "target": "com.amazonaws.sagemaker#DirectInternetAccess", + "traits": { + "smithy.api#documentation": "Describes whether SageMaker AI provides internet access to the notebook instance.\n If this value is set to Disabled, the notebook instance does not\n have internet access, and cannot connect to SageMaker AI training and endpoint\n services.
\nFor more information, see Notebook Instances Are Internet-Enabled by Default.
" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to the notebook instance.
" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", + "traits": { + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of the EI instance types associated with\n this notebook instance.
" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "traits": { + "smithy.api#documentation": "An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + } + }, + "RootAccess": { + "target": "com.amazonaws.sagemaker#RootAccess", + "traits": { + "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance.
\nLifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.
\nThe platform identifier of the notebook instance runtime environment.
" + } + }, + "InstanceMetadataServiceConfiguration": { + "target": "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration", + "traits": { + "smithy.api#documentation": "Information on the IMDS configuration of the notebook instance
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeOptimizationJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeOptimizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Provides the properties of the specified optimization job.
" + } + }, + "com.amazonaws.sagemaker#DescribeOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeOptimizationJobResponse": { + "type": "structure", + "members": { + "OptimizationJobArn": { + "target": "com.amazonaws.sagemaker#OptimizationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationJobStatus": { + "target": "com.amazonaws.sagemaker#OptimizationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the optimization job started.
" + } + }, + "OptimizationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the optimization job finished processing.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when you created the optimization job.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the optimization job was last updated.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the optimization job status is FAILED, the reason for the\n failure.
The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + }, + "ModelSource": { + "target": "com.amazonaws.sagemaker#OptimizationJobModelSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location of the source model to optimize with an optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "The environment variables to set in the model container.
" + } + }, + "DeploymentInstanceType": { + "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of instance that hosts the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationConfigs": { + "target": "com.amazonaws.sagemaker#OptimizationConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Settings for each of the optimization techniques that the job applies.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OptimizationJobOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Details for where to store the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationOutput": { + "target": "com.amazonaws.sagemaker#OptimizationOutput", + "traits": { + "smithy.api#documentation": "Output values produced by an optimization job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the IAM role that you assigned to the optimization job.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#OptimizationVpcConfig", + "traits": { + "smithy.api#documentation": "A VPC in Amazon VPC that your optimized model has access to.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#DescribePartnerAppRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App that was described.
" + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#PartnerAppName", + "traits": { + "smithy.api#documentation": "The name of the SageMaker Partner AI App.
" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#PartnerAppType", + "traits": { + "smithy.api#documentation": "The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The status of the SageMaker Partner AI App.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the SageMaker Partner AI App was created.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role associated with the SageMaker Partner AI App.
" + } + }, + "BaseUrl": { + "target": "com.amazonaws.sagemaker#String2048", + "traits": { + "smithy.api#documentation": "The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
" + } + }, + "MaintenanceConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", + "traits": { + "smithy.api#documentation": "Maintenance configuration settings for the SageMaker Partner AI App.
" + } + }, + "Tier": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The instance type and size of the cluster attached to the SageMaker Partner AI App.
" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The version of the SageMaker Partner AI App.
" + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" + } + }, + "AuthType": { + "target": "com.amazonaws.sagemaker#PartnerAppAuthType", + "traits": { + "smithy.api#documentation": "The authorization type that users use to access the SageMaker Partner AI App.
" + } + }, + "EnableIamSessionBasedIdentity": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
This is an error field object that contains the error code and the reason for an operation failure.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribePipelineRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes the details of a pipeline.
" + } + }, + "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes the details of an execution's pipeline definition.
" + } + }, + "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineDefinitionForExecutionResponse": { + "type": "structure", + "members": { + "PipelineDefinition": { + "target": "com.amazonaws.sagemaker#PipelineDefinition", + "traits": { + "smithy.api#documentation": "The JSON pipeline definition.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the pipeline was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribePipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribePipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes the details of a pipeline execution.
" + } + }, + "com.amazonaws.sagemaker#DescribePipelineExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" + } + }, + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline execution.
" + } + }, + "PipelineExecutionStatus": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStatus", + "traits": { + "smithy.api#documentation": "The status of the pipeline execution.
" + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "The description of the pipeline execution.
" + } + }, + "PipelineExperimentConfig": { + "target": "com.amazonaws.sagemaker#PipelineExperimentConfig" + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#PipelineExecutionFailureReason", + "traits": { + "smithy.api#documentation": "If the execution failed, a message describing why.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the pipeline execution was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the pipeline execution was modified last.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "The parallelism configuration applied to the pipeline.
" + } + }, + "SelectiveExecutionConfig": { + "target": "com.amazonaws.sagemaker#SelectiveExecutionConfig", + "traits": { + "smithy.api#documentation": "The selective execution configuration applied to the pipeline run.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the pipeline to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribePipelineResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" + } + }, + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "The name of the pipeline.
" + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline.
" + } + }, + "PipelineDefinition": { + "target": "com.amazonaws.sagemaker#PipelineDefinition", + "traits": { + "smithy.api#documentation": "The JSON pipeline definition.
" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "The description of the pipeline.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that the pipeline uses to execute.
" + } + }, + "PipelineStatus": { + "target": "com.amazonaws.sagemaker#PipelineStatus", + "traits": { + "smithy.api#documentation": "The status of the pipeline execution.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the pipeline was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the pipeline was last modified.
" + } + }, + "LastRunTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the pipeline was last run.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "Lists the parallelism configuration applied to the pipeline.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeProcessingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeProcessingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeProcessingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns a description of a processing job.
", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ProcessingJobCompletedOrStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ProcessingJobStatus", + "expected": "Completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "ProcessingJobStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ProcessingJobStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeProcessingJobRequest": { + "type": "structure", + "members": { + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeProcessingJobResponse": { + "type": "structure", + "members": { + "ProcessingInputs": { + "target": "com.amazonaws.sagemaker#ProcessingInputs", + "traits": { + "smithy.api#documentation": "The inputs for a processing job.
" + } + }, + "ProcessingOutputConfig": { + "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", + "traits": { + "smithy.api#documentation": "Output configuration for the processing job.
" + } + }, + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "ProcessingResources": { + "target": "com.amazonaws.sagemaker#ProcessingResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", + "traits": { + "smithy.api#documentation": "The time limit for how long the processing job is allowed to run.
" + } + }, + "AppSpecification": { + "target": "com.amazonaws.sagemaker#AppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configures the processing job to run a specified container image.
", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables set in the Docker container.
" + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig", + "traits": { + "smithy.api#documentation": "Networking options for a processing job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.
" + } + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig", + "traits": { + "smithy.api#documentation": "The configuration information used to create an experiment.
" + } + }, + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job.
", + "smithy.api#required": {} + } + }, + "ProcessingJobStatus": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Provides the status of a processing job.
", + "smithy.api#required": {} + } + }, + "ExitMessage": { + "target": "com.amazonaws.sagemaker#ExitMessage", + "traits": { + "smithy.api#documentation": "An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.
" + } + }, + "ProcessingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the processing job completed.
" + } + }, + "ProcessingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the processing job started.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the processing job was last modified.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time at which the processing job was created.
", + "smithy.api#required": {} + } + }, + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#documentation": "The ARN of a monitoring schedule for an endpoint associated with this processing\n job.
" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "The ARN of an AutoML job associated with this processing job.
" + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#documentation": "The ARN of a training job associated with this processing job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeProjectInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeProjectOutput" + }, + "traits": { + "smithy.api#documentation": "Describes the details of a project.
" + } + }, + "com.amazonaws.sagemaker#DescribeProjectInput": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the project to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeProjectOutput": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
", + "smithy.api#required": {} + } + }, + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the project.
", + "smithy.api#required": {} + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#ProjectId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the project.
", + "smithy.api#required": {} + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "The description of the project.
" + } + }, + "ServiceCatalogProvisioningDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information used to provision a service catalog product. For information, see What is Amazon Web Services Service\n Catalog.
", + "smithy.api#required": {} + } + }, + "ServiceCatalogProvisionedProductDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisionedProductDetails", + "traits": { + "smithy.api#documentation": "Information about a provisioned service catalog product.
" + } + }, + "ProjectStatus": { + "target": "com.amazonaws.sagemaker#ProjectStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the project.
", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the project was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when project was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeSpace": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeSpaceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeSpaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes the space.
" + } + }, + "com.amazonaws.sagemaker#DescribeSpaceRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the associated domain.
", + "smithy.api#required": {} + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the space.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeSpaceResponse": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the associated domain.
" + } + }, + "SpaceArn": { + "target": "com.amazonaws.sagemaker#SpaceArn", + "traits": { + "smithy.api#documentation": "The space's Amazon Resource Name (ARN).
" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "The name of the space.
" + } + }, + "HomeEfsFileSystemUid": { + "target": "com.amazonaws.sagemaker#EfsUid", + "traits": { + "smithy.api#documentation": "The ID of the space's profile in the Amazon EFS volume.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SpaceStatus", + "traits": { + "smithy.api#documentation": "The status.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "The last modified time.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "The creation time.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The failure reason.
" + } + }, + "SpaceSettings": { + "target": "com.amazonaws.sagemaker#SpaceSettings", + "traits": { + "smithy.api#documentation": "A collection of space settings.
" + } + }, + "OwnershipSettings": { + "target": "com.amazonaws.sagemaker#OwnershipSettings", + "traits": { + "smithy.api#documentation": "The collection of ownership settings for a space.
" + } + }, + "SpaceSharingSettings": { + "target": "com.amazonaws.sagemaker#SpaceSharingSettings", + "traits": { + "smithy.api#documentation": "The collection of space sharing settings for a space.
" + } + }, + "SpaceDisplayName": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The name of the space that appears in the Amazon SageMaker Studio UI.
" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity\n Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to\n the URL after appending the respective redirect parameter for the application type to be\n federated through Amazon Web Services IAM Identity Center.
\nThe following application types are supported:
\nStudio Classic: &redirect=JupyterServer\n
JupyterLab: &redirect=JupyterLab\n
Code Editor, based on Code-OSS, Visual Studio Code - Open Source:\n &redirect=CodeEditor\n
Describes the Amazon SageMaker AI Studio Lifecycle Configuration.
" + } + }, + "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigRequest": { + "type": "structure", + "members": { + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigResponse": { + "type": "structure", + "members": { + "StudioLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lifecycle Configuration to describe.
" + } + }, + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is\n described.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle\n Configurations are immutable.
" + } + }, + "StudioLifecycleConfigContent": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", + "traits": { + "smithy.api#documentation": "The content of your Amazon SageMaker AI Studio Lifecycle Configuration script.
" + } + }, + "StudioLifecycleConfigAppType": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", + "traits": { + "smithy.api#documentation": "The App type that the Lifecycle Configuration is attached to.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeSubscribedWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeSubscribedWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeSubscribedWorkteamResponse" + }, + "traits": { + "smithy.api#documentation": "Gets information about a work team provided by a vendor. It returns details about the\n subscription with a vendor in the Amazon Web Services Marketplace.
" + } + }, + "com.amazonaws.sagemaker#DescribeSubscribedWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the subscribed work team to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeSubscribedWorkteamResponse": { + "type": "structure", + "members": { + "SubscribedWorkteam": { + "target": "com.amazonaws.sagemaker#SubscribedWorkteam", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Workteam instance that contains information about the work team.
Returns information about a training job.
\nSome of the attributes below only appear if the training job successfully starts.\n If the training job fails, TrainingJobStatus is Failed and,\n depending on the FailureReason, attributes like\n TrainingStartTime, TrainingTimeInSeconds,\n TrainingEndTime, and BillableTimeInSeconds may not be\n present in the response.
The name of the training job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrainingJobResponse": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the model training job.
", + "smithy.api#required": {} + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
", + "smithy.api#required": {} + } + }, + "TuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.
" + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the\n transform or training job.
" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an AutoML job.
" + } + }, + "ModelArtifacts": { + "target": "com.amazonaws.sagemaker#ModelArtifacts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the Amazon S3 location that is configured for storing model artifacts.\n
", + "smithy.api#required": {} + } + }, + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the training job.
\nSageMaker provides the following training job statuses:
\n\n InProgress - The training is in progress.
\n Completed - The training job has completed.
\n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.
\n Stopping - The training job is stopping.
\n Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus.
Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of\n them:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Interrupted - The job stopped because the managed\n spot training instances were interrupted.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n MaxWaitTimeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTraining\n
\n DownloadingTrainingImage\n
If the training job failed, the reason it failed.
" + } + }, + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "Algorithm-specific parameters.
" + } + }, + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the algorithm used for training, and algorithm metadata.\n
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Identity and Access Management (IAM) role configured for\n the training job.
" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#documentation": "An array of Channel objects that describes each data input channel.\n
The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.
" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Resources, including ML compute instances and ML storage volumes, that are\n configured for model training.
", + "smithy.api#required": {} + } + }, + "WarmPoolStatus": { + "target": "com.amazonaws.sagemaker#WarmPoolStatus", + "traits": { + "smithy.api#documentation": "The status of the warm pool associated with the training job.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.
A timestamp that indicates when the training job was created.
", + "smithy.api#required": {} + } + }, + "TrainingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time when the training job starts on training instances. You are\n billed for the time interval between this time and the value of\n TrainingEndTime. The start time in CloudWatch Logs might be later than this time.\n The difference is due to the time it takes to download the training data and to the size\n of the training container.
Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
A timestamp that indicates when the status of the training job was last\n modified.
" + } + }, + "SecondaryStatusTransitions": { + "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", + "traits": { + "smithy.api#documentation": "A history of all of the secondary statuses that the training job has transitioned\n through.
" + } + }, + "FinalMetricDataList": { + "target": "com.amazonaws.sagemaker#FinalMetricDataList", + "traits": { + "smithy.api#documentation": "A collection of MetricData objects that specify the names, values, and\n dates and times that the training algorithm emitted to Amazon CloudWatch.
If you want to allow inbound or outbound network calls, except for calls between peers\n within a training cluster for distributed training, choose True. If you\n enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithms in\n distributed training.
A Boolean indicating whether managed spot training is enabled (True) or\n not (False).
The training time in seconds.
" + } + }, + "BillableTimeInSeconds": { + "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", + "traits": { + "smithy.api#documentation": "The billable time in seconds. Billable time refers to the absolute wall-clock\n time.
\nMultiply BillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run distributed training. The formula is as follows:\n BillableTimeInSeconds * InstanceCount .
You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.
Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
" + } + }, + "TensorBoardOutputConfig": { + "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + }, + "DebugRuleEvaluationStatuses": { + "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", + "traits": { + "smithy.api#documentation": "Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.
" + } + }, + "ProfilerConfig": { + "target": "com.amazonaws.sagemaker#ProfilerConfig" + }, + "ProfilerRuleConfigurations": { + "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", + "traits": { + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.
" + } + }, + "ProfilerRuleEvaluationStatuses": { + "target": "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatuses", + "traits": { + "smithy.api#documentation": "Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.
" + } + }, + "ProfilingStatus": { + "target": "com.amazonaws.sagemaker#ProfilingStatus", + "traits": { + "smithy.api#documentation": "Profiling status of a training job.
" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container.
" + } + }, + "RetryStrategy": { + "target": "com.amazonaws.sagemaker#RetryStrategy", + "traits": { + "smithy.api#documentation": "The number of times to retry the job when the job fails due to an\n InternalServerError.
Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" + } + }, + "InfraCheckConfig": { + "target": "com.amazonaws.sagemaker#InfraCheckConfig", + "traits": { + "smithy.api#documentation": "Contains information about the infrastructure health check configuration for the training job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrainingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTrainingPlanRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTrainingPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a specific training plan.
" + } + }, + "com.amazonaws.sagemaker#DescribeTrainingPlanRequest": { + "type": "structure", + "members": { + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the training plan to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrainingPlanResponse": { + "type": "structure", + "members": { + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan.
", + "smithy.api#required": {} + } + }, + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the training plan.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrainingPlanStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.
A message providing additional information about the current status of the training\n plan.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this training plan.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training\n plan.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the training plan.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the training plan.
" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The upfront fee for the training plan.
" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.sagemaker#CurrencyCode", + "traits": { + "smithy.api#documentation": "The currency code for the upfront fee (e.g., USD).
" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#documentation": "The total number of instances reserved in this training plan.
" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances currently available for use in this training plan.
" + } + }, + "InUseInstanceCount": { + "target": "com.amazonaws.sagemaker#InUseInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances currently in use from this training plan.
" + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training\n plan.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe list of Reserved Capacity providing the underlying compute resources of the plan.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeTransformJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTransformJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTransformJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a transform job.
", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "TransformJobCompletedOrStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "TransformJobStatus", + "expected": "Completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "TransformJobStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "TransformJobStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } + } + }, + "com.amazonaws.sagemaker#DescribeTransformJobRequest": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the transform job that you want to view details of.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTransformJobResponse": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the transform job.
", + "smithy.api#required": {} + } + }, + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job.
", + "smithy.api#required": {} + } + }, + "TransformJobStatus": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The\n status of the transform job. If the transform job failed, the reason\n is returned in the FailureReason field.
If the transform job failed, FailureReason describes\n why\n it failed. A transform job creates a log file, which includes error\n messages, and stores it\n as\n an Amazon S3 object. For more information, see Log Amazon SageMaker Events with\n Amazon CloudWatch.
The name of the model used in the transform job.
", + "smithy.api#required": {} + } + }, + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "traits": { + "smithy.api#documentation": "The\n maximum number\n of\n parallel requests on each instance node\n that can be launched in a transform job. The default value is 1.
" + } + }, + "ModelClientConfig": { + "target": "com.amazonaws.sagemaker#ModelClientConfig", + "traits": { + "smithy.api#documentation": "The timeout and maximum number of retries for processing a transform job\n invocation.
" + } + }, + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "traits": { + "smithy.api#documentation": "The\n maximum\n payload size, in MB, used in the\n transform job.
" + } + }, + "BatchStrategy": { + "target": "com.amazonaws.sagemaker#BatchStrategy", + "traits": { + "smithy.api#documentation": "Specifies the number of records to include in a mini-batch for an HTTP inference\n request.\n A record\n is a single unit of input data that inference\n can be made on. For example, a single line in a CSV file is a record.
\nTo enable the batch strategy, you must set SplitType\n to\n Line, RecordIO, or\n TFRecord.
The\n environment variables to set in the Docker container. We support up to 16 key and values\n entries in the map.
" + } + }, + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes the dataset to be transformed and the Amazon S3 location where it is\n stored.
", + "smithy.api#required": {} + } + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput", + "traits": { + "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.
" + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig", + "traits": { + "smithy.api#documentation": "Configuration to control how SageMaker captures inference data.
" + } + }, + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes\n the resources, including ML instance types and ML instance count, to\n use for the transform job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the transform Job was created.
", + "smithy.api#required": {} + } + }, + "TransformStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates when the transform job starts\n on\n ML instances. You are billed for the time interval between this time\n and the value of TransformEndTime.
Indicates when the transform job has been\n \n completed, or has stopped or failed. You are billed for the time\n interval between this time and the value of TransformStartTime.
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the\n transform or training job.
" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML transform job.
" + } + }, + "DataProcessing": { + "target": "com.amazonaws.sagemaker#DataProcessing" + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrial": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTrialRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTrialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Provides a list of a trial's properties.
" + } + }, + "com.amazonaws.sagemaker#DescribeTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Provides a list of a trials component's properties.
" + } + }, + "com.amazonaws.sagemaker#DescribeTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the trial component to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial component.
" + } + }, + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "traits": { + "smithy.api#documentation": "The status of the component. States include:
\nInProgress
\nCompleted
\nFailed
\nWhen the component started.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component ended.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who created the trial component.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who last modified the component.
" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "traits": { + "smithy.api#documentation": "The hyperparameters of the component.
" + } + }, + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "The input artifacts of the component.
" + } + }, + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "The output artifacts of the component.
" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Metrics": { + "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", + "traits": { + "smithy.api#documentation": "The metrics for the component.
" + } + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } + }, + "Sources": { + "target": "com.amazonaws.sagemaker#TrialComponentSources", + "traits": { + "smithy.api#documentation": "A list of ARNs and, if applicable, job types for multiple sources of an experiment\n run.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrialRequest": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the trial to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeTrialResponse": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial.
" + } + }, + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.
The name of the experiment the trial is part of.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#TrialSource", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source and, optionally, the job type.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the trial was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who created the trial.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the trial was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who last modified the trial.
" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeUserProfileRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeUserProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Describes a user profile. For more information, see CreateUserProfile.
The domain ID.
", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The user profile name. This value is not case sensitive.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeUserProfileResponse": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain that contains the profile.
" + } + }, + "UserProfileArn": { + "target": "com.amazonaws.sagemaker#UserProfileArn", + "traits": { + "smithy.api#documentation": "The user profile Amazon Resource Name (ARN).
" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "The user profile name.
" + } + }, + "HomeEfsFileSystemUid": { + "target": "com.amazonaws.sagemaker#EfsUid", + "traits": { + "smithy.api#documentation": "The ID of the user's profile in the Amazon Elastic File System volume.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#UserProfileStatus", + "traits": { + "smithy.api#documentation": "The status.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "The last modified time.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "The creation time.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The failure reason.
" + } + }, + "SingleSignOnUserIdentifier": { + "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", + "traits": { + "smithy.api#documentation": "The IAM Identity Center user identifier.
" + } + }, + "SingleSignOnUserValue": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The IAM Identity Center user value.
" + } + }, + "UserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "A collection of settings.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeWorkforce": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeWorkforceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeWorkforceResponse" + }, + "traits": { + "smithy.api#documentation": "Lists private workforce information, including workforce name, Amazon Resource Name\n (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address\n ranges are the IP addresses that workers can use to access tasks.
\nThis operation applies only to private workforces.
\nThe name of the private workforce whose access you want to restrict.\n WorkforceName is automatically set to default when a\n workforce is created and cannot be modified.
A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeWorkteamResponse" + }, + "traits": { + "smithy.api#documentation": "Gets information about a specific work team. You can see information such as the\n creation date, the last updated date, membership information, and the work team's Amazon\n Resource Name (ARN).
" + } + }, + "com.amazonaws.sagemaker#DescribeWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the work team to return a description of.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeWorkteamResponse": { + "type": "structure", + "members": { + "Workteam": { + "target": "com.amazonaws.sagemaker#Workteam", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Workteam instance that contains information about the work team.\n
The name of the variant to update.
", + "smithy.api#required": {} + } + }, + "DesiredWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "The variant's weight.
" + } + }, + "DesiredInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "The variant's capacity.
" + } + }, + "ServerlessUpdateConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessUpdateConfig", + "traits": { + "smithy.api#documentation": "Specifies the serverless update concurrency configuration for an endpoint variant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies weight and capacity values for a production variant.
" + } + }, + "com.amazonaws.sagemaker#DesiredWeightAndCapacityList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DesiredWeightAndCapacity" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#DestinationS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^(https|s3)://([^/])/?(.*)$" + } + }, + "com.amazonaws.sagemaker#DetailedAlgorithmStatus": { + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#DetailedModelPackageStatus": { + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#Device": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.sagemaker#DeviceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the device.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceDescription", + "traits": { + "smithy.api#documentation": "Description of the device.
" + } + }, + "IotThingName": { + "target": "com.amazonaws.sagemaker#ThingName", + "traits": { + "smithy.api#documentation": "Amazon Web Services Internet of Things (IoT) object name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information of a particular device.
" + } + }, + "com.amazonaws.sagemaker#DeviceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#DeviceDeploymentStatus": { + "type": "enum", + "members": { + "ReadyToDeploy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READYTODEPLOY" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "Deployed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#DeviceDeploymentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeviceDeploymentSummary" + } + }, + "com.amazonaws.sagemaker#DeviceDeploymentSummary": { + "type": "structure", + "members": { + "EdgeDeploymentPlanArn": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stage in the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "DeployedStageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the deployed stage.
" + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the fleet to which the device belongs to.
" + } + }, + "DeviceName": { + "target": "com.amazonaws.sagemaker#DeviceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the device.
", + "smithy.api#required": {} + } + }, + "DeviceArn": { + "target": "com.amazonaws.sagemaker#DeviceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the device.
", + "smithy.api#required": {} + } + }, + "DeviceDeploymentStatus": { + "target": "com.amazonaws.sagemaker#DeviceDeploymentStatus", + "traits": { + "smithy.api#documentation": "The deployment status of the device.
" + } + }, + "DeviceDeploymentStatusMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The detailed error message for the deployoment status result.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceDescription", + "traits": { + "smithy.api#documentation": "The description of the device.
" + } + }, + "DeploymentStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the deployment on the device started.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information summarizing device details and deployment status.
" + } + }, + "com.amazonaws.sagemaker#DeviceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.,;:! ]*$" + } + }, + "com.amazonaws.sagemaker#DeviceFleetArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#DeviceFleetDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 800 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.,;:! ]*$" + } + }, + "com.amazonaws.sagemaker#DeviceFleetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeviceFleetSummary" + } + }, + "com.amazonaws.sagemaker#DeviceFleetSummary": { + "type": "structure", + "members": { + "DeviceFleetArn": { + "target": "com.amazonaws.sagemaker#DeviceFleetArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Amazon Resource Name (ARN) of the device fleet.
", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the device fleet.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp of when the device fleet was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp of when the device fleet was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of the device fleet.
" + } + }, + "com.amazonaws.sagemaker#DeviceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#DeviceNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeviceName" + } + }, + "com.amazonaws.sagemaker#DeviceSelectionConfig": { + "type": "structure", + "members": { + "DeviceSubsetType": { + "target": "com.amazonaws.sagemaker#DeviceSubsetType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Type of device subsets to deploy to the current stage.
", + "smithy.api#required": {} + } + }, + "Percentage": { + "target": "com.amazonaws.sagemaker#Percentage", + "traits": { + "smithy.api#documentation": "Percentage of devices in the fleet to deploy to the current stage.
" + } + }, + "DeviceNames": { + "target": "com.amazonaws.sagemaker#DeviceNames", + "traits": { + "smithy.api#documentation": "List of devices chosen to deploy.
" + } + }, + "DeviceNameContains": { + "target": "com.amazonaws.sagemaker#DeviceName", + "traits": { + "smithy.api#documentation": "A filter to select devices with names containing this name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the configurations of selected devices.
" + } + }, + "com.amazonaws.sagemaker#DeviceStats": { + "type": "structure", + "members": { + "ConnectedDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of devices connected with a heartbeat.
", + "smithy.api#required": {} + } + }, + "RegisteredDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of registered devices.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Status of devices.
" + } + }, + "com.amazonaws.sagemaker#DeviceSubsetType": { + "type": "enum", + "members": { + "Percentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE" + } + }, + "Selection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTION" + } + }, + "NameContains": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMECONTAINS" + } + } + } + }, + "com.amazonaws.sagemaker#DeviceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DeviceSummary" + } + }, + "com.amazonaws.sagemaker#DeviceSummary": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the device.
", + "smithy.api#required": {} + } + }, + "DeviceArn": { + "target": "com.amazonaws.sagemaker#DeviceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Amazon Resource Name (ARN) of the device.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceDescription", + "traits": { + "smithy.api#documentation": "A description of the device.
" + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the fleet the device belongs to.
" + } + }, + "IotThingName": { + "target": "com.amazonaws.sagemaker#ThingName", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
" + } + }, + "RegistrationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last registration or de-reregistration.
" + } + }, + "LatestHeartbeat": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last heartbeat received from the device.
" + } + }, + "Models": { + "target": "com.amazonaws.sagemaker#EdgeModelSummaries", + "traits": { + "smithy.api#documentation": "Models on the device.
" + } + }, + "AgentVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "Edge Manager agent version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of the device.
" + } + }, + "com.amazonaws.sagemaker#Devices": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Device" + } + }, + "com.amazonaws.sagemaker#Dimension": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.sagemaker#DirectDeploySettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "Describes whether model deployment permissions are enabled or disabled in the Canvas application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The model deployment settings for the SageMaker Canvas application.
\nIn order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM\n execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also\n turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.
Disables using Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.
" + } + }, + "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolioInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolioOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#DisassociateNotebookInstanceLifecycleConfig": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#DisassociateTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DisassociateTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DisassociateTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a trial component from a trial. This doesn't effect other trials the\n component is associated with. Before you can delete a component, you must disassociate the\n component from all trials it is associated with. To associate a trial component with a trial,\n call the AssociateTrialComponent API.
\nTo get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter.\n The list appears in the response under Results.TrialComponent.Parents.
The name of the component to disassociate from the trial.
", + "smithy.api#required": {} + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the trial to disassociate from.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DisassociateTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" + } + }, + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DockerSettings": { + "type": "structure", + "members": { + "EnableDockerAccess": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "Indicates whether the domain can access Docker.
" + } + }, + "VpcOnlyTrustedAccounts": { + "target": "com.amazonaws.sagemaker#VpcOnlyTrustedAccounts", + "traits": { + "smithy.api#documentation": "The list of Amazon Web Services accounts that are trusted when the domain is created in\n VPC-only mode.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of settings that configure the domain's Docker interaction.
" + } + }, + "com.amazonaws.sagemaker#DocumentSchemaVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 14 + }, + "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" + } + }, + "com.amazonaws.sagemaker#Dollars": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#DomainArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/" + } + }, + "com.amazonaws.sagemaker#DomainDetails": { + "type": "structure", + "members": { + "DomainArn": { + "target": "com.amazonaws.sagemaker#DomainArn", + "traits": { + "smithy.api#documentation": "The domain's Amazon Resource Name (ARN).
" + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "The domain ID.
" + } + }, + "DomainName": { + "target": "com.amazonaws.sagemaker#DomainName", + "traits": { + "smithy.api#documentation": "The domain name.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#DomainStatus", + "traits": { + "smithy.api#documentation": "The status.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "The creation time.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "The last modified time.
" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The domain's URL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The domain's details.
" + } + }, + "com.amazonaws.sagemaker#DomainId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^d-(-*[a-z0-9]){1,61}$" + } + }, + "com.amazonaws.sagemaker#DomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#DomainDetails" + } + }, + "com.amazonaws.sagemaker#DomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#DomainSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#DomainSettings": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#DomainSecurityGroupIds", + "traits": { + "smithy.api#documentation": "The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.
A collection of settings that configure the RStudioServerPro Domain-level\n app.
The configuration for attaching a SageMaker AI user profile name to the execution\n role as a sts:SourceIdentity key.
" + } + }, + "DockerSettings": { + "target": "com.amazonaws.sagemaker#DockerSettings", + "traits": { + "smithy.api#documentation": "A collection of settings that configure the domain's Docker interaction.
" + } + }, + "AmazonQSettings": { + "target": "com.amazonaws.sagemaker#AmazonQSettings", + "traits": { + "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain. The\n AuthMode that you use to create the domain must be SSO.
A collection of settings that apply to the SageMaker Domain. These settings\n are specified through the CreateDomain API call.
A collection of RStudioServerPro Domain-level app settings to update. A\n single RStudioServerPro application is created for a domain.
The configuration for attaching a SageMaker AI user profile name to the execution\n role as a sts:SourceIdentity key. This configuration can only be modified if there are no\n apps in the InService or Pending state.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.
A collection of settings that configure the domain's Docker interaction.
" + } + }, + "AmazonQSettings": { + "target": "com.amazonaws.sagemaker#AmazonQSettings", + "traits": { + "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of Domain configuration settings to update.
Represents the drift check bias baselines that can be used when the model monitor is set using the model \n package.
" + } + }, + "Explainability": { + "target": "com.amazonaws.sagemaker#DriftCheckExplainability", + "traits": { + "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set using \n the model package.
" + } + }, + "ModelQuality": { + "target": "com.amazonaws.sagemaker#DriftCheckModelQuality", + "traits": { + "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.
" + } + }, + "ModelDataQuality": { + "target": "com.amazonaws.sagemaker#DriftCheckModelDataQuality", + "traits": { + "smithy.api#documentation": "Represents the drift check model data quality baselines that can be used when the model monitor is set \n using the model package.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model \n package.
" + } + }, + "com.amazonaws.sagemaker#DriftCheckBias": { + "type": "structure", + "members": { + "ConfigFile": { + "target": "com.amazonaws.sagemaker#FileSource", + "traits": { + "smithy.api#documentation": "The bias config file for a model.
" + } + }, + "PreTrainingConstraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The pre-training constraints.
" + } + }, + "PostTrainingConstraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The post-training constraints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is set using the \n model package.
" + } + }, + "com.amazonaws.sagemaker#DriftCheckExplainability": { + "type": "structure", + "members": { + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The drift check explainability constraints.
" + } + }, + "ConfigFile": { + "target": "com.amazonaws.sagemaker#FileSource", + "traits": { + "smithy.api#documentation": "The explainability config file for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set \n using the model package.
" + } + }, + "com.amazonaws.sagemaker#DriftCheckModelDataQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The drift check model data quality statistics.
" + } + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The drift check model data quality constraints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check data quality baselines that can be used when the model monitor is set using \n the model package.
" + } + }, + "com.amazonaws.sagemaker#DriftCheckModelQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The drift check model quality statistics.
" + } + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "The drift check model quality constraints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.
" + } + }, + "com.amazonaws.sagemaker#DynamicScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The recommended minimum capacity to specify for your autoscaling policy.
" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The recommended maximum capacity to specify for your autoscaling policy.
" + } + }, + "ScaleInCooldown": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The recommended scale in cooldown time for your autoscaling policy.
" + } + }, + "ScaleOutCooldown": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The recommended scale out cooldown time for your autoscaling policy.
" + } + }, + "ScalingPolicies": { + "target": "com.amazonaws.sagemaker#ScalingPolicies", + "traits": { + "smithy.api#documentation": "An object of the scaling policies for each metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object with the recommended values for you to specify when creating an autoscaling policy.
" + } + }, + "com.amazonaws.sagemaker#EFSFileSystem": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of your Amazon EFS file system.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A file system, created by you in Amazon EFS, that you assign to a user profile or\n space for an Amazon SageMaker AI Domain. Permitted users can access this file system in\n Amazon SageMaker AI Studio.
" + } + }, + "com.amazonaws.sagemaker#EFSFileSystemConfig": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of your Amazon EFS file system.
", + "smithy.api#required": {} + } + }, + "FileSystemPath": { + "target": "com.amazonaws.sagemaker#FileSystemPath", + "traits": { + "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker AI Studio.\n Permitted users can access only this directory and below.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for assigning a custom Amazon EFS file system to a user profile or\n space for an Amazon SageMaker AI Domain.
" + } + }, + "com.amazonaws.sagemaker#EMRStepMetadata": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The identifier of the EMR cluster.
" + } + }, + "StepId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The identifier of the EMR cluster step.
" + } + }, + "StepName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The name of the EMR cluster step.
" + } + }, + "LogFilePath": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The path to the log file where the cluster step's failure root cause \n is recorded.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configurations and outcomes of an Amazon EMR step execution.
" + } + }, + "com.amazonaws.sagemaker#EbsStorageSettings": { + "type": "structure", + "members": { + "EbsVolumeSizeInGb": { + "target": "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The size of an EBS storage volume for a space.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of EBS storage settings that apply to both private and shared spaces.
" + } + }, + "com.amazonaws.sagemaker#Edge": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.
" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.
" + } + }, + "AssociationType": { + "target": "com.amazonaws.sagemaker#AssociationEdgeType", + "traits": { + "smithy.api#documentation": "The type of the Association(Edge) between the source and destination. For example ContributedTo, \n Produced, or DerivedFrom.
A directed edge connecting two lineage entities.
" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentConfig": { + "type": "structure", + "members": { + "FailureHandlingPolicy": { + "target": "com.amazonaws.sagemaker#FailureHandlingPolicy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Toggle that determines whether to rollback to previous configuration if the current\n deployment fails. By default this is turned on. You may turn this off if you want to\n investigate the errors yourself.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the configuration of a deployment.
" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentModelConfig": { + "type": "structure", + "members": { + "ModelHandle": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name the device application uses to reference this model.
", + "smithy.api#required": {} + } + }, + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The edge packaging job associated with this deployment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the configuration of a model in a deployment.
" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentModelConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentModelConfig" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentPlanArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentPlanSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanSummary" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentPlanSummary": { + "type": "structure", + "members": { + "EdgeDeploymentPlanArn": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the device fleet used for the deployment.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentSuccess": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of edge devices with the successful deployment.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPending": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of edge devices yet to pick up the deployment, or in progress.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentFailed": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of edge devices that failed the deployment.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the edge deployment plan was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the edge deployment plan was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information summarizing an edge deployment plan.
" + } + }, + "com.amazonaws.sagemaker#EdgeDeploymentStatus": { + "type": "structure", + "members": { + "StageStatus": { + "target": "com.amazonaws.sagemaker#StageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The general status of the current stage.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentSuccessInStage": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of edge devices with the successful deployment in the current stage.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentPendingInStage": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of edge devices yet to pick up the deployment in current stage, or in\n progress.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentFailedInStage": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of edge devices that failed the deployment in current stage.
", + "smithy.api#required": {} + } + }, + "EdgeDeploymentStatusMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "A detailed message about deployment status in current stage.
" + } + }, + "EdgeDeploymentStageStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the deployment API started.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information summarizing the deployment stage results.
" + } + }, + "com.amazonaws.sagemaker#EdgeModel": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model.
", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The model version.
", + "smithy.api#required": {} + } + }, + "LatestSampleTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last data sample taken.
" + } + }, + "LatestInference": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last inference that was made.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The model on the edge device.
" + } + }, + "com.amazonaws.sagemaker#EdgeModelStat": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model.
", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The model version.
", + "smithy.api#required": {} + } + }, + "OfflineDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of devices that have this model version and do not have a heart beat.
", + "smithy.api#required": {} + } + }, + "ConnectedDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of devices that have this model version and have a heart beat.
", + "smithy.api#required": {} + } + }, + "ActiveDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of devices that have this model version, a heart beat, and are currently running.
", + "smithy.api#required": {} + } + }, + "SamplingDeviceCount": { + "target": "com.amazonaws.sagemaker#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of devices with this model version and are producing sample data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Status of edge devices with this model.
" + } + }, + "com.amazonaws.sagemaker#EdgeModelStats": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeModelStat" + } + }, + "com.amazonaws.sagemaker#EdgeModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeModelSummary" + } + }, + "com.amazonaws.sagemaker#EdgeModelSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model.
", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of model on edge device.
" + } + }, + "com.amazonaws.sagemaker#EdgeModels": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgeModel" + } + }, + "com.amazonaws.sagemaker#EdgeOutputConfig": { + "type": "structure", + "members": { + "S3OutputLocation": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Simple Storage (S3) bucker URI.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. \n If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.
" + } + }, + "PresetDeploymentType": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentType", + "traits": { + "smithy.api#documentation": "The deployment type SageMaker Edge Manager will create. \n Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
" + } + }, + "PresetDeploymentConfig": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The configuration used to create deployment artifacts. \n Specify configuration options with a JSON string. The available configuration options for each type are:
\n\n ComponentName (optional) - Name of the GreenGrass V2 component. If not specified,\n the default name generated consists of \"SagemakerEdgeManager\" and the name of your SageMaker Edge Manager\n packaging job.
\n ComponentDescription (optional) - Description of the component.
\n ComponentVersion (optional) - The version of the component.
Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a\n major.minor.patch number system. For example, version 1.0.0 represents the first\n major release for a component. For more information, see the semantic version specification.
\n\n PlatformOS (optional) - The name of the operating system for the platform.\n Supported platforms include Windows and Linux.
\n PlatformArchitecture (optional) - The processor architecture for the platform.
Supported architectures Windows include: Windows32_x86, Windows64_x64.
\nSupported architectures for Linux include: Linux x86_64, Linux ARMV8.
\nThe output configuration.
" + } + }, + "com.amazonaws.sagemaker#EdgePackagingJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#EdgePackagingJobStatus": { + "type": "enum", + "members": { + "Starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#EdgePackagingJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobSummary" + } + }, + "com.amazonaws.sagemaker#EdgePackagingJobSummary": { + "type": "structure", + "members": { + "EdgePackagingJobArn": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the edge packaging job.
", + "smithy.api#required": {} + } + }, + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge packaging job.
", + "smithy.api#required": {} + } + }, + "EdgePackagingJobStatus": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the edge packaging job.
", + "smithy.api#required": {} + } + }, + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the SageMaker Neo compilation job.
" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the model.
" + } + }, + "ModelVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "The version of the model.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the job was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the edge packaging job was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of edge packaging job.
" + } + }, + "com.amazonaws.sagemaker#EdgePresetDeploymentArtifact": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#EdgePresetDeploymentOutput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The deployment type created by SageMaker Edge Manager. Currently only \n supports Amazon Web Services IoT Greengrass Version 2 components.
", + "smithy.api#required": {} + } + }, + "Artifact": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentArtifact", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the generated deployable resource.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#EdgePresetDeploymentStatus", + "traits": { + "smithy.api#documentation": "The status of the deployable resource.
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "Returns a message describing the status of the deployed resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output of a SageMaker Edge Manager deployable resource.
" + } + }, + "com.amazonaws.sagemaker#EdgePresetDeploymentStatus": { + "type": "enum", + "members": { + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.sagemaker#EdgePresetDeploymentType": { + "type": "enum", + "members": { + "GreengrassV2Component": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreengrassV2Component" + } + } + } + }, + "com.amazonaws.sagemaker#EdgeVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\ \\_\\.]+$" + } + }, + "com.amazonaws.sagemaker#Edges": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Edge" + } + }, + "com.amazonaws.sagemaker#EfsUid": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.sagemaker#EksClusterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:eks:[a-z0-9\\-]*:[0-9]{12}:cluster\\/[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}$" + } + }, + "com.amazonaws.sagemaker#EmrServerlessComputeConfig": { + "type": "structure", + "members": { + "ExecutionRoleARN": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the IAM role granting the AutoML job V2 the necessary\n permissions access policies to list, connect to, or manage EMR Serverless jobs. For\n detailed information about the required permissions of this role, see \"How to configure\n AutoML to initiate a remote job on EMR Serverless for large datasets\" in Create a regression or classification job for tabular data using the AutoML API\n or Create an AutoML job for time-series forecasting using the API.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in\n other contexts at the moment.
\nSpecifies the compute configuration for the EMR Serverless job.
" + } + }, + "com.amazonaws.sagemaker#EmrServerlessSettings": { + "type": "structure", + "members": { + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services IAM role that is assumed for\n running Amazon EMR Serverless jobs in SageMaker Canvas. This role should have the necessary\n permissions to read and write data attached and a trust relationship with\n EMR Serverless.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "Describes whether Amazon EMR Serverless job capabilities are enabled or disabled in the SageMaker\n Canvas application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for running Amazon EMR Serverless jobs in SageMaker Canvas.
" + } + }, + "com.amazonaws.sagemaker#EmrSettings": { + "type": "structure", + "members": { + "AssumableRoleArns": { + "target": "com.amazonaws.sagemaker#AssumableRoleArns", + "traits": { + "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of\n SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR\n Serverless applications. These roles define the permissions and access policies required\n when performing Amazon EMR-related operations, such as listing, connecting to, or terminating\n Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in\n cross-account access scenarios, where the Amazon EMR resources (clusters or serverless\n applications) are located in a different Amazon Web Services account than the SageMaker\n domain.
" + } + }, + "ExecutionRoleArns": { + "target": "com.amazonaws.sagemaker#ExecutionRoleArns", + "traits": { + "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances\n or job execution environments to access other Amazon Web Services services and resources needed during the \n runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other\n Amazon Web Services services based on the particular workload requirements.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.
" + } + }, + "com.amazonaws.sagemaker#EnableCapture": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnableInfraCheck": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnableIotRoleAlias": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnableRemoteDebug": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolio": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioOutput" + }, + "traits": { + "smithy.api#documentation": "Enables using Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.
" + } + }, + "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#EnableSessionTagChaining": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#EnabledOrDisabled": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#Endpoint": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint.
", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", + "smithy.api#required": {} + } + }, + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The endpoint configuration associated with the endpoint.
", + "smithy.api#required": {} + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "A list of the production variants hosted on the endpoint. Each production variant is a\n model.
" + } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#DataCaptureConfigSummary" + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the endpoint.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the endpoint failed, the reason it failed.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time that the endpoint was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The last time the endpoint was modified.
", + "smithy.api#required": {} + } + }, + "MonitoringSchedules": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleList", + "traits": { + "smithy.api#documentation": "A list of monitoring schedules for the endpoint. For information about model\n monitoring, see Amazon SageMaker Model Monitor.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" + } + }, + "ShadowProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "A list of the shadow variants hosted on the endpoint. Each shadow variant is a model\n in shadow mode with production traffic replicated from the production variant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A hosted endpoint for real-time inference.
" + } + }, + "com.amazonaws.sagemaker#EndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/" + } + }, + "com.amazonaws.sagemaker#EndpointConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/" + } + }, + "com.amazonaws.sagemaker#EndpointConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#EndpointConfigNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#EndpointConfigSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#EndpointConfigStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#EndpointConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint configuration used in the step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for an endpoint configuration step.
" + } + }, + "com.amazonaws.sagemaker#EndpointConfigSummary": { + "type": "structure", + "members": { + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint configuration.
", + "smithy.api#required": {} + } + }, + "EndpointConfigArn": { + "target": "com.amazonaws.sagemaker#EndpointConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint configuration.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the endpoint configuration was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information for an endpoint configuration.
" + } + }, + "com.amazonaws.sagemaker#EndpointConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointConfigSummary" + } + }, + "com.amazonaws.sagemaker#EndpointInfo": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "The name of a customer's endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a customer endpoint that was compared in an Inference Recommender job.
" + } + }, + "com.amazonaws.sagemaker#EndpointInput": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An endpoint in customer's account which has enabled DataCaptureConfig\n enabled.
Path to the filesystem where the endpoint data is available to the container.
", + "smithy.api#required": {} + } + }, + "S3InputMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", + "traits": { + "smithy.api#documentation": "Whether the Pipe or File is used as the input mode for\n transferring data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an\n Amazon S3 key. Defaults to FullyReplicated\n
The attributes of the input data that are the input features.
" + } + }, + "InferenceAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The attribute of the input data that represents the ground truth label.
" + } + }, + "ProbabilityAttribute": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "In a classification problem, the attribute that represents the class probability.
" + } + }, + "ProbabilityThresholdAttribute": { + "target": "com.amazonaws.sagemaker#ProbabilityThresholdAttribute", + "traits": { + "smithy.api#documentation": "The threshold for the class probability to be evaluated as a positive result.
" + } + }, + "StartTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "If specified, monitoring jobs substract this time from the start time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + } + }, + "EndTimeOffset": { + "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", + "traits": { + "smithy.api#documentation": "If specified, monitoring jobs substract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + } + }, + "ExcludeFeaturesAttribute": { + "target": "com.amazonaws.sagemaker#ExcludeFeaturesAttribute", + "traits": { + "smithy.api#documentation": "The attributes of the input data to exclude from the analysis.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input object for the endpoint
" + } + }, + "com.amazonaws.sagemaker#EndpointInputConfiguration": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "The instance types to use for the load test.
" + } + }, + "ServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig" + }, + "InferenceSpecificationName": { + "target": "com.amazonaws.sagemaker#InferenceSpecificationName", + "traits": { + "smithy.api#documentation": "The inference specification name in the model package version.
" + } + }, + "EnvironmentParameterRanges": { + "target": "com.amazonaws.sagemaker#EnvironmentParameterRanges", + "traits": { + "smithy.api#documentation": "The parameter you want to benchmark against.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint configuration for the load test.
" + } + }, + "com.amazonaws.sagemaker#EndpointInputConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointInputConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#EndpointMetadata": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint.
", + "smithy.api#required": {} + } + }, + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#documentation": "The name of the endpoint configuration.
" + } + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#documentation": "\n The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.\n
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "\n If the status of the endpoint is Failed, or the status is InService but update\n operation fails, this provides the reason why it failed.\n
The metadata of the endpoint.
" + } + }, + "com.amazonaws.sagemaker#EndpointName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#EndpointNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#EndpointOutputConfiguration": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint made during a recommendation job.
", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the production variant (deployed model) made during a recommendation job.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "The instance type recommended by Amazon SageMaker Inference Recommender.
" + } + }, + "InitialInstanceCount": { + "target": "com.amazonaws.sagemaker#InitialInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances recommended to launch initially.
" + } + }, + "ServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig" + } + }, + "traits": { + "smithy.api#documentation": "The endpoint configuration made by Inference Recommender during a recommendation job.
" + } + }, + "com.amazonaws.sagemaker#EndpointPerformance": { + "type": "structure", + "members": { + "Metrics": { + "target": "com.amazonaws.sagemaker#InferenceMetrics", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The metrics for an existing endpoint.
", + "smithy.api#required": {} + } + }, + "EndpointInfo": { + "target": "com.amazonaws.sagemaker#EndpointInfo", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The performance results from running an Inference Recommender job on an existing endpoint.
" + } + }, + "com.amazonaws.sagemaker#EndpointPerformances": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointPerformance" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#EndpointSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#EndpointStatus": { + "type": "enum", + "members": { + "OUT_OF_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OutOfService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "ROLLING_BACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollingBack" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "UPDATE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRollbackFailed" + } + } + } + }, + "com.amazonaws.sagemaker#EndpointStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint in the step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for an endpoint step.
" + } + }, + "com.amazonaws.sagemaker#EndpointSummary": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint.
", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the endpoint was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the endpoint was last modified.
", + "smithy.api#required": {} + } + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about the\n failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
To get a list of endpoints with a specified status, use the StatusEquals\n filter with a call to ListEndpoints.
Provides summary information for an endpoint.
" + } + }, + "com.amazonaws.sagemaker#EndpointSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointSummary" + } + }, + "com.amazonaws.sagemaker#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointInfo" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#EntityDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" + } + }, + "com.amazonaws.sagemaker#EntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#EnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.sagemaker#EnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#EnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#EnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#EnvironmentParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The environment key suggested by the Amazon SageMaker Inference Recommender.
", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value type suggested by the Amazon SageMaker Inference Recommender.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value suggested by the Amazon SageMaker Inference Recommender.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.
" + } + }, + "com.amazonaws.sagemaker#EnvironmentParameterRanges": { + "type": "structure", + "members": { + "CategoricalParameterRanges": { + "target": "com.amazonaws.sagemaker#CategoricalParameters", + "traits": { + "smithy.api#documentation": "Specified a list of parameters for each category.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the range of environment parameters
" + } + }, + "com.amazonaws.sagemaker#EnvironmentParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EnvironmentParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#EnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#ErrorInfo": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The error code for an invalid or failed operation.
" + } + }, + "Reason": { + "target": "com.amazonaws.sagemaker#NonEmptyString256", + "traits": { + "smithy.api#documentation": "The failure reason for the operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This is an error field object that contains the error code and the reason for an operation failure.
" + } + }, + "com.amazonaws.sagemaker#ExcludeFeaturesAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ExecutionRoleArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RoleArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#ExecutionRoleIdentityConfig": { + "type": "enum", + "members": { + "USER_PROFILE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_PROFILE_NAME" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#ExecutionStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "COMPLETED_WITH_VIOLATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CompletedWithViolations" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#ExitMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#Experiment": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment.
" + } + }, + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.
The description of the experiment.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the experiment was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who created the experiment.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the experiment was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "The list of tags that are associated with the experiment. You can use Search API to search on the tags.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of an experiment as returned by the Search API.
" + } + }, + "com.amazonaws.sagemaker#ExperimentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/" + } + }, + "com.amazonaws.sagemaker#ExperimentConfig": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of an existing experiment to associate with the trial component.
" + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of an existing trial to associate the trial component with. If not specified, a\n new trial is created.
" + } + }, + "TrialComponentDisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The display name for the trial component. If this key isn't specified, the display name is\n the trial component name.
" + } + }, + "RunName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment run to associate with the trial component.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Associates a SageMaker job as a trial component with an experiment and trial. Specified when\n you call the following APIs:
\n\n CreateProcessingJob\n
\n\n CreateTrainingJob\n
\n\n CreateTransformJob\n
\nThe Amazon Resource Name (ARN) of the source.
", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#SourceType", + "traits": { + "smithy.api#documentation": "The source type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The source of the experiment.
" + } + }, + "com.amazonaws.sagemaker#ExperimentSourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:" + } + }, + "com.amazonaws.sagemaker#ExperimentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ExperimentSummary" + } + }, + "com.amazonaws.sagemaker#ExperimentSummary": { + "type": "structure", + "members": { + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" + } + }, + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.
When the experiment was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the experiment was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the properties of an experiment. To get the complete set of properties, call\n the DescribeExperiment API and provide the\n ExperimentName.
The explainability report for a model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains explainability metrics for a model.
" + } + }, + "com.amazonaws.sagemaker#ExplainabilityLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ExplainerConfig": { + "type": "structure", + "members": { + "ClarifyExplainerConfig": { + "target": "com.amazonaws.sagemaker#ClarifyExplainerConfig", + "traits": { + "smithy.api#documentation": "A member of ExplainerConfig that contains configuration parameters for\n the SageMaker Clarify explainer.
A parameter to activate explainers.
" + } + }, + "com.amazonaws.sagemaker#FSxLustreFileSystem": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Amazon FSx for Lustre file system ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A custom file system in Amazon FSx for Lustre.
" + } + }, + "com.amazonaws.sagemaker#FSxLustreFileSystemConfig": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.
", + "smithy.api#required": {} + } + }, + "FileSystemPath": { + "target": "com.amazonaws.sagemaker#FileSystemPath", + "traits": { + "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted\n users can access only this directory and below.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an\n Amazon SageMaker Domain.
" + } + }, + "com.amazonaws.sagemaker#FailStepMetadata": { + "type": "structure", + "members": { + "ErrorMessage": { + "target": "com.amazonaws.sagemaker#String3072", + "traits": { + "smithy.api#documentation": "A message that you define and then is processed and rendered by \n the Fail step when the error occurs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The container for the metadata for Fail step.
" + } + }, + "com.amazonaws.sagemaker#FailureHandlingPolicy": { + "type": "enum", + "members": { + "RollbackOnFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_ON_FAILURE" + } + }, + "DoNothing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOTHING" + } + } + } + }, + "com.amazonaws.sagemaker#FailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#FairShare": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#FairShareWeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#FeatureAdditions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#FeatureDefinition": { + "type": "structure", + "members": { + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of a feature. The type must be a string. FeatureName cannot be any\n of the following: is_deleted, write_time,\n api_invocation_time.
The name:
\nMust start with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe value type of a feature. Valid values are Integral, Fractional, or String.
", + "smithy.api#required": {} + } + }, + "CollectionType": { + "target": "com.amazonaws.sagemaker#CollectionType", + "traits": { + "smithy.api#documentation": "A grouping of elements where each element within the collection must have the same\n feature type (String, Integral, or\n Fractional).
\n List: An ordered collection of elements.
\n Set: An unordered collection of unique elements.
\n Vector: A specialized list that represents a fixed-size array of\n elements. The vector dimension is determined by you. Must have elements with\n fractional feature types.
Configuration for your collection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of features. You must include FeatureName and\n FeatureType. Valid feature FeatureTypes are\n Integral, Fractional and String.
The Amazon Resource Name (ARN) of a FeatureGroup.
The name of the FeatureGroup.
The name of the Feature whose value uniquely identifies a\n Record defined in the FeatureGroup\n FeatureDefinitions.
The name of the feature that stores the EventTime of a Record in a\n FeatureGroup.
A EventTime is point in time when a new event occurs that corresponds to\n the creation or update of a Record in FeatureGroup. All\n Records in the FeatureGroup must have a corresponding\n EventTime.
A list of Features. Each Feature must include a\n FeatureName and a FeatureType.
Valid FeatureTypes are Integral, Fractional and\n String.
\n FeatureNames cannot be any of the following: is_deleted,\n write_time, api_invocation_time.
You can create up to 2,500 FeatureDefinitions per\n FeatureGroup.
The time a FeatureGroup was created.
A timestamp indicating the last time you updated the feature group.
" + } + }, + "OnlineStoreConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreConfig" + }, + "OfflineStoreConfig": { + "target": "com.amazonaws.sagemaker#OfflineStoreConfig" + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to create the feature\n group.
" + } + }, + "FeatureGroupStatus": { + "target": "com.amazonaws.sagemaker#FeatureGroupStatus", + "traits": { + "smithy.api#documentation": "A FeatureGroup status.
A value that indicates whether the feature group was updated successfully.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The reason that the FeatureGroup failed to be replicated in the\n OfflineStore. This is failure may be due to a failure to create a\n FeatureGroup in or delete a FeatureGroup from the\n OfflineStore.
A free form description of a FeatureGroup.
Tags used to define a FeatureGroup.
Amazon SageMaker Feature Store stores features in a collection called Feature Group. A\n Feature Group can be visualized as a table which has rows, with a unique identifier for\n each row where each column in the table is a feature. In principle, a Feature Group is\n composed of features and values per features.
" + } + }, + "com.amazonaws.sagemaker#FeatureGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/" + } + }, + "com.amazonaws.sagemaker#FeatureGroupMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#FeatureGroupNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})$" + } + }, + "com.amazonaws.sagemaker#FeatureGroupSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "FEATURE_GROUP_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureGroupStatus" + } + }, + "OFFLINE_STORE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OfflineStoreStatus" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#FeatureGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureGroupSummary" + } + }, + "com.amazonaws.sagemaker#FeatureGroupSummary": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of FeatureGroup.
Unique identifier for the FeatureGroup.
A timestamp indicating the time of creation time of the\n FeatureGroup.
The status of a FeatureGroup. The status can be any of the following:\n Creating, Created, CreateFail,\n Deleting or DetailFail.
Notifies you if replicating data into the OfflineStore has failed. Returns\n either: Active or Blocked.
The name, ARN, CreationTime, FeatureGroup values,\n LastUpdatedTime and EnableOnlineStorage status of a\n FeatureGroup.
The Amazon Resource Number (ARN) of the feature group.
" + } + }, + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#documentation": "The name of the feature group containing the feature.
" + } + }, + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#documentation": "The name of feature.
" + } + }, + "FeatureType": { + "target": "com.amazonaws.sagemaker#FeatureType", + "traits": { + "smithy.api#documentation": "The data type of the feature.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A timestamp indicating when the feature was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A timestamp indicating when the feature was last modified.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#FeatureDescription", + "traits": { + "smithy.api#documentation": "An optional description that you specify to better describe the feature.
" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#FeatureParameters", + "traits": { + "smithy.api#documentation": "Optional key-value pairs that you specify to better describe the feature.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata for a feature. It can either be metadata that you specify, or metadata that\n is updated automatically.
" + } + }, + "com.amazonaws.sagemaker#FeatureName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#FeatureParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#FeatureParameterKey", + "traits": { + "smithy.api#documentation": "A key that must contain a value to describe the feature.
" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#FeatureParameterValue", + "traits": { + "smithy.api#documentation": "The value that belongs to a key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A key-value pair that you specify to describe the feature.
" + } + }, + "com.amazonaws.sagemaker#FeatureParameterAdditions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#FeatureParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$" + } + }, + "com.amazonaws.sagemaker#FeatureParameterRemovals": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureParameterKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#FeatureParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$" + } + }, + "com.amazonaws.sagemaker#FeatureParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FeatureParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#FeatureStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#FeatureType": { + "type": "enum", + "members": { + "INTEGRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Integral" + } + }, + "FRACTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Fractional" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + } + } + }, + "com.amazonaws.sagemaker#FileSource": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "The type of content stored in the file source.
" + } + }, + "ContentDigest": { + "target": "com.amazonaws.sagemaker#ContentDigest", + "traits": { + "smithy.api#documentation": "The digest of the file source.
" + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 URI for the file source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details regarding the file source.
" + } + }, + "com.amazonaws.sagemaker#FileSystemAccessMode": { + "type": "enum", + "members": { + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rw" + } + }, + "RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ro" + } + } + } + }, + "com.amazonaws.sagemaker#FileSystemConfig": { + "type": "structure", + "members": { + "MountPath": { + "target": "com.amazonaws.sagemaker#MountPath", + "traits": { + "smithy.api#documentation": "The path within the image to mount the user's EFS home directory. The directory\n should be empty. If not specified, defaults to /home/sagemaker-user.
" + } + }, + "DefaultUid": { + "target": "com.amazonaws.sagemaker#DefaultUid", + "traits": { + "smithy.api#documentation": "The default POSIX user ID (UID). If not specified, defaults to 1000.
The default POSIX group ID (GID). If not specified, defaults to 100.
The Amazon Elastic File System storage configuration for a SageMaker AI image.
" + } + }, + "com.amazonaws.sagemaker#FileSystemDataSource": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The file system id.
", + "smithy.api#required": {} + } + }, + "FileSystemAccessMode": { + "target": "com.amazonaws.sagemaker#FileSystemAccessMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The access mode of the mount of the directory associated with the channel. A directory\n can be mounted either in ro (read-only) or rw (read-write)\n mode.
The file system type.
", + "smithy.api#required": {} + } + }, + "DirectoryPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The full path to the directory to associate with the channel.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a file system data source for a channel.
" + } + }, + "com.amazonaws.sagemaker#FileSystemId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 21 + }, + "smithy.api#pattern": "^(fs-[0-9a-f]{8,})$" + } + }, + "com.amazonaws.sagemaker#FileSystemPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\/\\S*$" + } + }, + "com.amazonaws.sagemaker#FileSystemType": { + "type": "enum", + "members": { + "EFS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFS" + } + }, + "FSXLUSTRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FSxLustre" + } + } + } + }, + "com.amazonaws.sagemaker#FillingTransformationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#FillingType" + }, + "value": { + "target": "com.amazonaws.sagemaker#FillingTransformationValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.sagemaker#FillingTransformationValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-]+$" + } + }, + "com.amazonaws.sagemaker#FillingTransformations": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TransformationAttributeName" + }, + "value": { + "target": "com.amazonaws.sagemaker#FillingTransformationMap" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#FillingType": { + "type": "enum", + "members": { + "Frontfill": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "frontfill" + } + }, + "Middlefill": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "middlefill" + } + }, + "Backfill": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "backfill" + } + }, + "Futurefill": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "futurefill" + } + }, + "FrontfillValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "frontfill_value" + } + }, + "MiddlefillValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "middlefill_value" + } + }, + "BackfillValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "backfill_value" + } + }, + "FuturefillValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "futurefill_value" + } + } + } + }, + "com.amazonaws.sagemaker#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ResourcePropertyName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A resource property name. For example, TrainingJobName. For\n valid property names, see SearchRecord.\n You must specify a valid property for the resource.
A Boolean binary operator that is used to evaluate the filter. The operator field\n contains one of the following values:
\nThe value of Name equals Value.
The value of Name doesn't equal Value.
The Name property exists.
The Name property does not exist.
The value of Name is greater than Value.\n Not supported for text properties.
The value of Name is greater than or equal to Value.\n Not supported for text properties.
The value of Name is less than Value.\n Not supported for text properties.
The value of Name is less than or equal to Value.\n Not supported for text properties.
The value of Name is one of the comma delimited strings in\n Value. Only supported for text properties.
The value of Name contains the string Value.\n Only supported for text properties.
A SearchExpression can include the Contains operator\n multiple times when the value of Name is one of the following:
\n Experiment.DisplayName\n
\n Experiment.ExperimentName\n
\n Experiment.Tags\n
\n Trial.DisplayName\n
\n Trial.TrialName\n
\n Trial.Tags\n
\n TrialComponent.DisplayName\n
\n TrialComponent.TrialComponentName\n
\n TrialComponent.Tags\n
\n TrialComponent.InputArtifacts\n
\n TrialComponent.OutputArtifacts\n
A SearchExpression can include only one Contains operator\n for all other values of Name. In these cases, if you include multiple\n Contains operators in the SearchExpression, the result is\n the following error message: \"'CONTAINS' operator usage limit of 1\n exceeded.\"
A value used with Name and Operator to determine which\n resources satisfy the filter's condition. For numerical properties, Value\n must be an integer or floating-point decimal. For timestamp properties,\n Value must be an ISO 8601 date-time string of the following format:\n YYYY-mm-dd'T'HH:MM:SS.
A conditional statement for a search expression that includes a resource property, a\n Boolean operator, and a value. Resources that match the statement are returned in the\n results from the Search API.
\nIf you specify a Value, but not an Operator, SageMaker uses the\n equals operator.
In search, there are several property types:
\nTo define a metric filter, enter a value using the form\n \"Metrics., where \"accuracy\" metric greater than\n \"0.9\":
\n {\n
\n \"Name\": \"Metrics.accuracy\",\n
\n \"Operator\": \"GreaterThan\",\n
\n \"Value\": \"0.9\"\n
\n }\n
To define a hyperparameter filter, enter a value with the form\n \"HyperParameters.. Decimal hyperparameter\n values are treated as a decimal in a comparison if the specified\n Value is also a decimal value. If the specified\n Value is an integer, the decimal hyperparameter values are\n treated as integers. For example, the following filter is satisfied by\n training jobs with a \"learning_rate\" hyperparameter that is\n less than \"0.5\":
\n {\n
\n \"Name\": \"HyperParameters.learning_rate\",\n
\n \"Operator\": \"LessThan\",\n
\n \"Value\": \"0.5\"\n
\n }\n
To define a tag filter, enter a value with the form\n Tags..
The type of metric with the best result.
" + } + }, + "MetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the metric with the best result. For a description of the possible objective\n metrics, see AutoMLJobObjective$MetricName.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#MetricValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value of the metric with the best result.
", + "smithy.api#required": {} + } + }, + "StandardMetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", + "traits": { + "smithy.api#documentation": "The name of the standard metric. For a description of the standard metrics, see Autopilot\n candidate metrics.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The best candidate result from an AutoML training job.
" + } + }, + "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", + "traits": { + "smithy.api#documentation": "Select if you want to minimize or maximize the objective metric during hyperparameter\n tuning.
" + } + }, + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the objective metric. For SageMaker built-in algorithms, metrics are defined\n per algorithm. See the metrics for XGBoost as an\n example. You can also use a custom algorithm for training and define your own metrics.\n For more information, see Define metrics and environment variables.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#MetricValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value of the objective metric.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Shows the latest objective metric emitted by a training job that was launched by a\n hyperparameter tuning job. You define the objective metric in the\n HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
The Amazon S3 path where the object containing human output will be made available.
\nTo learn more about the format of Amazon A2I output data, see Amazon A2I\n Output Data.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Key Management Service (KMS) key ID for server-side encryption.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about where human output will be stored.
" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FlowDefinitionSummary" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionSummary": { + "type": "structure", + "members": { + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the flow definition.
", + "smithy.api#required": {} + } + }, + "FlowDefinitionArn": { + "target": "com.amazonaws.sagemaker#FlowDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow definition.
", + "smithy.api#required": {} + } + }, + "FlowDefinitionStatus": { + "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the flow definition. Valid values:
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The timestamp when SageMaker created the flow definition.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
Contains summary information about the flow definition.
" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskAvailabilityLifetimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskKeyword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+( [A-Za-z0-9]+)*$" + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskKeywords": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskKeyword" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskTimeLimitInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30 + } + } + }, + "com.amazonaws.sagemaker#FlowDefinitionTaskTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$" + } + }, + "com.amazonaws.sagemaker#ForecastFrequency": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$" + } + }, + "com.amazonaws.sagemaker#ForecastHorizon": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ForecastQuantile": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 4 + }, + "smithy.api#pattern": "^(^p[1-9]\\d?$)$" + } + }, + "com.amazonaws.sagemaker#ForecastQuantiles": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ForecastQuantile" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Framework": { + "type": "enum", + "members": { + "TENSORFLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TENSORFLOW" + } + }, + "KERAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KERAS" + } + }, + "MXNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MXNET" + } + }, + "ONNX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONNX" + } + }, + "PYTORCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTORCH" + } + }, + "XGBOOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XGBOOST" + } + }, + "TFLITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TFLITE" + } + }, + "DARKNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DARKNET" + } + }, + "SKLEARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKLEARN" + } + } + } + }, + "com.amazonaws.sagemaker#FrameworkVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 10 + }, + "smithy.api#pattern": "^[0-9]\\.[A-Za-z0-9.]+$" + } + }, + "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#GenerativeAiSettings": { + "type": "structure", + "members": { + "AmazonBedrockRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in\n Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that\n establishes bedrock.amazonaws.com as a service principal.
The generative AI settings for the SageMaker Canvas application.
\nConfigure these settings for Canvas users starting chats with generative AI foundation models.\n For more information, see \n Use generative AI with foundation models.
" + } + }, + "com.amazonaws.sagemaker#GetDeviceFleetReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetDeviceFleetReportRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetDeviceFleetReportResponse" + }, + "traits": { + "smithy.api#documentation": "Describes a fleet.
" + } + }, + "com.amazonaws.sagemaker#GetDeviceFleetReportRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetDeviceFleetReportResponse": { + "type": "structure", + "members": { + "DeviceFleetArn": { + "target": "com.amazonaws.sagemaker#DeviceFleetArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the device.
", + "smithy.api#required": {} + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#documentation": "The output configuration for storing sample data collected by the fleet.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceFleetDescription", + "traits": { + "smithy.api#documentation": "Description of the fleet.
" + } + }, + "ReportGenerated": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp of when the report was generated.
" + } + }, + "DeviceStats": { + "target": "com.amazonaws.sagemaker#DeviceStats", + "traits": { + "smithy.api#documentation": "Status of devices.
" + } + }, + "AgentVersions": { + "target": "com.amazonaws.sagemaker#AgentVersions", + "traits": { + "smithy.api#documentation": "The versions of Edge Manager agent deployed on the fleet.
" + } + }, + "ModelStats": { + "target": "com.amazonaws.sagemaker#EdgeModelStats", + "traits": { + "smithy.api#documentation": "Status of model on device.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetLineageGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetLineageGroupPolicyRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetLineageGroupPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "The resource policy for the lineage group.
" + } + }, + "com.amazonaws.sagemaker#GetLineageGroupPolicyRequest": { + "type": "structure", + "members": { + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#LineageGroupNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the lineage group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetLineageGroupPolicyResponse": { + "type": "structure", + "members": { + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.sagemaker#ResourcePolicyString", + "traits": { + "smithy.api#documentation": "The resource policy that gives access to the lineage group in another account.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetModelPackageGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicyInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicyOutput" + }, + "traits": { + "smithy.api#documentation": "Gets a resource policy that manages access for a model group. For information about\n resource policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and\n Access Management User Guide..
" + } + }, + "com.amazonaws.sagemaker#GetModelPackageGroupPolicyInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model group for which to get the resource policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetModelPackageGroupPolicyOutput": { + "type": "structure", + "members": { + "ResourcePolicy": { + "target": "com.amazonaws.sagemaker#PolicyString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The resource policy for the model group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusOutput" + }, + "traits": { + "smithy.api#documentation": "Gets the status of Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.
" + } + }, + "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusOutput": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#SagemakerServicecatalogStatus", + "traits": { + "smithy.api#documentation": "Whether Service Catalog is enabled or disabled in SageMaker.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetScalingConfigurationRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies\n that you can apply to your SageMaker endpoint.
" + } + }, + "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationRequest": { + "type": "structure", + "members": { + "InferenceRecommendationsJobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of a previously completed Inference Recommender job.
", + "smithy.api#required": {} + } + }, + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The recommendation ID of a previously completed inference recommendation. This ID should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the EndpointName field.
The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the RecommendationId field.
The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.
" + } + }, + "ScalingPolicyObjective": { + "target": "com.amazonaws.sagemaker#ScalingPolicyObjective", + "traits": { + "smithy.api#documentation": "An object where you specify the anticipated traffic pattern for an endpoint.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationResponse": { + "type": "structure", + "members": { + "InferenceRecommendationsJobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#documentation": "The name of a previously completed Inference Recommender job.
" + } + }, + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The recommendation ID of a previously completed inference recommendation.
" + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "The name of an endpoint benchmarked during a previously completed Inference Recommender job.
" + } + }, + "TargetCpuUtilizationPerCore": { + "target": "com.amazonaws.sagemaker#UtilizationPercentagePerCore", + "traits": { + "smithy.api#documentation": "The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.
" + } + }, + "ScalingPolicyObjective": { + "target": "com.amazonaws.sagemaker#ScalingPolicyObjective", + "traits": { + "smithy.api#documentation": "An object representing the anticipated traffic pattern for an endpoint that you specified in the request.
" + } + }, + "Metric": { + "target": "com.amazonaws.sagemaker#ScalingPolicyMetric", + "traits": { + "smithy.api#documentation": "An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.
" + } + }, + "DynamicScalingConfiguration": { + "target": "com.amazonaws.sagemaker#DynamicScalingConfiguration", + "traits": { + "smithy.api#documentation": "An object with the recommended values for you to specify when creating an autoscaling policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#GetSearchSuggestions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetSearchSuggestionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetSearchSuggestionsResponse" + }, + "traits": { + "smithy.api#documentation": "An auto-complete API for the search functionality in the SageMaker console. It returns\n suggestions of possible matches for the property name to use in Search\n queries. Provides suggestions for HyperParameters, Tags, and\n Metrics.
The name of the SageMaker resource to search for.
", + "smithy.api#required": {} + } + }, + "SuggestionQuery": { + "target": "com.amazonaws.sagemaker#SuggestionQuery", + "traits": { + "smithy.api#documentation": "Limits the property names that are included in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetSearchSuggestionsResponse": { + "type": "structure", + "members": { + "PropertyNameSuggestions": { + "target": "com.amazonaws.sagemaker#PropertyNameSuggestionList", + "traits": { + "smithy.api#documentation": "A list of property names for a Resource that match a\n SuggestionQuery.
The URL where the Git repository is located.
", + "smithy.api#required": {} + } + }, + "Branch": { + "target": "com.amazonaws.sagemaker#Branch", + "traits": { + "smithy.api#documentation": "The default branch for the Git repository.
" + } + }, + "SecretArn": { + "target": "com.amazonaws.sagemaker#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:
\n {\"username\": UserName, \"password\":\n Password}\n
Specifies configuration details for a Git repository in your Amazon Web Services\n account.
" + } + }, + "com.amazonaws.sagemaker#GitConfigForUpdate": { + "type": "structure", + "members": { + "SecretArn": { + "target": "com.amazonaws.sagemaker#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:
\n {\"username\": UserName, \"password\":\n Password}\n
Specifies configuration details for a Git repository when the repository is\n updated.
" + } + }, + "com.amazonaws.sagemaker#GitConfigUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 1024 + }, + "smithy.api#pattern": "^https://([^/]+)/?.{3,1016}$" + } + }, + "com.amazonaws.sagemaker#Group": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" + } + }, + "com.amazonaws.sagemaker#GroupingAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#GroupingAttributeNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#GroupingAttributeName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Groups": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Group" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#HiddenAppTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppType" + } + }, + "com.amazonaws.sagemaker#HiddenInstanceTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppInstanceType" + } + }, + "com.amazonaws.sagemaker#HiddenMlToolsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MlTools" + } + }, + "com.amazonaws.sagemaker#HiddenSageMakerImage": { + "type": "structure", + "members": { + "SageMakerImageName": { + "target": "com.amazonaws.sagemaker#SageMakerImageName", + "traits": { + "smithy.api#documentation": "The SageMaker image name that you are hiding from the Studio user interface.
" + } + }, + "VersionAliases": { + "target": "com.amazonaws.sagemaker#VersionAliasesList", + "traits": { + "smithy.api#documentation": "The version aliases you are hiding from the Studio user interface.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker\n image name and version aliases.
" + } + }, + "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HiddenSageMakerImage" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#HolidayConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HolidayConfigAttributes" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#HolidayConfigAttributes": { + "type": "structure", + "members": { + "CountryCode": { + "target": "com.amazonaws.sagemaker#CountryCode", + "traits": { + "smithy.api#documentation": "The country code for the holiday calendar.
\nFor the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your\n choice.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stores the holiday featurization attributes applicable to each item of time-series\n datasets during the training of a forecasting model. This allows the model to identify\n patterns associated with specific holidays.
" + } + }, + "com.amazonaws.sagemaker#HookParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ConfigKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#Horovod": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#HubArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentDependency": { + "type": "structure", + "members": { + "DependencyOriginPath": { + "target": "com.amazonaws.sagemaker#DependencyOriginPath", + "traits": { + "smithy.api#documentation": "The hub content dependency origin path.
" + } + }, + "DependencyCopyPath": { + "target": "com.amazonaws.sagemaker#DependencyCopyPath", + "traits": { + "smithy.api#documentation": "The hub content dependency copy path.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.
" + } + }, + "com.amazonaws.sagemaker#HubContentDependencyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubContentDependency" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#HubContentDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65535 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubContentInfo": { + "type": "structure", + "members": { + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub content.
", + "smithy.api#required": {} + } + }, + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub content.
", + "smithy.api#required": {} + } + }, + "SageMakerPublicHubContentArn": { + "target": "com.amazonaws.sagemaker#SageMakerPublicHubContentArn", + "traits": { + "smithy.api#documentation": "The ARN of the public hub content.
" + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the hub content.
", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of hub content.
", + "smithy.api#required": {} + } + }, + "DocumentSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the hub content document schema.
", + "smithy.api#required": {} + } + }, + "HubContentDisplayName": { + "target": "com.amazonaws.sagemaker#HubContentDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the hub content.
" + } + }, + "HubContentDescription": { + "target": "com.amazonaws.sagemaker#HubContentDescription", + "traits": { + "smithy.api#documentation": "A description of the hub content.
" + } + }, + "SupportStatus": { + "target": "com.amazonaws.sagemaker#HubContentSupportStatus", + "traits": { + "smithy.api#documentation": "The support status of the hub content.
" + } + }, + "HubContentSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubContentSearchKeywordList", + "traits": { + "smithy.api#documentation": "The searchable keywords for the hub content.
" + } + }, + "HubContentStatus": { + "target": "com.amazonaws.sagemaker#HubContentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the hub content.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the hub content was created.
", + "smithy.api#required": {} + } + }, + "OriginalCreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the hub content was originally created, before any updates or revisions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about hub content.
" + } + }, + "com.amazonaws.sagemaker#HubContentInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubContentInfo" + } + }, + "com.amazonaws.sagemaker#HubContentMarkdown": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.sagemaker#HubContentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#HubContentSearchKeywordList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubSearchKeyword" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#HubContentSortBy": { + "type": "enum", + "members": { + "HUB_CONTENT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HubContentName" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "HUB_CONTENT_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HubContentStatus" + } + } + } + }, + "com.amazonaws.sagemaker#HubContentStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "IMPORTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Importing" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "IMPORT_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImportFailed" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#HubContentSupportStatus": { + "type": "enum", + "members": { + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Supported" + } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deprecated" + } + } + } + }, + "com.amazonaws.sagemaker#HubContentType": { + "type": "enum", + "members": { + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Model" + } + }, + "NOTEBOOK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Notebook" + } + }, + "MODEL_REFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelReference" + } + } + } + }, + "com.amazonaws.sagemaker#HubContentVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 14 + }, + "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" + } + }, + "com.amazonaws.sagemaker#HubDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HubInfo": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub.
", + "smithy.api#required": {} + } + }, + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hub.
", + "smithy.api#required": {} + } + }, + "HubDisplayName": { + "target": "com.amazonaws.sagemaker#HubDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the hub.
" + } + }, + "HubDescription": { + "target": "com.amazonaws.sagemaker#HubDescription", + "traits": { + "smithy.api#documentation": "A description of the hub.
" + } + }, + "HubSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubSearchKeywordList", + "traits": { + "smithy.api#documentation": "The searchable keywords for the hub.
" + } + }, + "HubStatus": { + "target": "com.amazonaws.sagemaker#HubStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the hub.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the hub was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the hub was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a hub.
" + } + }, + "com.amazonaws.sagemaker#HubInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubInfo" + } + }, + "com.amazonaws.sagemaker#HubName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#HubNameOrArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:(\\d{12}|aws):hub\\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#HubS3StorageConfig": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3OutputPath", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket prefix for hosting hub content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 storage configuration of a hub.
" + } + }, + "com.amazonaws.sagemaker#HubSearchKeyword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[^A-Z]*$" + } + }, + "com.amazonaws.sagemaker#HubSearchKeywordList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HubSearchKeyword" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#HubSortBy": { + "type": "enum", + "members": { + "HUB_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HubName" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "HUB_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HubStatus" + } + }, + "ACCOUNT_ID_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccountIdOwner" + } + } + } + }, + "com.amazonaws.sagemaker#HubStatus": { + "type": "enum", + "members": { + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#HumanLoopActivationConditionsConfig": { + "type": "structure", + "members": { + "HumanLoopActivationConditions": { + "target": "com.amazonaws.sagemaker#SynthesizedJsonHumanLoopActivationConditions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. \n The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see \n JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI \n in the Amazon SageMaker Developer Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required\n format of activation conditions.
" + } + }, + "com.amazonaws.sagemaker#HumanLoopActivationConfig": { + "type": "structure", + "members": { + "HumanLoopActivationConditionsConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopActivationConditionsConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Container structure for defining under what conditions SageMaker creates a human\n loop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.
Amazon Resource Name (ARN) of a team of workers. To learn more about the types of\n workforces and work teams you can create and use with Amazon A2I, see Create\n and Manage Workforces.
", + "smithy.api#required": {} + } + }, + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human task user interface.
\nYou can use standard HTML and Crowd HTML Elements to create a custom worker task\n template. You use this template to create a human task UI.
\nTo learn how to create a custom HTML template, see Create Custom Worker\n Task Template.
\nTo learn how to create a human task UI, which is a worker task template that can be used\n in a flow definition, see Create and Delete a Worker Task Templates.
", + "smithy.api#required": {} + } + }, + "TaskTitle": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTitle", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A title for the human worker task.
", + "smithy.api#required": {} + } + }, + "TaskDescription": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A description for the human worker task.
", + "smithy.api#required": {} + } + }, + "TaskCount": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of distinct workers who will perform the same task on each object.\n For example, if TaskCount is set to 3 for an image classification \n labeling job, three workers will classify each input image. \n Increasing TaskCount can improve label accuracy.
The length of time that a task remains available for review by human workers.
" + } + }, + "TaskTimeLimitInSeconds": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTimeLimitInSeconds", + "traits": { + "smithy.api#documentation": "The amount of time that a worker has to complete a task. The default value is 3,600\n seconds (1 hour).
" + } + }, + "TaskKeywords": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskKeywords", + "traits": { + "smithy.api#documentation": "Keywords used to describe the task so that workers can discover the task.
" + } + }, + "PublicWorkforceTaskPrice": { + "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice" + } + }, + "traits": { + "smithy.api#documentation": "Describes the work to be performed by human workers.
" + } + }, + "com.amazonaws.sagemaker#HumanLoopRequestSource": { + "type": "structure", + "members": { + "AwsManagedHumanLoopRequestSource": { + "target": "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. \n The default field settings and JSON parsing rules are different based on the integration source. Valid values:
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Container for configuring the source of human task requests.
" + } + }, + "com.amazonaws.sagemaker#HumanTaskConfig": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.
", + "smithy.api#required": {} + } + }, + "UiConfig": { + "target": "com.amazonaws.sagemaker#UiConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the user interface that workers use to complete the labeling\n task.
", + "smithy.api#required": {} + } + }, + "PreHumanTaskLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.
\nFor built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.
\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n
\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n
\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n
\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n
\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n
\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n
\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n
\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n
\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n
\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n
\n 3D Point Cloud Modalities\n
\nUse the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.
\n\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n
\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n
\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n
\n Use the following ARNs for Label Verification and Adjustment Jobs\n
\nUse label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .
\n\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox\n
\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n
\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n
\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n
\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n
\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n
\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
Keywords used to describe the task so that workers on Amazon Mechanical Turk can\n discover the task.
" + } + }, + "TaskTitle": { + "target": "com.amazonaws.sagemaker#TaskTitle", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A title for the task for your human workers.
", + "smithy.api#required": {} + } + }, + "TaskDescription": { + "target": "com.amazonaws.sagemaker#TaskDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A description of the task for your human workers.
", + "smithy.api#required": {} + } + }, + "NumberOfHumanWorkersPerDataObject": { + "target": "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of human workers that will label an object.
", + "smithy.api#required": {} + } + }, + "TaskTimeLimitInSeconds": { + "target": "com.amazonaws.sagemaker#TaskTimeLimitInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The amount of time that a worker has to complete a task.
\nIf you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).
\nIf you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:
\nFor image and \n text labeling jobs,\n the maximum is 8 hours (28,800 seconds).
\nFor 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
\nThe length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.
\nIf you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds).\n The default is 6 hours (21,600 seconds).
\nIf you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
\nDefines the maximum number of data objects that can be labeled by human workers at the\n same time. Also referred to as batch size. Each object may have more than one worker at one time.\n The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.
" + } + }, + "AnnotationConsolidationConfig": { + "target": "com.amazonaws.sagemaker#AnnotationConsolidationConfig", + "traits": { + "smithy.api#documentation": "Configures how labels are consolidated across human workers.
" + } + }, + "PublicWorkforceTaskPrice": { + "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice", + "traits": { + "smithy.api#documentation": "The price that you pay for each task performed by an Amazon Mechanical Turk worker.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information required for human workers to complete a labeling task.
" + } + }, + "com.amazonaws.sagemaker#HumanTaskUiArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:human-task-ui/" + } + }, + "com.amazonaws.sagemaker#HumanTaskUiName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9])*$" + } + }, + "com.amazonaws.sagemaker#HumanTaskUiStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#HumanTaskUiSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HumanTaskUiSummary" + } + }, + "com.amazonaws.sagemaker#HumanTaskUiSummary": { + "type": "structure", + "members": { + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the human task user interface.
", + "smithy.api#required": {} + } + }, + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human task user interface.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp when SageMaker created the human task user interface.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Container for human task user interface information.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification": { + "type": "structure", + "members": { + "TrainingImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#documentation": " The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.
The name of the resource algorithm to use for the hyperparameter tuning job. If you\n specify a value for this parameter, do not specify a value for\n TrainingImage.
An array of MetricDefinition objects that specify the\n metrics\n that the algorithm emits.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies\n which\n training algorithm to use for training jobs that a hyperparameter\n tuning job launches and the metrics to monitor.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#HyperParameterScalingType": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auto" + } + }, + "LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linear" + } + }, + "LOGARITHMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Logarithmic" + } + }, + "REVERSE_LOGARITHMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReverseLogarithmic" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterSpecification": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of this hyperparameter. The name must be unique.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A brief description of the hyperparameter.
" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#ParameterType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of this hyperparameter. The valid types are Integer,\n Continuous, Categorical, and FreeText.
The allowed range for this hyperparameter.
" + } + }, + "IsTunable": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether this hyperparameter is tunable in a hyperparameter tuning\n job.
" + } + }, + "IsRequired": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether this hyperparameter is required.
" + } + }, + "DefaultValue": { + "target": "com.amazonaws.sagemaker#HyperParameterValue", + "traits": { + "smithy.api#documentation": "The default value for this hyperparameter. If a default value is specified, a\n hyperparameter cannot be required.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a hyperparameter to be used by an algorithm.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition": { + "type": "structure", + "members": { + "DefinitionName": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", + "traits": { + "smithy.api#documentation": "The job definition name.
" + } + }, + "TuningObjective": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective" + }, + "HyperParameterRanges": { + "target": "com.amazonaws.sagemaker#ParameterRanges" + }, + "StaticHyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "Specifies the values of hyperparameters\n that\n do not change for the tuning job.
" + } + }, + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The HyperParameterAlgorithmSpecification object that\n specifies\n the resource algorithm to use for the training jobs that the tuning\n job launches.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the\n IAM\n role associated with the training jobs that the tuning job\n launches.
", + "smithy.api#required": {} + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#documentation": "An array of Channel objects that\n specify\n the\n input for the training jobs that the tuning job launches.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "The VpcConfig object that specifies the VPC that you want the training jobs\n that this hyperparameter tuning job launches to connect to. Control access to and from\n your training container by configuring the VPC. For more information, see Protect Training Jobs\n by Using an Amazon Virtual Private Cloud.
" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the path to the Amazon S3 bucket where you\n store\n model artifacts from the training jobs that the tuning job\n launches.
", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#documentation": "The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.
\nStorage volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want SageMaker to use the storage volume to store the\n training data, choose File as the TrainingInputMode in the\n algorithm specification. For distributed training algorithms, specify an instance count\n greater than 1.
If you want to use hyperparameter optimization with instance type flexibility, use\n HyperParameterTuningResourceConfig instead.
The configuration for the hyperparameter tuning resources, including the compute\n instances and storage volumes, used for training jobs launched by the tuning job. By\n default, storage volumes hold model artifacts and incremental states. Choose\n File for TrainingInputMode in the\n AlgorithmSpecification parameter to additionally store training data in\n the storage volume (optional).
Specifies a limit to how long a model hyperparameter training job can run. It also\n specifies how long a managed spot training job has to complete. When the job reaches the\n time limit, SageMaker ends the training job. Use this API to cap model training costs.
", + "smithy.api#required": {} + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n network isolation is used for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
" + } + }, + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.
A Boolean indicating whether managed spot training is enabled (True) or\n not (False).
The number of times to retry the job when the job fails due to an\n InternalServerError.
An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See\n Define metrics and variables for more information.
\nThe maximum number of items specified for Map Entries refers to the\n maximum number of environment variables for each TrainingJobDefinition\n and also the maximum for the hyperparameter tuning job itself. That is, the sum of\n the number of environment variables for all the training job definitions can't\n exceed the maximum number specified.
Defines\n the training jobs launched by a hyperparameter tuning job.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 48 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary" + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary": { + "type": "structure", + "members": { + "TrainingJobDefinitionName": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", + "traits": { + "smithy.api#documentation": "The training job definition name.
" + } + }, + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the training job.
", + "smithy.api#required": {} + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
", + "smithy.api#required": {} + } + }, + "TuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#documentation": "The HyperParameter tuning job that launched the training job.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the training job was created.
", + "smithy.api#required": {} + } + }, + "TrainingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the training job started.
" + } + }, + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Specifies the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
The\n status\n of the training job.
", + "smithy.api#required": {} + } + }, + "TunedHyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A\n list of the hyperparameters for which you specified ranges to\n search.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The\n reason that the training job failed.\n
" + } + }, + "FinalHyperParameterTuningJobObjectiveMetric": { + "target": "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric", + "traits": { + "smithy.api#documentation": "The FinalHyperParameterTuningJobObjectiveMetric object that specifies the\n value\n of the\n objective\n metric of the tuning job that launched this training job.
" + } + }, + "ObjectiveStatus": { + "target": "com.amazonaws.sagemaker#ObjectiveStatus", + "traits": { + "smithy.api#documentation": "The status of the objective metric for the training job:
\nSucceeded: The\n final\n objective metric for the training job was evaluated by the\n hyperparameter tuning job and\n used\n in the hyperparameter tuning process.
\nPending: The training job is in progress and evaluation of its final objective\n metric is pending.
\nFailed:\n The final objective metric for the training job was not evaluated, and was not\n used in the hyperparameter tuning process. This typically occurs when the\n training job failed or did not emit an objective\n metric.
\nThe container for the summary information about a training job.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningAllocationStrategy": { + "type": "enum", + "members": { + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prioritized" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfig": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance type used for processing of hyperparameter optimization jobs. Choose from\n general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge\n or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more\n information about instance types, see instance type\n descriptions.
", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See Step 2:\n Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more\n information.
The volume size in GB of the data to be processed for hyperparameter optimization\n (optional).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for hyperparameter tuning resources for use in training jobs\n launched by the tuning job. These resources include compute instances and storage\n volumes. Specify one or more compute instance configurations and allocation strategies\n to select resources (optional).
" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails": { + "type": "structure", + "members": { + "NumberOfTrainingJobsObjectiveNotImproving": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The number of training jobs launched by a tuning job that are not improving (1% or\n less) as measured by model performance evaluated against an objective function.
" + } + }, + "ConvergenceDetectedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time in timestamp format that AMT detected model convergence, as defined by a lack\n of significant improvement over time based on criteria developed over a wide range of\n diverse benchmarking tests.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains runtime information about both current and completed\n hyperparameter tuning jobs.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobConfig": { + "type": "structure", + "members": { + "Strategy": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies how hyperparameter tuning chooses the combinations of hyperparameter values\n to use for the training job it launches. For information about search strategies, see\n How\n Hyperparameter Tuning Works.
", + "smithy.api#required": {} + } + }, + "StrategyConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyConfig", + "traits": { + "smithy.api#documentation": "The configuration for the Hyperband optimization strategy. This parameter\n should be provided only if Hyperband is selected as the strategy for\n HyperParameterTuningJobConfig.
The HyperParameterTuningJobObjective specifies the objective metric used to\n evaluate the performance of training jobs launched by this tuning job.
" + } + }, + "ResourceLimits": { + "target": "com.amazonaws.sagemaker#ResourceLimits", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ResourceLimits\n object that specifies the maximum number of training and parallel training jobs that can\n be used for this hyperparameter tuning job.
", + "smithy.api#required": {} + } + }, + "ParameterRanges": { + "target": "com.amazonaws.sagemaker#ParameterRanges", + "traits": { + "smithy.api#documentation": "The ParameterRanges\n object that specifies the ranges of hyperparameters that this tuning job searches over\n to find the optimal configuration for the highest model performance against your chosen\n objective metric.
" + } + }, + "TrainingJobEarlyStoppingType": { + "target": "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType", + "traits": { + "smithy.api#documentation": "Specifies whether to use early stopping for training jobs launched by the\n hyperparameter tuning job. Because the Hyperband strategy has its own\n advanced internal early stopping mechanism, TrainingJobEarlyStoppingType\n must be OFF to use Hyperband. This parameter can take on one\n of the following values (the default value is OFF):
Training jobs launched by the hyperparameter tuning job do not use early\n stopping.
\nSageMaker stops training jobs launched by the hyperparameter tuning job when\n they are unlikely to perform better than previously completed training jobs.\n For more information, see Stop Training Jobs Early.
\nThe tuning job's completion criteria.
" + } + }, + "RandomSeed": { + "target": "com.amazonaws.sagemaker#RandomSeed", + "traits": { + "smithy.api#documentation": "A value used to initialize a pseudo-random number generator. Setting a random seed and\n using the same seed later for the same tuning job will allow hyperparameter optimization\n to find more a consistent hyperparameter configuration between the two runs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures a hyperparameter tuning job.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobConsumedResources": { + "type": "structure", + "members": { + "RuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The wall clock runtime in seconds used by your hyperparameter tuning job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The total resources consumed by your hyperparameter tuning job.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobObjective": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether to minimize or maximize the objective metric.
", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The\n name of the metric to use for the objective metric.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning\n uses the value of this metric to evaluate the training jobs it launches, and returns the\n training job that results in either the highest or lowest value for this metric,\n depending on the value you specify for the Type parameter. If you want to\n define a custom objective metric, see Define metrics and environment variables.
The name of a hyperparameter tuning job.
" + } + }, + "HyperParameterTuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a hyperparameter tuning job.
" + } + }, + "HyperParameterTuningJobConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig" + }, + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition" + }, + "TrainingJobDefinitions": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", + "traits": { + "smithy.api#documentation": "The job definitions included in a hyperparameter tuning job.
" + } + }, + "HyperParameterTuningJobStatus": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "traits": { + "smithy.api#documentation": "The status of a hyperparameter tuning job.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that a hyperparameter tuning job was created.
" + } + }, + "HyperParameterTuningEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that a hyperparameter tuning job ended.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that a hyperparameter tuning job was last modified.
" + } + }, + "TrainingJobStatusCounters": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters" + }, + "ObjectiveStatusCounters": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters" + }, + "BestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary" + }, + "OverallBestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary" + }, + "WarmStartConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig" + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The error that was created when a hyperparameter tuning job failed.
" + } + }, + "TuningJobCompletionDetails": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails", + "traits": { + "smithy.api#documentation": "Information about either a current or completed hyperparameter tuning job.
" + } + }, + "ConsumedResources": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConsumedResources", + "traits": { + "smithy.api#documentation": "The total amount of resources consumed by a hyperparameter tuning job.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An entity returned by the SearchRecord API\n containing the properties of a hyperparameter tuning job.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobSortByOptions": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyConfig": { + "type": "structure", + "members": { + "HyperbandStrategyConfig": { + "target": "com.amazonaws.sagemaker#HyperbandStrategyConfig", + "traits": { + "smithy.api#documentation": "The configuration for the object that specifies the Hyperband strategy.\n This parameter is only supported for the Hyperband selection for\n Strategy within the HyperParameterTuningJobConfig API.
The configuration for a training job launched by a hyperparameter tuning job. Choose\n Bayesian for Bayesian optimization, and Random for random\n search optimization. For more advanced use cases, use Hyperband, which\n evaluates objective metrics for training jobs after every epoch. For more information about\n strategies, see How Hyperparameter\n Tuning Works.
The strategy hyperparameter tuning uses to find the best combination of\n hyperparameters for your model.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSummary" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobSummary": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tuning job.
", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The\n Amazon\n Resource Name (ARN) of the tuning job.
", + "smithy.api#required": {} + } + }, + "HyperParameterTuningJobStatus": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the\n tuning\n job.
", + "smithy.api#required": {} + } + }, + "Strategy": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the search strategy hyperparameter tuning uses to choose which\n hyperparameters to\n evaluate\n at each iteration.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the tuning job was created.
", + "smithy.api#required": {} + } + }, + "HyperParameterTuningEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the tuning job ended.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the tuning job was\n modified.
" + } + }, + "TrainingJobStatusCounters": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the numbers of training\n jobs, categorized by status, that this tuning job launched.
", + "smithy.api#required": {} + } + }, + "ObjectiveStatusCounters": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the numbers of training jobs,\n categorized by objective metric status, that this tuning job launched.
", + "smithy.api#required": {} + } + }, + "ResourceLimits": { + "target": "com.amazonaws.sagemaker#ResourceLimits", + "traits": { + "smithy.api#documentation": "The ResourceLimits\n object that specifies the maximum number of training jobs and parallel training jobs\n allowed for this tuning job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about a hyperparameter tuning job.
" + } + }, + "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig": { + "type": "structure", + "members": { + "ParentHyperParameterTuningJobs": { + "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of hyperparameter tuning jobs that are used as the starting point for the new\n hyperparameter tuning job. For more information about warm starting a hyperparameter\n tuning job, see Using a Previous\n Hyperparameter Tuning Job as a Starting Point.
\nHyperparameter tuning jobs created before October 1, 2018 cannot be used as parent\n jobs for warm start tuning jobs.
", + "smithy.api#required": {} + } + }, + "WarmStartType": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies one of the following:
\nThe new hyperparameter tuning job uses the same input data and training\n image as the parent tuning jobs. You can change the hyperparameter ranges to\n search and the maximum number of training jobs that the hyperparameter\n tuning job launches. You cannot use a new version of the training algorithm,\n unless the changes in the new version do not affect the algorithm itself.\n For example, changes that improve logging or adding support for a different\n data format are allowed. You can also change hyperparameters from tunable to\n static, and from static to tunable, but the total number of static plus\n tunable hyperparameters must remain the same as it is in all parent jobs.\n The objective metric for the new tuning job must be the same as for all\n parent jobs.
\nThe new hyperparameter tuning job can include input data, hyperparameter\n ranges, maximum number of concurrent training jobs, and maximum number of\n training jobs that are different than those of its parent hyperparameter\n tuning jobs. The training image can also be a different version from the\n version used in the parent hyperparameter tuning job. You can also change\n hyperparameters from tunable to static, and from static to tunable, but the\n total number of static plus tunable hyperparameters must remain the same as\n it is in all parent jobs. The objective metric for the new tuning job must\n be the same as for all parent jobs.
\nSpecifies the configuration for a hyperparameter tuning job that uses one or more\n previous hyperparameter tuning jobs as a starting point. The results of previous tuning\n jobs are used to inform which combinations of hyperparameters to search over in the new\n tuning job.
\nAll training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric, and the training job that performs the best is compared to the\n best training jobs from the parent tuning jobs. From these, the training job that\n performs the best as measured by the objective metric is returned as the overall best\n training job.
\nAll training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.
\nThe instance type used to run hyperparameter optimization tuning jobs. See descriptions of\n instance types for more information.
" + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#documentation": "The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
The volume size in GB for the storage volume to be used in processing hyperparameter\n optimization jobs (optional). These volumes store model artifacts, incremental states\n and optionally, scratch space for training algorithms. Do not provide a value for this\n parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these\n instances for training, VolumeSizeInGB cannot be greater than this total\n size. For a list of instance types with local instance storage and their sizes, see\n instance store volumes.
SageMaker supports only the General Purpose SSD\n (gp2) storage volume type.
\nA key used by Amazon Web Services Key Management Service to encrypt data on the storage volume\n attached to the compute instances used to run the training job. You can use either of\n the following formats to specify a key.
\nKMS Key ID:
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS key:
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Some instances use local storage, which use a hardware module to\n encrypt storage volumes. If you choose one of these instance types, you\n cannot request a VolumeKmsKeyId. For a list of instance types that use\n local storage, see instance store\n volumes. For more information about Amazon Web Services Key Management Service, see KMS\n encryption for more information.
The strategy that determines the order of preference for resources specified in\n InstanceConfigs used in hyperparameter optimization.
A list containing the configuration(s) for one or more resources for processing\n hyperparameter jobs. These resources include compute instances and storage volumes to\n use in model training jobs launched by hyperparameter tuning jobs. The\n AllocationStrategy controls the order in which multiple configurations\n provided in InstanceConfigs are used.
If you only want to use a single instance configuration inside the\n HyperParameterTuningResourceConfig API, do not provide a value for\n InstanceConfigs. Instead, use InstanceType,\n VolumeSizeInGB and InstanceCount. If you use\n InstanceConfigs, do not provide values for\n InstanceType, VolumeSizeInGB or\n InstanceCount.
The configuration of resources, including compute instances and storage volumes for\n use in training jobs launched by hyperparameter tuning jobs.\n HyperParameterTuningResourceConfig is similar to\n ResourceConfig, but has the additional InstanceConfigs and\n AllocationStrategy fields to allow for flexible instance management.\n Specify one or more instance types, count, and the allocation strategy for instance\n selection.
\n HyperParameterTuningResourceConfig supports the capabilities of\n ResourceConfig with the exception of\n KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools\n by default, which reuse clusters between training jobs.
The minimum number of resources (such as epochs) that can be used by a training job\n launched by a hyperparameter tuning job. If the value for MinResource has not\n been reached, the training job is not stopped by Hyperband.
The maximum number of resources (such as epochs) that can be used by a training job\n launched by a hyperparameter tuning job. Once a job reaches the MaxResource\n value, it is stopped. If a value for MaxResource is not provided, and\n Hyperband is selected as the hyperparameter tuning strategy,\n HyperbandTraining attempts to infer MaxResource from the\n following keys (if present) in StaticsHyperParameters:
\n epochs\n
\n numepochs\n
\n n-epochs\n
\n n_epochs\n
\n num_epochs\n
If HyperbandStrategyConfig is unable to infer a value for\n MaxResource, it generates a validation error. The maximum value is 20,000\n epochs. All metrics that correspond to an objective metric are used to derive early stopping\n decisions. For distributed training jobs,\n ensure that duplicate metrics are not printed in the logs across the individual nodes in a\n training job. If multiple nodes are publishing duplicate or incorrect metrics, training\n jobs may make an incorrect stopping decision and stop the job prematurely.
The configuration for Hyperband, a multi-fidelity based hyperparameter\n tuning strategy. Hyperband uses the final and intermediate results of a\n training job to dynamically allocate resources to utilized hyperparameter configurations\n while automatically stopping under-performing configurations. This parameter should be\n provided only if Hyperband is selected as the StrategyConfig\n under the HyperParameterTuningJobConfig API.
The Amazon Resource Name (ARN) of the IAM identity.
" + } + }, + "PrincipalId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The ID of the principal that assumes the IAM identity.
" + } + }, + "SourceIdentity": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The person or application which assumes the IAM identity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The IAM Identity details associated with the user. These details are\n associated with model package groups, model packages and project entities only.
" + } + }, + "com.amazonaws.sagemaker#IamPolicyConstraints": { + "type": "structure", + "members": { + "SourceIp": { + "target": "com.amazonaws.sagemaker#EnabledOrDisabled", + "traits": { + "smithy.api#documentation": "When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal.
When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal.
Use this parameter to specify a supported global condition key that is added to the IAM policy.
" + } + }, + "com.amazonaws.sagemaker#IdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 128 + } + } + }, + "com.amazonaws.sagemaker#IdentityProviderOAuthSetting": { + "type": "structure", + "members": { + "DataSourceName": { + "target": "com.amazonaws.sagemaker#DataSourceName", + "traits": { + "smithy.api#documentation": "The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "Describes whether OAuth for a data source is enabled or disabled in the Canvas\n application.
" + } + }, + "SecretArn": { + "target": "com.amazonaws.sagemaker#SecretArn", + "traits": { + "smithy.api#documentation": "The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your\n identity provider, such as the client ID and secret, authorization URL, and token URL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external\n data source, such as Snowflake.
" + } + }, + "com.amazonaws.sagemaker#IdentityProviderOAuthSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#IdentityProviderOAuthSetting" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#IdleSettings": { + "type": "structure", + "members": { + "LifecycleManagement": { + "target": "com.amazonaws.sagemaker#LifecycleManagement", + "traits": { + "smithy.api#documentation": "Indicates whether idle shutdown is activated for the application type.
" + } + }, + "IdleTimeoutInMinutes": { + "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The time that SageMaker waits after the application becomes idle before shutting it\n down.
" + } + }, + "MinIdleTimeoutInMinutes": { + "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The minimum value in minutes that custom idle shutdown can be set to by the user.
" + } + }, + "MaxIdleTimeoutInMinutes": { + "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The maximum value in minutes that custom idle shutdown can be set to by the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings related to idle shutdown of Studio applications.
" + } + }, + "com.amazonaws.sagemaker#IdleTimeoutInMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 525600 + } + } + }, + "com.amazonaws.sagemaker#Image": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "When the image was created.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ImageDescription", + "traits": { + "smithy.api#documentation": "The description of the image.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ImageDisplayName", + "traits": { + "smithy.api#documentation": "The name of the image as displayed.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "When a create, update, or delete operation fails, the reason for the failure.
" + } + }, + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the image.
", + "smithy.api#required": {} + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image.
", + "smithy.api#required": {} + } + }, + "ImageStatus": { + "target": "com.amazonaws.sagemaker#ImageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the image.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "When the image was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from\n a common base container image. Each of these container images is represented by a SageMaker AI\n ImageVersion.
How long a job is allowed to run, or how many candidates a job is allowed to\n generate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the image classification problem\n type.
" + } + }, + "com.amazonaws.sagemaker#ImageConfig": { + "type": "structure", + "members": { + "RepositoryAccessMode": { + "target": "com.amazonaws.sagemaker#RepositoryAccessMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Set this to one of the following values:
\n\n Platform - The model image is hosted in Amazon ECR.
\n Vpc - The model image is hosted in a private Docker registry in\n your VPC.
(Optional) Specifies an authentication configuration for the private docker registry\n where your model image is hosted. Specify a value for this property only if you\n specified Vpc as the value for the RepositoryAccessMode field,\n and the private Docker registry where the model image is hosted requires\n authentication.
Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC).
" + } + }, + "com.amazonaws.sagemaker#ImageContainerImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.sagemaker#ImageDeleteProperty": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 11 + }, + "smithy.api#pattern": "^(^DisplayName$)|(^Description$)$" + } + }, + "com.amazonaws.sagemaker#ImageDeletePropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ImageDeleteProperty" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#ImageDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ImageDigest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 72 + }, + "smithy.api#pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" + } + }, + "com.amazonaws.sagemaker#ImageDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^\\S(.*\\S)?$" + } + }, + "com.amazonaws.sagemaker#ImageName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ImageNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-.]+$" + } + }, + "com.amazonaws.sagemaker#ImageSortBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LAST_MODIFIED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + }, + "IMAGE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_NAME" + } + } + } + }, + "com.amazonaws.sagemaker#ImageSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.sagemaker#ImageStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.sagemaker#ImageUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ImageVersion": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "When the version was created.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "When a create or delete operation fails, the reason for the failure.
" + } + }, + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the image the version is based on.
", + "smithy.api#required": {} + } + }, + "ImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the version.
", + "smithy.api#required": {} + } + }, + "ImageVersionStatus": { + "target": "com.amazonaws.sagemaker#ImageVersionStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the version.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "When the version was last modified.
", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version number.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A version of a SageMaker AI Image. A version represents an existing container\n image.
Import hub content.
" + } + }, + "com.amazonaws.sagemaker#ImportHubContentRequest": { + "type": "structure", + "members": { + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub content to import.
", + "smithy.api#required": {} + } + }, + "HubContentVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#documentation": "The version of the hub content to import.
" + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of hub content to import.
", + "smithy.api#required": {} + } + }, + "DocumentSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the hub content schema to import.
", + "smithy.api#required": {} + } + }, + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub to import content into.
", + "smithy.api#required": {} + } + }, + "HubContentDisplayName": { + "target": "com.amazonaws.sagemaker#HubContentDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the hub content to import.
" + } + }, + "HubContentDescription": { + "target": "com.amazonaws.sagemaker#HubContentDescription", + "traits": { + "smithy.api#documentation": "A description of the hub content to import.
" + } + }, + "HubContentMarkdown": { + "target": "com.amazonaws.sagemaker#HubContentMarkdown", + "traits": { + "smithy.api#documentation": "A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
" + } + }, + "HubContentDocument": { + "target": "com.amazonaws.sagemaker#HubContentDocument", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
", + "smithy.api#required": {} + } + }, + "HubContentSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubContentSearchKeywordList", + "traits": { + "smithy.api#documentation": "The searchable keywords of the hub content.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Any tags associated with the hub content.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ImportHubContentResponse": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the hub that the content was imported into.
", + "smithy.api#required": {} + } + }, + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the hub content that was imported.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#InUseInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements": { + "type": "structure", + "members": { + "NumberOfCpuCoresRequired": { + "target": "com.amazonaws.sagemaker#NumberOfCpuCores", + "traits": { + "smithy.api#documentation": "The number of CPU cores to allocate to run a model that you assign to an inference\n component.
" + } + }, + "NumberOfAcceleratorDevicesRequired": { + "target": "com.amazonaws.sagemaker#NumberOfAcceleratorDevices", + "traits": { + "smithy.api#documentation": "The number of accelerators to allocate to run a model that you assign to an inference\n component. Accelerators include GPUs and Amazon Web Services Inferentia.
" + } + }, + "MinMemoryRequiredInMb": { + "target": "com.amazonaws.sagemaker#MemoryInMb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The minimum MB of memory to allocate to run a model that you assign to an inference\n component.
", + "smithy.api#required": {} + } + }, + "MaxMemoryRequiredInMb": { + "target": "com.amazonaws.sagemaker#MemoryInMb", + "traits": { + "smithy.api#documentation": "The maximum MB of memory to allocate to run a model that you assign to an inference\n component.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the compute resources to allocate to run a model, plus any adapter models, that\n you assign to an inference component. These resources include CPU cores, accelerators, and\n memory.
" + } + }, + "com.amazonaws.sagemaker#InferenceComponentContainerSpecification": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#documentation": "The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.
" + } + }, + "ArtifactUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "The Amazon S3 path where the model artifacts, which result from model training,\n are stored. This path must point to a single gzip compressed tar archive (.tar.gz\n suffix).
" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container. Each key and value in the\n Environment string-to-string map can have length of up to 1024. We support up to 16 entries\n in the map.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.
" + } + }, + "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary": { + "type": "structure", + "members": { + "DeployedImage": { + "target": "com.amazonaws.sagemaker#DeployedImage" + }, + "ArtifactUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "The Amazon S3 path where the model artifacts are stored.
" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the resources that are deployed with this inference component.
" + } + }, + "com.amazonaws.sagemaker#InferenceComponentCopyCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + } + }, + "com.amazonaws.sagemaker#InferenceComponentNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig": { + "type": "structure", + "members": { + "CopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of runtime copies of the model container to deploy with the inference\n component. Each copy can serve inference requests.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
" + } + }, + "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary": { + "type": "structure", + "members": { + "DesiredCopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#documentation": "The number of runtime copies of the model container that you requested to deploy with\n the inference component.
" + } + }, + "CurrentCopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#documentation": "The number of runtime copies of the model container that are currently deployed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the runtime settings for the model that is deployed with the inference\n component.
" + } + }, + "com.amazonaws.sagemaker#InferenceComponentSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentSpecification": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "The name of an existing SageMaker AI model object in your account that you want to\n deploy with the inference component.
" + } + }, + "Container": { + "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecification", + "traits": { + "smithy.api#documentation": "Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.
" + } + }, + "StartupParameters": { + "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", + "traits": { + "smithy.api#documentation": "Settings that take effect while the model container starts up.
" + } + }, + "ComputeResourceRequirements": { + "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", + "traits": { + "smithy.api#documentation": "The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.
\nOmit this parameter if your request is meant to create an adapter inference component.\n An adapter inference component is loaded by a base inference component, and it uses the\n compute resources of the base inference component.
" + } + }, + "BaseInferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#documentation": "The name of an existing inference component that is to contain the inference component\n that you're creating with your request.
\nSpecify this parameter only if your request is meant to create an adapter inference\n component. An adapter inference component contains the path to an adapter model. The\n purpose of the adapter model is to tailor the inference output of a base foundation model,\n which is hosted by the base inference component. The adapter inference component uses the\n compute resources that you assigned to the base inference component.
\nWhen you create an adapter inference component, use the Container parameter\n to specify the location of the adapter artifacts. In the parameter value, use the\n ArtifactUrl parameter of the\n InferenceComponentContainerSpecification data type.
Before you can create an adapter inference component, you must have an existing\n inference component that contains the foundation model that you want to adapt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.
" + } + }, + "com.amazonaws.sagemaker#InferenceComponentSpecificationSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "The name of the SageMaker AI model object that is deployed with the inference\n component.
" + } + }, + "Container": { + "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary", + "traits": { + "smithy.api#documentation": "Details about the container that provides the runtime environment for the model that is\n deployed with the inference component.
" + } + }, + "StartupParameters": { + "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", + "traits": { + "smithy.api#documentation": "Settings that take effect while the model container starts up.
" + } + }, + "ComputeResourceRequirements": { + "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", + "traits": { + "smithy.api#documentation": "The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.
" + } + }, + "BaseInferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#documentation": "The name of the base inference component that contains this inference component.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the resources that are deployed with this inference component.
" + } + }, + "com.amazonaws.sagemaker#InferenceComponentStartupParameters": { + "type": "structure", + "members": { + "ModelDataDownloadTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this inference\n component.
" + } + }, + "ContainerStartupHealthCheckTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "The timeout value, in seconds, for your inference container to pass health check by\n Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings that take effect while the model container starts up.
" + } + }, + "com.amazonaws.sagemaker#InferenceComponentStatus": { + "type": "enum", + "members": { + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentSummary": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the inference component was created.
", + "smithy.api#required": {} + } + }, + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", + "smithy.api#required": {} + } + }, + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference component.
", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint that hosts the inference component.
", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the production variant that hosts the inference component.
", + "smithy.api#required": {} + } + }, + "InferenceComponentStatus": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "The status of the inference component.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the inference component was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the properties of an inference component.
" + } + }, + "com.amazonaws.sagemaker#InferenceComponentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceComponentSummary" + } + }, + "com.amazonaws.sagemaker#InferenceExecutionConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.sagemaker#InferenceExecutionMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "How containers in a multi-container are run. The following values are valid.
\n\n SERIAL - Containers run as a serial pipeline.
\n DIRECT - Only the individual container that you specify is\n run.
Specifies details about how containers in a multi-container endpoint are run.
" + } + }, + "com.amazonaws.sagemaker#InferenceExecutionMode": { + "type": "enum", + "members": { + "SERIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Serial" + } + }, + "DIRECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Direct" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceExperimentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentDataStorageConfig": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 bucket where the inference request and response data is stored.
", + "smithy.api#required": {} + } + }, + "KmsKey": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "\n The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3\n server-side encryption.\n
" + } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader" + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location and configuration for storing inference request and response data.
" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceExperimentSummary" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 120 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}$" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentSchedule": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the inference experiment started or will start.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the inference experiment ended or will end.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The start and end times of an inference experiment.
\nThe maximum duration that you can set for an inference experiment is 30 days.
" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceExperimentStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentStopDesiredState": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceExperimentSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference experiment.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#InferenceExperimentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of the inference experiment.
", + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", + "traits": { + "smithy.api#documentation": "The duration for which the inference experiment ran or will run.
\nThe maximum duration that you can set for an inference experiment is 30 days.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the inference experiment.
", + "smithy.api#required": {} + } + }, + "StatusReason": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatusReason", + "traits": { + "smithy.api#documentation": "The error message for the inference experiment status result.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#InferenceExperimentDescription", + "traits": { + "smithy.api#documentation": "The description of the inference experiment.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The timestamp at which the inference experiment was created.
", + "smithy.api#required": {} + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the inference experiment was completed.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The timestamp when you last modified the inference experiment.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Lists a summary of properties of an inference experiment.
" + } + }, + "com.amazonaws.sagemaker#InferenceExperimentType": { + "type": "enum", + "members": { + "SHADOW_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShadowMode" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceHubAccessConfig": { + "type": "structure", + "members": { + "HubContentArn": { + "target": "com.amazonaws.sagemaker#HubContentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the hub content for which deployment access is allowed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information specifying which hub contents have accessible deployment options.
" + } + }, + "com.amazonaws.sagemaker#InferenceImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#InferenceMetrics": { + "type": "structure", + "members": { + "MaxInvocations": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The expected maximum number of requests per minute for the instance.
", + "smithy.api#required": {} + } + }, + "ModelLatency": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The expected model latency at maximum invocations per minute for the instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The metrics for an existing endpoint compared in an Inference Recommender job.
" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendation": { + "type": "structure", + "members": { + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The recommendation ID which uniquely identifies each recommendation.
" + } + }, + "Metrics": { + "target": "com.amazonaws.sagemaker#RecommendationMetrics", + "traits": { + "smithy.api#documentation": "The metrics used to decide what recommendation to make.
" + } + }, + "EndpointConfiguration": { + "target": "com.amazonaws.sagemaker#EndpointOutputConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Defines the endpoint configuration parameters.
", + "smithy.api#required": {} + } + }, + "ModelConfiguration": { + "target": "com.amazonaws.sagemaker#ModelConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Defines the model configuration.
", + "smithy.api#required": {} + } + }, + "InvocationEndTime": { + "target": "com.amazonaws.sagemaker#InvocationEndTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the benchmark completed.
" + } + }, + "InvocationStartTime": { + "target": "com.amazonaws.sagemaker#InvocationStartTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the benchmark started.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of recommendations made by Amazon SageMaker Inference Recommender.
" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceRecommendation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#InferenceRecommendationsJob": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the job.
", + "smithy.api#required": {} + } + }, + "JobDescription": { + "target": "com.amazonaws.sagemaker#RecommendationJobDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The job description.
", + "smithy.api#required": {} + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#RecommendationJobType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The recommendation job type.
", + "smithy.api#required": {} + } + }, + "JobArn": { + "target": "com.amazonaws.sagemaker#RecommendationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommendation job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the job was created.
", + "smithy.api#required": {} + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the job completed.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the job was last modified.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the job fails, provides information why the job failed.
" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "The name of the created model.
" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix).
" + } + }, + "ModelPackageVersionArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a versioned model package.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains a list of recommendation jobs.
" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendationsJobStep": { + "type": "structure", + "members": { + "StepType": { + "target": "com.amazonaws.sagemaker#RecommendationStepType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of the subtask.
\n\n BENCHMARK: Evaluate the performance of your model on different instance types.
The name of the Inference Recommender job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the benchmark.
", + "smithy.api#required": {} + } + }, + "InferenceBenchmark": { + "target": "com.amazonaws.sagemaker#RecommendationJobInferenceBenchmark", + "traits": { + "smithy.api#documentation": "The details for a specific benchmark.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A returned array object for the Steps response field in the\n ListInferenceRecommendationsJobSteps API command.
The Amazon ECR registry path of the Docker image that contains the inference code.
", + "smithy.api#required": {} + } + }, + "SupportedTransformInstanceTypes": { + "target": "com.amazonaws.sagemaker#TransformInstanceTypes", + "traits": { + "smithy.api#documentation": "A list of the instance types on which a transformation job can be run or on which an\n endpoint can be deployed.
\nThis parameter is required for unversioned models, and optional for versioned\n models.
" + } + }, + "SupportedRealtimeInferenceInstanceTypes": { + "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", + "traits": { + "smithy.api#documentation": "A list of the instance types that are used to generate inferences in real-time.
\nThis parameter is required for unversioned models, and optional for versioned\n models.
" + } + }, + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#ContentTypes", + "traits": { + "smithy.api#documentation": "The supported MIME types for the input data.
" + } + }, + "SupportedResponseMIMETypes": { + "target": "com.amazonaws.sagemaker#ResponseMIMETypes", + "traits": { + "smithy.api#documentation": "The supported MIME types for the output data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines how to perform inference generation after a training job is run.
" + } + }, + "com.amazonaws.sagemaker#InferenceSpecificationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#InfraCheckConfig": { + "type": "structure", + "members": { + "EnableInfraCheck": { + "target": "com.amazonaws.sagemaker#EnableInfraCheck", + "traits": { + "smithy.api#documentation": "Enables an infrastructure health check.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network \n connectivity.
" + } + }, + "com.amazonaws.sagemaker#InitialInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InitialNumberOfUsers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InitialTaskCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InputConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix).
", + "smithy.api#required": {} + } + }, + "DataInputConfig": { + "target": "com.amazonaws.sagemaker#DataInputConfig", + "traits": { + "smithy.api#documentation": "Specifies the name and shape of the expected data inputs for your trained model with a\n JSON dictionary form. The data inputs are Framework specific.
\n TensorFlow: You must specify the name and shape (NHWC format) of\n the expected data inputs using a dictionary format for your trained model. The\n dictionary formats required for the console and CLI are different.
Examples for one input:
\nIf using the console,\n {\"input\":[1,1024,1024,3]}\n
If using the CLI,\n {\\\"input\\\":[1,1024,1024,3]}\n
Examples for two inputs:
\nIf using the console, {\"data1\": [1,28,28,1],\n \"data2\":[1,28,28,1]}\n
If using the CLI, {\\\"data1\\\": [1,28,28,1],\n \\\"data2\\\":[1,28,28,1]}\n
\n KERAS: You must specify the name and shape (NCHW format) of\n expected data inputs using a dictionary format for your trained model. Note that\n while Keras model artifacts should be uploaded in NHWC (channel-last) format,\n DataInputConfig should be specified in NCHW (channel-first)\n format. The dictionary formats required for the console and CLI are\n different.
Examples for one input:
\nIf using the console,\n {\"input_1\":[1,3,224,224]}\n
If using the CLI,\n {\\\"input_1\\\":[1,3,224,224]}\n
Examples for two inputs:
\nIf using the console, {\"input_1\": [1,3,224,224],\n \"input_2\":[1,3,224,224]} \n
If using the CLI, {\\\"input_1\\\": [1,3,224,224],\n \\\"input_2\\\":[1,3,224,224]}\n
\n MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW\n format) of the expected data inputs in order using a dictionary format for your\n trained model. The dictionary formats required for the console and CLI are\n different.
Examples for one input:
\nIf using the console,\n {\"data\":[1,3,1024,1024]}\n
If using the CLI,\n {\\\"data\\\":[1,3,1024,1024]}\n
Examples for two inputs:
\nIf using the console, {\"var1\": [1,1,28,28],\n \"var2\":[1,1,28,28]} \n
If using the CLI, {\\\"var1\\\": [1,1,28,28],\n \\\"var2\\\":[1,1,28,28]}\n
\n PyTorch: You can either specify the name and shape (NCHW format)\n of expected data inputs in order using a dictionary format for your trained\n model or you can specify the shape only using a list format. The dictionary\n formats required for the console and CLI are different. The list formats for the\n console and CLI are the same.
Examples for one input in dictionary format:
\nIf using the console,\n {\"input0\":[1,3,224,224]}\n
If using the CLI,\n {\\\"input0\\\":[1,3,224,224]}\n
Example for one input in list format:\n [[1,3,224,224]]\n
Examples for two inputs in dictionary format:
\nIf using the console, {\"input0\":[1,3,224,224],\n \"input1\":[1,3,224,224]}\n
If using the CLI, {\\\"input0\\\":[1,3,224,224],\n \\\"input1\\\":[1,3,224,224]} \n
Example for two inputs in list format: [[1,3,224,224],\n [1,3,224,224]]\n
\n XGBOOST: input data name and shape are not needed.
\n DataInputConfig supports the following parameters for CoreML\n TargetDevice (ML Model format):
\n shape: Input shape, for example {\"input_1\": {\"shape\":\n [1,224,224,3]}}. In addition to static input shapes, CoreML converter\n supports Flexible input shapes:
Range Dimension. You can use the Range Dimension feature if you know\n the input shape will be within some specific interval in that dimension,\n for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224,\n 3]}}\n
Enumerated shapes. Sometimes, the models are trained to work only on a\n select set of inputs. You can enumerate all supported input shapes, for\n example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160,\n 3]]}}\n
\n default_shape: Default input shape. You can set a default shape\n during conversion for both Range Dimension and Enumerated Shapes. For example\n {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1,\n 224, 224, 3]}}\n
\n type: Input type. Allowed values: Image and\n Tensor. By default, the converter generates an ML Model with\n inputs of type Tensor (MultiArray). User can set input type to be Image. Image\n input type requires additional input parameters such as bias and\n scale.
\n bias: If the input type is an Image, you need to provide the bias\n vector.
\n scale: If the input type is an Image, you need to provide a scale\n factor.
CoreML ClassifierConfig parameters can be specified using OutputConfig\n CompilerOptions. CoreML converter supports Tensorflow and PyTorch models.\n CoreML conversion examples:
Tensor type input:
\n\n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3],\n [1,160,160,3]], \"default_shape\": [1,224,224,3]}}\n
Tensor type input without input name (PyTorch):
\n\n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]],\n \"default_shape\": [1,3,224,224]}]\n
Image type input:
\n\n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3],\n [1,160,160,3]], \"default_shape\": [1,224,224,3], \"type\": \"Image\",\n \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}\n
\n \"CompilerOptions\": {\"class_labels\":\n \"imagenet_labels_1000.txt\"}\n
Image type input without input name (PyTorch):
\n\n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]],\n \"default_shape\": [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1],\n \"scale\": 0.007843137255}]\n
\n \"CompilerOptions\": {\"class_labels\":\n \"imagenet_labels_1000.txt\"}\n
Depending on the model format, DataInputConfig requires the following\n parameters for ml_eia2\n OutputConfig:TargetDevice.
For TensorFlow models saved in the SavedModel format, specify the input names\n from signature_def_key and the input model shapes for\n DataInputConfig. Specify the signature_def_key in\n \n OutputConfig:CompilerOptions\n if the model does not\n use TensorFlow's default signature def key. For example:
\n \"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}\n
\n \"CompilerOptions\": {\"signature_def_key\":\n \"serving_custom\"}\n
For TensorFlow models saved as a frozen graph, specify the input tensor names\n and shapes in DataInputConfig and the output tensor names for\n output_names in \n OutputConfig:CompilerOptions\n . For\n example:
\n \"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224,\n 3]}\n
\n \"CompilerOptions\": {\"output_names\":\n [\"output_tensor:0\"]}\n
Identifies the framework in which the model was trained. For example:\n TENSORFLOW.
", + "smithy.api#required": {} + } + }, + "FrameworkVersion": { + "target": "com.amazonaws.sagemaker#FrameworkVersion", + "traits": { + "smithy.api#documentation": "Specifies the framework version to use. This API field is only supported for the\n MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.
\nFor information about framework versions supported for cloud targets and edge devices,\n see Cloud\n Supported Instance Types and Frameworks and Edge Supported\n Frameworks.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the location of input model artifacts, the name and\n shape\n of the expected data inputs, and the framework in which the model was trained.
" + } + }, + "com.amazonaws.sagemaker#InputDataConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Channel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#InputMode": { + "type": "enum", + "members": { + "PIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipe" + } + }, + "FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "File" + } + } + } + }, + "com.amazonaws.sagemaker#InputModes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingInputMode" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#InstanceGroup": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the instance type of the instance group.
", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the number of instances of the instance group.
", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#InstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the name of the instance group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an instance group for heterogeneous cluster training. When requesting a\n training job using the CreateTrainingJob API, you can configure multiple instance groups .
" + } + }, + "com.amazonaws.sagemaker#InstanceGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#InstanceGroupNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InstanceGroupName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#InstanceGroupStatus": { + "type": "enum", + "members": { + "INSERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DEGRADED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Degraded" + } + }, + "SYSTEMUPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#InstanceGroupTrainingPlanStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.sagemaker#InstanceGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InstanceGroup" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration": { + "type": "structure", + "members": { + "MinimumInstanceMetadataServiceVersion": { + "target": "com.amazonaws.sagemaker#MinimumInstanceMetadataServiceVersion", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Indicates the minimum IMDS version that the notebook instance supports. When passed as\n part of CreateNotebookInstance, if no value is selected, then it defaults\n to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of\n UpdateNotebookInstance, there is no default.
Information on the IMDS configuration of the notebook instance
" + } + }, + "com.amazonaws.sagemaker#InstanceType": { + "type": "enum", + "members": { + "ML_T2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.medium" + } + }, + "ML_T2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.large" + } + }, + "ML_T2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.xlarge" + } + }, + "ML_T2_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.2xlarge" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.large" + } + }, + "ML_M5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.xlarge" + } + }, + "ML_M5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.2xlarge" + } + }, + "ML_M5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.4xlarge" + } + }, + "ML_M5D_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.8xlarge" + } + }, + "ML_M5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.12xlarge" + } + }, + "ML_M5D_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.16xlarge" + } + }, + "ML_M5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.24xlarge" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.xlarge" + } + }, + "ML_C5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.2xlarge" + } + }, + "ML_C5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.4xlarge" + } + }, + "ML_C5D_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.9xlarge" + } + }, + "ML_C5D_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.18xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_P3DN_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3dn.24xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.8xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.16xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_INF1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.xlarge" + } + }, + "ML_INF1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.2xlarge" + } + }, + "ML_INF1_6XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.6xlarge" + } + }, + "ML_INF1_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.24xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } + }, + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + }, + "ML_M6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.large" + } + }, + "ML_M6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.xlarge" + } + }, + "ML_M6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.2xlarge" + } + }, + "ML_M6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.4xlarge" + } + }, + "ML_M6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.8xlarge" + } + }, + "ML_M6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.12xlarge" + } + }, + "ML_M6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.16xlarge" + } + }, + "ML_M6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.24xlarge" + } + }, + "ML_M6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6id.32xlarge" + } + }, + "ML_C6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.large" + } + }, + "ML_C6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.xlarge" + } + }, + "ML_C6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.2xlarge" + } + }, + "ML_C6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.4xlarge" + } + }, + "ML_C6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.8xlarge" + } + }, + "ML_C6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.12xlarge" + } + }, + "ML_C6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.16xlarge" + } + }, + "ML_C6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.24xlarge" + } + }, + "ML_C6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6id.32xlarge" + } + }, + "ML_R6ID_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.large" + } + }, + "ML_R6ID_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.xlarge" + } + }, + "ML_R6ID_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.2xlarge" + } + }, + "ML_R6ID_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.4xlarge" + } + }, + "ML_R6ID_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.8xlarge" + } + }, + "ML_R6ID_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.12xlarge" + } + }, + "ML_R6ID_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.16xlarge" + } + }, + "ML_R6ID_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.24xlarge" + } + }, + "ML_R6ID_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6id.32xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#Integer": { + "type": "integer" + }, + "com.amazonaws.sagemaker#IntegerParameterRange": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ParameterKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hyperparameter to search.
", + "smithy.api#required": {} + } + }, + "MinValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The minimum\n value\n of the hyperparameter to search.
", + "smithy.api#required": {} + } + }, + "MaxValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The maximum\n value\n of the hyperparameter to search.
", + "smithy.api#required": {} + } + }, + "ScalingType": { + "target": "com.amazonaws.sagemaker#HyperParameterScalingType", + "traits": { + "smithy.api#documentation": "The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
\nSageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.
\nLogarithmic scaling works only for ranges that have only values greater\n than 0.
\nFor a hyperparameter of the integer type, specifies the range\n that\n a hyperparameter tuning job searches.
" + } + }, + "com.amazonaws.sagemaker#IntegerParameterRangeSpecification": { + "type": "structure", + "members": { + "MinValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The minimum integer value allowed.
", + "smithy.api#required": {} + } + }, + "MaxValue": { + "target": "com.amazonaws.sagemaker#ParameterValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The maximum integer value allowed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the possible values for an integer hyperparameter.
" + } + }, + "com.amazonaws.sagemaker#IntegerParameterRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#IntegerParameterRange" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#InvocationEndTime": { + "type": "timestamp" + }, + "com.amazonaws.sagemaker#InvocationStartTime": { + "type": "timestamp" + }, + "com.amazonaws.sagemaker#InvocationsMaxRetries": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#IotRoleAlias": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.sagemaker#IsTrackingServerActive": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } + }, + "com.amazonaws.sagemaker#ItemIdentifierAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#JobDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#JobReferenceCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#JobReferenceCodeContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#JobType": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFERENCE" + } + }, + "NOTEBOOK_KERNEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOTEBOOK_KERNEL" + } + } + } + }, + "com.amazonaws.sagemaker#JoinSource": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.sagemaker#JsonContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*$" + } + }, + "com.amazonaws.sagemaker#JsonContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#JsonContentType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#JsonPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + } + } + }, + "com.amazonaws.sagemaker#JupyterLabAppImageConfig": { + "type": "structure", + "members": { + "FileSystemConfig": { + "target": "com.amazonaws.sagemaker#FileSystemConfig" + }, + "ContainerConfig": { + "target": "com.amazonaws.sagemaker#ContainerConfig" + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the file system and kernels in a SageMaker AI image running as a JupyterLab app. The FileSystemConfig object is not supported.
A list of custom SageMaker images that are configured to run as a JupyterLab app.
" + } + }, + "LifecycleConfigArns": { + "target": "com.amazonaws.sagemaker#LifecycleConfigArns", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
" + } + }, + "AppLifecycleManagement": { + "target": "com.amazonaws.sagemaker#AppLifecycleManagement", + "traits": { + "smithy.api#documentation": "Indicates whether idle shutdown is activated for JupyterLab applications.
" + } + }, + "EmrSettings": { + "target": "com.amazonaws.sagemaker#EmrSettings", + "traits": { + "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.
" + } + }, + "BuiltInLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for the JupyterLab application.
" + } + }, + "com.amazonaws.sagemaker#JupyterServerAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", + "traits": { + "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the\n LifecycleConfigArns parameter, then this parameter is also required.
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the\n JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is\n also required.
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.
A list of Git repositories that SageMaker AI automatically displays to users for\n cloning in the JupyterServer application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The JupyterServer app settings.
" + } + }, + "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.", + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#KendraSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "Describes whether the document querying feature is enabled\n or disabled in the Canvas application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon SageMaker Canvas application setting where you configure\n document querying.
" + } + }, + "com.amazonaws.sagemaker#KernelDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#KernelGatewayAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", + "traits": { + "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.
\nThe Amazon SageMaker AI Studio UI does not use the default instance type value set\n here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not\n passed.
\nA list of custom SageMaker AI images that are configured to run as a KernelGateway\n app.
" + } + }, + "LifecycleConfigArns": { + "target": "com.amazonaws.sagemaker#LifecycleConfigArns", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user\n profile or domain.
\nTo remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.
The KernelGateway app settings.
" + } + }, + "com.amazonaws.sagemaker#KernelGatewayImageConfig": { + "type": "structure", + "members": { + "KernelSpecs": { + "target": "com.amazonaws.sagemaker#KernelSpecs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The specification of the Jupyter kernels in the image.
", + "smithy.api#required": {} + } + }, + "FileSystemConfig": { + "target": "com.amazonaws.sagemaker#FileSystemConfig", + "traits": { + "smithy.api#documentation": "The Amazon Elastic File System storage configuration for a SageMaker AI image.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the file system and kernels in a SageMaker AI image running as a\n KernelGateway app.
" + } + }, + "com.amazonaws.sagemaker#KernelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.sagemaker#KernelSpec": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#KernelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Jupyter kernel in the image. This value is case sensitive.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#KernelDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the kernel.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specification of a Jupyter kernel.
" + } + }, + "com.amazonaws.sagemaker#KernelSpecs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#KernelSpec" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:/_-]*$" + } + }, + "com.amazonaws.sagemaker#LabelAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}$" + } + }, + "com.amazonaws.sagemaker#LabelCounter": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#LabelCounters": { + "type": "structure", + "members": { + "TotalLabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "The total number of objects labeled.
" + } + }, + "HumanLabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "The total number of objects labeled by a human worker.
" + } + }, + "MachineLabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "The total number of objects labeled by automated data labeling.
" + } + }, + "FailedNonRetryableError": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "The total number of objects that could not be labeled due to an error.
" + } + }, + "Unlabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "The total number of objects not yet labeled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a breakdown of the number of objects labeled.
" + } + }, + "com.amazonaws.sagemaker#LabelCountersForWorkteam": { + "type": "structure", + "members": { + "HumanLabeled": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "The total number of data objects labeled by a human worker.
" + } + }, + "PendingHuman": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "The total number of data objects that need to be labeled by a human worker.
" + } + }, + "Total": { + "target": "com.amazonaws.sagemaker#LabelCounter", + "traits": { + "smithy.api#documentation": "The total number of tasks in the labeling job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides counts for human-labeled tasks in the labeling job.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobAlgorithmSpecificationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:" + } + }, + "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig": { + "type": "structure", + "members": { + "LabelingJobAlgorithmSpecificationArn": { + "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmSpecificationArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You\n must select one of the following ARNs:
\n\n Image classification\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification\n
\n Text classification\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification\n
\n Object detection\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection\n
\n Semantic Segmentation\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation\n
At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final\n model used for auto-labeling. You can use this model as the starting point for\n subsequent similar jobs by providing the ARN of the model here.
" + } + }, + "LabelingJobResourceConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobResourceConfig", + "traits": { + "smithy.api#documentation": "Provides configuration information for a labeling job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides configuration information for auto-labeling of your data objects. A\n LabelingJobAlgorithmsConfig object must be supplied in order to use\n auto-labeling.
Declares that your content is free of personally identifiable information or adult\n content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task\n based on this information.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Attributes of the data specified by the customer. Use these to describe the data to be\n labeled.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobDataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#LabelingJobS3DataSource", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the input data objects.
" + } + }, + "SnsDataSource": { + "target": "com.amazonaws.sagemaker#LabelingJobSnsDataSource", + "traits": { + "smithy.api#documentation": "An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the location of input data.
\nYou must specify at least one of the following: S3DataSource or SnsDataSource.
Use SnsDataSource to specify an SNS input topic\n for a streaming labeling job. If you do not specify \n and SNS input topic ARN, Ground Truth will create a one-time labeling job.
Use S3DataSource to specify an input \n manifest file for both streaming and one-time labeling jobs.\n Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.
The name of the labeling job that the work team is assigned to.
" + } + }, + "JobReferenceCode": { + "target": "com.amazonaws.sagemaker#JobReferenceCode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique identifier for a labeling job. You can use this to refer to a specific\n labeling job.
", + "smithy.api#required": {} + } + }, + "WorkRequesterAccountId": { + "target": "com.amazonaws.sagemaker#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Web Services account ID of the account used to start the labeling\n job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the labeling job was created.
", + "smithy.api#required": {} + } + }, + "LabelCounters": { + "target": "com.amazonaws.sagemaker#LabelCountersForWorkteam", + "traits": { + "smithy.api#documentation": "Provides information about the progress of a labeling job.
" + } + }, + "NumberOfHumanWorkersPerDataObject": { + "target": "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject", + "traits": { + "smithy.api#documentation": "The configured number of workers per data object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information for a work team.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobForWorkteamSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#LabelingJobForWorkteamSummary" + } + }, + "com.amazonaws.sagemaker#LabelingJobInputConfig": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.sagemaker#LabelingJobDataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location of the input data.
", + "smithy.api#required": {} + } + }, + "DataAttributes": { + "target": "com.amazonaws.sagemaker#LabelingJobDataAttributes", + "traits": { + "smithy.api#documentation": "Attributes of the data specified by the customer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input configuration information for a labeling job.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#LabelingJobOutput": { + "type": "structure", + "members": { + "OutputDatasetS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 bucket location of the manifest file for labeled data.
", + "smithy.api#required": {} + } + }, + "FinalActiveLearningModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of\n automated data labeling.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the location of the output produced by the labeling job.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobOutputConfig": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 location to write output data.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.
\nIf you provide your own KMS key ID, you must add the required permissions to your KMS\n key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.
\nIf you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your\n role's account to encrypt your output data.
\nIf you use a bucket policy with an s3:PutObject permission that only\n allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n
An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to\n do real time chaining to another streaming job and receive an Amazon SNS notifications each\n time a data object is submitted by a worker.
If you provide an SnsTopicArn in OutputConfig, when workers\n complete labeling tasks, Ground Truth will send labeling task output data to the SNS output\n topic you specify here.
To learn more, see Receive Output Data from a Streaming Labeling\n Job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output configuration information for a labeling job.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobResourceConfig": { + "type": "structure", + "members": { + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training and inference jobs used for\n automated data labeling.
\nYou can only specify a VolumeKmsKeyId when you create a labeling job with\n automated data labeling enabled using the API operation CreateLabelingJob.\n You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for\n automated data labeling model training and inference when you create a labeling job\n using the console. To learn more, see Output Data and Storage Volume\n Encryption.
The VolumeKmsKeyId can be any of the following formats:
KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configure encryption on the storage volume attached to the ML compute instance used to\n run automated data labeling model training and inference.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobS3DataSource": { + "type": "structure", + "members": { + "ManifestS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 location of the manifest file that describes the input data objects.
\nThe input manifest file referenced in ManifestS3Uri must contain one of\n the following keys: source-ref or source. The value of the\n keys are interpreted as follows:
\n source-ref: The source of the object is the Amazon S3 object\n specified in the value. Use this value when the object is a binary object, such\n as an image.
\n source: The source of the object is the value. Use this\n value when the object is a text value.
If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to\n create an input manifest file.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the input data objects.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobSnsDataSource": { + "type": "structure", + "members": { + "SnsTopicArn": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic\n you will use to send new data objects to a streaming labeling job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon SNS data source used for streaming labeling jobs.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#LabelingJobStoppingConditions": { + "type": "structure", + "members": { + "MaxHumanLabeledObjectCount": { + "target": "com.amazonaws.sagemaker#MaxHumanLabeledObjectCount", + "traits": { + "smithy.api#documentation": "The maximum number of objects that can be labeled by human workers.
" + } + }, + "MaxPercentageOfInputDatasetLabeled": { + "target": "com.amazonaws.sagemaker#MaxPercentageOfInputDatasetLabeled", + "traits": { + "smithy.api#documentation": "The maximum number of input data objects that should be labeled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped. You can use these conditions to control the cost of data\n labeling.
\nLabeling jobs fail after 30 days with an appropriate client error message.
\nThe name of the labeling job.
", + "smithy.api#required": {} + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the labeling job when it was\n created.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the job was created (timestamp).
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the job was last modified (timestamp).
", + "smithy.api#required": {} + } + }, + "LabelingJobStatus": { + "target": "com.amazonaws.sagemaker#LabelingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the labeling job.
", + "smithy.api#required": {} + } + }, + "LabelCounters": { + "target": "com.amazonaws.sagemaker#LabelCounters", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Counts showing the progress of the labeling job.
", + "smithy.api#required": {} + } + }, + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team assigned to the job.
", + "smithy.api#required": {} + } + }, + "PreHumanTaskLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function. The function is run before each\n data object is sent to a worker.
" + } + }, + "AnnotationConsolidationLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function used to consolidate the\n annotations from individual workers into a label for a data object. For more\n information, see Annotation\n Consolidation.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the LabelingJobStatus field is Failed, this field\n contains a description of the error.
The location of the output produced by the labeling job.
" + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", + "traits": { + "smithy.api#documentation": "Input configuration for the labeling job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about a labeling job.
" + } + }, + "com.amazonaws.sagemaker#LabelingJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#LabelingJobSummary" + } + }, + "com.amazonaws.sagemaker#LambdaFunctionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:" + } + }, + "com.amazonaws.sagemaker#LambdaStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.
" + } + }, + "OutputParameters": { + "target": "com.amazonaws.sagemaker#OutputParameterList", + "traits": { + "smithy.api#documentation": "A list of the output parameters of the Lambda step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for a Lambda step.
" + } + }, + "com.amazonaws.sagemaker#LandingUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + } + } + }, + "com.amazonaws.sagemaker#LastModifiedTime": { + "type": "timestamp" + }, + "com.amazonaws.sagemaker#LastUpdateStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#LastUpdateStatusValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that indicates whether the update was made successful.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the update wasn't successful, indicates the reason why it failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A value that indicates whether the update was successful.
" + } + }, + "com.amazonaws.sagemaker#LastUpdateStatusValue": { + "type": "enum", + "members": { + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + } + } + }, + "com.amazonaws.sagemaker#LifecycleConfigArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn" + } + }, + "com.amazonaws.sagemaker#LifecycleManagement": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#LineageEntityParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#StringParameterValue" + }, + "value": { + "target": "com.amazonaws.sagemaker#StringParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#LineageGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/" + } + }, + "com.amazonaws.sagemaker#LineageGroupNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})$" + } + }, + "com.amazonaws.sagemaker#LineageGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#LineageGroupSummary" + } + }, + "com.amazonaws.sagemaker#LineageGroupSummary": { + "type": "structure", + "members": { + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group resource.
" + } + }, + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the lineage group.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The display name of the lineage group summary.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the lineage group summary.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last modified time of the lineage group summary.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity \n resources.
" + } + }, + "com.amazonaws.sagemaker#LineageType": { + "type": "enum", + "members": { + "TRIAL_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrialComponent" + } + }, + "ARTIFACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Artifact" + } + }, + "CONTEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Context" + } + }, + "ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Action" + } + } + } + }, + "com.amazonaws.sagemaker#ListActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListActionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListActionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Lists the actions in your account and their properties.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ActionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListActionsRequest": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#documentation": "A filter that returns only actions with the specified source URI.
" + } + }, + "ActionType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "A filter that returns only actions of the specified type.
" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only actions created on or after the specified time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only actions created on or before the specified time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortActionsBy", + "traits": { + "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListActions didn't return the full set of actions,\n the call returns a token for getting the next set of actions.
The maximum number of actions to return in the response. The default value is 10.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListActionsResponse": { + "type": "structure", + "members": { + "ActionSummaries": { + "target": "com.amazonaws.sagemaker#ActionSummaries", + "traits": { + "smithy.api#documentation": "A list of actions and their properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of actions, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAlgorithms": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAlgorithmsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAlgorithmsOutput" + }, + "traits": { + "smithy.api#documentation": "Lists the machine learning algorithms that have been created.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AlgorithmSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAlgorithmsInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only algorithms created after the specified time\n (timestamp).
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only algorithms created before the specified time\n (timestamp).
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of algorithms to return in the response.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "A string in the algorithm name. This filter returns only algorithms whose name\n contains the specified string.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListAlgorithms request was truncated, the\n response includes a NextToken. To retrieve the next set of algorithms, use\n the token in the next request.
The parameter by which to sort the results. The default is\n CreationTime.
The sort order for the results. The default is Ascending.
>An array of AlgorithmSummary objects, each of which lists an\n algorithm.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAliasesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Lists the aliases of a specified image or image version.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SageMakerImageVersionAliases", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAliasesRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image.
", + "smithy.api#required": {} + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "The alias of the image version.
" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of aliases to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous call to ListAliases didn't return the full set of\n aliases, the call returns a token for retrieving the next set of aliases.
A list of SageMaker AI image version aliases.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of aliases, if more aliases exist.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAppImageConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAppImageConfigsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAppImageConfigsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the AppImageConfigs in your account and their properties. The list can be\n filtered by creation time or modified time, and whether the AppImageConfig name contains\n a specified string.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AppImageConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAppImageConfigsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
If the previous call to ListImages didn't return the full set of\n AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
A filter that returns only AppImageConfigs whose name contains the specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only AppImageConfigs created on or before the specified time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only AppImageConfigs created on or after the specified time.
" + } + }, + "ModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only AppImageConfigs modified on or before the specified time.
" + } + }, + "ModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only AppImageConfigs modified on or after the specified time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#AppImageConfigSortKey", + "traits": { + "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
A token for getting the next set of AppImageConfigs, if there are any.
" + } + }, + "AppImageConfigs": { + "target": "com.amazonaws.sagemaker#AppImageConfigList", + "traits": { + "smithy.api#documentation": "A list of AppImageConfigs and their properties.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListApps": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAppsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAppsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists apps.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Apps", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAppsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
The sort order for the results. The default is Ascending.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#AppSortKey", + "traits": { + "smithy.api#documentation": "The parameter by which to sort the results. The default is CreationTime.
" + } + }, + "DomainIdEquals": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "A parameter to search for the domain ID.
" + } + }, + "UserProfileNameEquals": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "A parameter to search by user profile name. If SpaceNameEquals is set, then\n this value cannot be set.
A parameter to search by space name. If UserProfileNameEquals is set, then\n this value cannot be set.
The list of apps.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListArtifacts": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListArtifactsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListArtifactsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Lists the artifacts in your account and their properties.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ArtifactSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListArtifactsRequest": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#documentation": "A filter that returns only artifacts with the specified source URI.
" + } + }, + "ArtifactType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "A filter that returns only artifacts of the specified type.
" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only artifacts created on or after the specified time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only artifacts created on or before the specified time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortArtifactsBy", + "traits": { + "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListArtifacts didn't return the full set of artifacts,\n the call returns a token for getting the next set of artifacts.
The maximum number of artifacts to return in the response. The default value is 10.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListArtifactsResponse": { + "type": "structure", + "members": { + "ArtifactSummaries": { + "target": "com.amazonaws.sagemaker#ArtifactSummaries", + "traits": { + "smithy.api#documentation": "A list of artifacts and their properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of artifacts, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Lists the associations in your account and their properties.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssociationSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAssociationsRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "A filter that returns only associations with the specified source ARN.
" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
" + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "A filter that returns only associations with the specified source type.
" + } + }, + "DestinationType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "A filter that returns only associations with the specified destination type.
" + } + }, + "AssociationType": { + "target": "com.amazonaws.sagemaker#AssociationEdgeType", + "traits": { + "smithy.api#documentation": "A filter that returns only associations of the specified type.
" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only associations created on or after the specified time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only associations created on or before the specified time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortAssociationsBy", + "traits": { + "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListAssociations didn't return the full set of associations,\n the call returns a token for getting the next set of associations.
The maximum number of associations to return in the response. The default value is 10.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListAssociationsResponse": { + "type": "structure", + "members": { + "AssociationSummaries": { + "target": "com.amazonaws.sagemaker#AssociationSummaries", + "traits": { + "smithy.api#documentation": "A list of associations and their properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of associations, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListAutoMLJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAutoMLJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAutoMLJobsResponse" + }, + "traits": { + "smithy.api#documentation": "Request a list of jobs.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AutoMLJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAutoMLJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Request a list of jobs, using a filter for time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Request a list of jobs, using a filter for time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Request a list of jobs, using a filter for time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Request a list of jobs, using a filter for time.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#AutoMLNameContains", + "traits": { + "smithy.api#documentation": "Request a list of jobs, using a search filter for name.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "traits": { + "smithy.api#documentation": "Request a list of jobs, using a filter for status.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#AutoMLSortOrder", + "traits": { + "smithy.api#documentation": "The sort order for the results. The default is Descending.
The parameter by which to sort the results. The default is Name.
Request a list of jobs up to a specified limit.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListAutoMLJobsResponse": { + "type": "structure", + "members": { + "AutoMLJobSummaries": { + "target": "com.amazonaws.sagemaker#AutoMLJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Returns a summary list of jobs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListCandidatesForAutoMLJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "List the candidates created for the job.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Candidates", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobRequest": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List the candidates created for the job by providing the job's name.
", + "smithy.api#required": {} + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#CandidateStatus", + "traits": { + "smithy.api#documentation": "List the candidates for the job and filter by status.
" + } + }, + "CandidateNameEquals": { + "target": "com.amazonaws.sagemaker#CandidateName", + "traits": { + "smithy.api#documentation": "List the candidates for the job and filter by candidate name.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#AutoMLSortOrder", + "traits": { + "smithy.api#documentation": "The sort order for the results. The default is Ascending.
The parameter by which to sort the results. The default is\n Descending.
List the job's candidates up to a specified limit.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobResponse": { + "type": "structure", + "members": { + "Candidates": { + "target": "com.amazonaws.sagemaker#AutoMLCandidates", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Summaries about the AutoMLCandidates.
If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListClusterNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClusterNodesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClusterNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the list of instances (also called nodes interchangeably)\n in a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#ListClusterNodesRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the\n list of nodes.
", + "smithy.api#required": {} + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time.\n Timestamps are formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
A filter that returns the instance groups whose name contain a specified string.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of nodes to return in the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListClusterNodes request was truncated, the\n response includes a NextToken. To retrieve the next set of cluster nodes, use\n the token in the next request.
The field by which to sort results. The default value is\n CREATION_TIME.
The sort order for results. The default value is Ascending.
The next token specified for listing instances in a SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + }, + "ClusterNodeSummaries": { + "target": "com.amazonaws.sagemaker#ClusterNodeSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The summaries of listed instances in a SageMaker HyperPod cluster
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListClusterSchedulerConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClusterSchedulerConfigsResponse" + }, + "traits": { + "smithy.api#documentation": "List the cluster policy configurations.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClusterSchedulerConfigSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListClusterSchedulerConfigsRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "Filter for name containing this string.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "Filter for ARN of the cluster.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#documentation": "Filter for status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortClusterSchedulerConfigBy", + "traits": { + "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of cluster policies to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClusterSchedulerConfigsResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigSummaries": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigSummaryList", + "traits": { + "smithy.api#documentation": "Summaries of the cluster policies.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClustersRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClustersResponse" + }, + "traits": { + "smithy.api#documentation": "Retrieves the list of SageMaker HyperPod clusters.
" + } + }, + "com.amazonaws.sagemaker#ListClustersRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Set a start time for the time range during which you want to list SageMaker HyperPod clusters.\n Timestamps are formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
Set the maximum number of SageMaker HyperPod clusters to list.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Set the maximum number of instances to print in the list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "Set the next token to retrieve the list of SageMaker HyperPod clusters.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ClusterSortBy", + "traits": { + "smithy.api#documentation": "The field by which to sort results. The default value is\n CREATION_TIME.
The sort order for results. The default value is Ascending.
The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about\n reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
If the result of the previous ListClusters request was truncated, the\n response includes a NextToken. To retrieve the next set of clusters, use the\n token in the next request.
The summaries of listed SageMaker HyperPod clusters.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListCodeRepositories": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListCodeRepositoriesInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListCodeRepositoriesOutput" + }, + "traits": { + "smithy.api#documentation": "Gets a list of the Git repositories in your account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CodeRepositorySummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListCodeRepositoriesInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only Git repositories that were created after the specified\n time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only Git repositories that were created before the specified\n time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only Git repositories that were last modified after the\n specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only Git repositories that were last modified before the\n specified time.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of Git repositories to return in the response.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameContains", + "traits": { + "smithy.api#documentation": "A string in the Git repositories name. This filter returns only repositories whose\n name contains the specified string.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.
The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:
\nName
\nAmazon Resource Name (ARN)
\nCreation time
\nLast modified time
\nConfiguration information, including the URL location of the repository and\n the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.
\nIf the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.
Lists model compilation jobs that satisfy various filters.
\nTo create a model compilation job, use CreateCompilationJob. To get information about a particular model\n compilation job you have created, use DescribeCompilationJob.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CompilationJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListCompilationJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.
The maximum number of model compilation jobs to return in the response.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns the model compilation jobs that were created after a specified\n time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns the model compilation jobs that were created before a specified\n time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns the model compilation jobs that were modified after a specified\n time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns the model compilation jobs that were modified before a specified\n time.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "A filter that returns the model compilation jobs whose name contains a specified\n string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#CompilationJobStatus", + "traits": { + "smithy.api#documentation": "A filter that retrieves model compilation jobs with a specific\n CompilationJobStatus status.
The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of CompilationJobSummary objects, each describing a model compilation job.\n
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon SageMaker AI returns this NextToken. To retrieve\n the next set of model compilation jobs, use this token in the next request.
List the resource allocation definitions.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ComputeQuotaSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListComputeQuotasRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "Filter for name containing this string.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SchedulerResourceStatus", + "traits": { + "smithy.api#documentation": "Filter for status.
" + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#documentation": "Filter for ARN of the cluster.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortQuotaBy", + "traits": { + "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of compute allocation definitions to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListComputeQuotasResponse": { + "type": "structure", + "members": { + "ComputeQuotaSummaries": { + "target": "com.amazonaws.sagemaker#ComputeQuotaSummaryList", + "traits": { + "smithy.api#documentation": "Summaries of the compute allocation definitions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListContexts": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListContextsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListContextsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Lists the contexts in your account and their properties.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ContextSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListContextsRequest": { + "type": "structure", + "members": { + "SourceUri": { + "target": "com.amazonaws.sagemaker#SourceUri", + "traits": { + "smithy.api#documentation": "A filter that returns only contexts with the specified source URI.
" + } + }, + "ContextType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "A filter that returns only contexts of the specified type.
" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only contexts created on or after the specified time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only contexts created on or before the specified time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortContextsBy", + "traits": { + "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListContexts didn't return the full set of contexts,\n the call returns a token for getting the next set of contexts.
The maximum number of contexts to return in the response. The default value is 10.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListContextsResponse": { + "type": "structure", + "members": { + "ContextSummaries": { + "target": "com.amazonaws.sagemaker#ContextSummaries", + "traits": { + "smithy.api#documentation": "A list of contexts and their properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of contexts, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListDataQualityJobDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the data quality job definitions in your account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "A filter that lists the data quality job definitions associated with the specified\n endpoint.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
If the result of the previous ListDataQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of\n transform jobs, use the token in the next request.>
The maximum number of data quality monitoring job definitions to return in the\n response.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "A string in the data quality monitoring job definition name. This filter returns only\n data quality monitoring job definitions whose name contains the specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only data quality monitoring job definitions created before the\n specified time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only data quality monitoring job definitions created after the\n specified time.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListDataQualityJobDefinitionsResponse": { + "type": "structure", + "members": { + "JobDefinitionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of data quality monitoring job definitions.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListDataQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of data\n quality monitoring job definitions, use the token in the next request.
Returns a list of devices in the fleet.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DeviceFleetSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListDeviceFleetsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to select.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter fleets where packaging job was created after specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter fleets where the edge packaging job was created before specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Select fleets where the job was updated after X
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Select fleets where the job was updated before X
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Filter for fleets containing this name in their fleet device name.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListDeviceFleetsSortBy", + "traits": { + "smithy.api#documentation": "The column to sort by.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "What direction to sort in.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListDeviceFleetsResponse": { + "type": "structure", + "members": { + "DeviceFleetSummaries": { + "target": "com.amazonaws.sagemaker#DeviceFleetSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Summary of the device fleet.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListDeviceFleetsSortBy": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + } + } + }, + "com.amazonaws.sagemaker#ListDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListDevicesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListDevicesResponse" + }, + "traits": { + "smithy.api#documentation": "A list of devices.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DeviceSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListDevicesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of results to select.
" + } + }, + "LatestHeartbeatAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Select fleets where the job was updated after X
" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "A filter that searches devices that contains this name in any of their models.
" + } + }, + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "Filter for fleets containing this name in their device fleet name.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListDevicesResponse": { + "type": "structure", + "members": { + "DeviceSummaries": { + "target": "com.amazonaws.sagemaker#DeviceSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Summary of devices.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListDomainsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListDomainsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the domains.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Domains", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListDomainsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
The list of domains.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListEdgeDeploymentPlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansResponse" + }, + "traits": { + "smithy.api#documentation": "Lists all edge deployment plans.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EdgeDeploymentPlanSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListEdgeDeploymentPlansRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The response from the last list when returning a list large enough to need\n tokening.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to select (50 by default).
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Selects edge deployment plans created after this time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Selects edge deployment plans created before this time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Selects edge deployment plans that were last updated after this time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Selects edge deployment plans that were last updated before this time.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Selects edge deployment plans with names containing this name.
" + } + }, + "DeviceFleetNameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Selects edge deployment plans with a device fleet name containing this name.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansSortBy", + "traits": { + "smithy.api#documentation": "The column by which to sort the edge deployment plans. Can be one of\n NAME, DEVICEFLEETNAME, CREATIONTIME,\n LASTMODIFIEDTIME.
The direction of the sorting (ascending or descending).
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListEdgeDeploymentPlansResponse": { + "type": "structure", + "members": { + "EdgeDeploymentPlanSummaries": { + "target": "com.amazonaws.sagemaker#EdgeDeploymentPlanSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List of summaries of edge deployment plans.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The token to use when calling the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListEdgeDeploymentPlansSortBy": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "DeviceFleetName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVICE_FLEET_NAME" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + } + } + }, + "com.amazonaws.sagemaker#ListEdgePackagingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListEdgePackagingJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListEdgePackagingJobsResponse" + }, + "traits": { + "smithy.api#documentation": "Returns a list of edge packaging jobs.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EdgePackagingJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListEdgePackagingJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of results to select.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Select jobs where the job was created after specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Select jobs where the job was created before specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Select jobs where the job was updated after specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Select jobs where the job was updated before specified time.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Filter for jobs containing this name in their packaging job name.
" + } + }, + "ModelNameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Filter for jobs where the model name contains this string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobStatus", + "traits": { + "smithy.api#documentation": "The job status to filter for.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListEdgePackagingJobsSortBy", + "traits": { + "smithy.api#documentation": "Use to specify what column to sort by.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "What direction to sort by.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListEdgePackagingJobsResponse": { + "type": "structure", + "members": { + "EdgePackagingJobSummaries": { + "target": "com.amazonaws.sagemaker#EdgePackagingJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Summaries of edge packaging jobs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "Token to use when calling the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListEdgePackagingJobsSortBy": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "ModelName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_NAME" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_TIME" + } + }, + "EdgePackagingJobStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + } + } + }, + "com.amazonaws.sagemaker#ListEndpointConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListEndpointConfigsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListEndpointConfigsOutput" + }, + "traits": { + "smithy.api#documentation": "Lists endpoint configurations.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EndpointConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListEndpointConfigsInput": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#EndpointConfigSortKey", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
If the result of the previous ListEndpointConfig request was\n truncated, the response includes a NextToken. To retrieve the next set of\n endpoint configurations, use the token in the next request.
The maximum number of training jobs to return in the response.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EndpointConfigNameContains", + "traits": { + "smithy.api#documentation": "A string in the endpoint configuration name. This filter returns only endpoint\n configurations whose name contains the specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only endpoint configurations created before the specified\n time (timestamp).
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only endpoint configurations with a creation time greater\n than or equal to the specified time (timestamp).
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListEndpointConfigsOutput": { + "type": "structure", + "members": { + "EndpointConfigs": { + "target": "com.amazonaws.sagemaker#EndpointConfigSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of endpoint configurations.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n endpoint configurations, use it in the subsequent request
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListEndpointsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListEndpointsOutput" + }, + "traits": { + "smithy.api#documentation": "Lists endpoints.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Endpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListEndpointsInput": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#EndpointSortKey", + "traits": { + "smithy.api#documentation": "Sorts the list of results. The default is CreationTime.
The sort order for results. The default is Descending.
If the result of a ListEndpoints request was truncated, the response\n includes a NextToken. To retrieve the next set of endpoints, use the token\n in the next request.
The maximum number of endpoints to return in the response. This value defaults to\n 10.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EndpointNameContains", + "traits": { + "smithy.api#documentation": "A string in endpoint names. This filter returns only endpoints whose name contains\n the specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only endpoints that were created before the specified time\n (timestamp).
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only endpoints with a creation time greater than or equal to\n the specified time (timestamp).
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only endpoints that were modified before the specified\n timestamp.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only endpoints that were modified after the specified\n timestamp.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#documentation": "A filter that returns only endpoints with the specified status.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListEndpointsOutput": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.sagemaker#EndpointSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array or endpoint objects.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListExperiments": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListExperimentsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListExperimentsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists all the experiments in your account. The list can be filtered to show only\n experiments that were created in a specific time range. The list can be sorted by experiment\n name or creation time.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ExperimentSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListExperimentsRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only experiments created after the specified time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only experiments created before the specified time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortExperimentsBy", + "traits": { + "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListExperiments didn't return the full set of\n experiments, the call returns a token for getting the next set of experiments.
The maximum number of experiments to return in the response. The default value is\n 10.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListExperimentsResponse": { + "type": "structure", + "members": { + "ExperimentSummaries": { + "target": "com.amazonaws.sagemaker#ExperimentSummaries", + "traits": { + "smithy.api#documentation": "A list of the summaries of your experiments.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of experiments, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListFeatureGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListFeatureGroupsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListFeatureGroupsResponse" + }, + "traits": { + "smithy.api#documentation": "List FeatureGroups based on given filter and order.
A string that partially matches one or more FeatureGroups names. Filters\n FeatureGroups by name.
A FeatureGroup status. Filters by FeatureGroup status.
An OfflineStore status. Filters by OfflineStore status.\n
Use this parameter to search for FeatureGroupss created after a specific\n date and time.
Use this parameter to search for FeatureGroupss created before a specific\n date and time.
The order in which feature groups are listed.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#FeatureGroupSortBy", + "traits": { + "smithy.api#documentation": "The value on which the feature group list is sorted.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#FeatureGroupMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results returned by ListFeatureGroups.
A token to resume pagination of ListFeatureGroups results.
A summary of feature groups.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token to resume pagination of ListFeatureGroups results.
Returns information about the flow definitions in your account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FlowDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListFlowDefinitionsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only flow definitions that were created before the specified timestamp.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A token to resume pagination.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
An array of objects describing the flow definitions.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token to resume pagination.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHubContentVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHubContentVersionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHubContentVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "List hub content versions.
" + } + }, + "com.amazonaws.sagemaker#ListHubContentVersionsRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub to list the content versions of.
", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of hub content to list versions of.
", + "smithy.api#required": {} + } + }, + "HubContentName": { + "target": "com.amazonaws.sagemaker#HubContentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub content.
", + "smithy.api#required": {} + } + }, + "MinVersion": { + "target": "com.amazonaws.sagemaker#HubContentVersion", + "traits": { + "smithy.api#documentation": "The lower bound of the hub content versions to list.
" + } + }, + "MaxSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#documentation": "The upper bound of the hub content schema version.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list hub content versions that were created before the time specified.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list hub content versions that were created after the time specified.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#HubContentSortBy", + "traits": { + "smithy.api#documentation": "Sort hub content versions by either name or creation time.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "Sort hub content versions by ascending or descending order.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of hub content versions to list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.
The summaries of the listed hub content versions.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHubContents": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHubContentsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHubContentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "List the contents of a hub.
" + } + }, + "com.amazonaws.sagemaker#ListHubContentsRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub to list the contents of.
", + "smithy.api#required": {} + } + }, + "HubContentType": { + "target": "com.amazonaws.sagemaker#HubContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of hub content to list.
", + "smithy.api#required": {} + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Only list hub content if the name contains the specified string.
" + } + }, + "MaxSchemaVersion": { + "target": "com.amazonaws.sagemaker#DocumentSchemaVersion", + "traits": { + "smithy.api#documentation": "The upper bound of the hub content schema verion.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list hub content that was created before the time specified.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list hub content that was created after the time specified.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#HubContentSortBy", + "traits": { + "smithy.api#documentation": "Sort hub content versions by either name or creation time.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "Sort hubs by ascending or descending order.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum amount of hub content to list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.
The summaries of the listed hub content.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHubs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHubsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHubsResponse" + }, + "traits": { + "smithy.api#documentation": "List all existing hubs.
" + } + }, + "com.amazonaws.sagemaker#ListHubsRequest": { + "type": "structure", + "members": { + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Only list hubs with names that contain the specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list hubs that were created before the time specified.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list hubs that were created after the time specified.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list hubs that were last modified before the time specified.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list hubs that were last modified after the time specified.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#HubSortBy", + "traits": { + "smithy.api#documentation": "Sort hubs by either name or creation time.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "Sort hubs by ascending or descending order.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of hubs to list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.
The summaries of the listed hubs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHumanTaskUis": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHumanTaskUisRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHumanTaskUisResponse" + }, + "traits": { + "smithy.api#documentation": "Returns information about the human task user interfaces in your account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HumanTaskUiSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListHumanTaskUisRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only human task user interfaces that were created before the specified timestamp.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A token to resume pagination.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
An array of objects describing the human task user interfaces.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token to resume pagination.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListHyperParameterTuningJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListHyperParameterTuningJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListHyperParameterTuningJobsResponse" + }, + "traits": { + "smithy.api#documentation": "Gets a list of HyperParameterTuningJobSummary objects that\n describe\n the hyperparameter tuning jobs launched in your account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HyperParameterTuningJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListHyperParameterTuningJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListHyperParameterTuningJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n tuning jobs, use the token in the next request.
The\n maximum number of tuning jobs to return. The default value is\n 10.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSortByOptions", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
A string in the tuning job name. This filter returns only tuning jobs whose name\n contains the specified string.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only tuning jobs that were created after the specified\n time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only tuning jobs that were created before the specified\n time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only tuning jobs that were modified after the specified\n time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only tuning jobs that were modified before the specified\n time.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "traits": { + "smithy.api#documentation": "A filter that returns only tuning jobs with the specified status.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListHyperParameterTuningJobsResponse": { + "type": "structure", + "members": { + "HyperParameterTuningJobSummaries": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of HyperParameterTuningJobSummary objects that\n describe\n the tuning jobs that the ListHyperParameterTuningJobs\n request returned.
If the result of this ListHyperParameterTuningJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of tuning jobs,\n use the token in the next request.
Lists the versions of a specified image and their properties. The list can be filtered\n by creation time or modified time.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImageVersions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListImageVersionsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only versions created on or after the specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only versions created on or before the specified time.
" + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image to list the versions of.
", + "smithy.api#required": {} + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only versions modified on or after the specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only versions modified on or before the specified time.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of versions to return in the response. The default value is 10.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous call to ListImageVersions didn't return the full set of\n versions, the call returns a token for getting the next set of versions.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
A list of versions and their properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of versions, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListImagesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListImagesResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the images in your account and their properties. The list can be filtered by\n creation time or modified time, and whether the image name contains a specified string.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Images", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListImagesRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only images created on or after the specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only images created on or before the specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only images modified on or after the specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only images modified on or before the specified time.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of images to return in the response. The default value is 10.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#ImageNameContains", + "traits": { + "smithy.api#documentation": "A filter that returns only images whose name contains the specified string.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous call to ListImages didn't return the full set of images,\n the call returns a token for getting the next set of images.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
A list of images and their properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of images, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceComponentsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceComponentsOutput" + }, + "traits": { + "smithy.api#documentation": "Lists the inference components in your account and their properties.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InferenceComponents", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceComponentsInput": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#InferenceComponentSortKey", + "traits": { + "smithy.api#documentation": "The field by which to sort the inference components in the response. The default is\n CreationTime.
The sort order for results. The default is Descending.
A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of inference components to return in the response. This value\n defaults to 10.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#InferenceComponentNameContains", + "traits": { + "smithy.api#documentation": "Filters the results to only those inference components with a name that contains the\n specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filters the results to only those inference components that were created before the\n specified time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filters the results to only those inference components that were created after the\n specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filters the results to only those inference components that were updated before the\n specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filters the results to only those inference components that were updated after the\n specified time.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "Filters the results to only those inference components with the specified status.
" + } + }, + "EndpointNameEquals": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "An endpoint name to filter the listed inference components. The response includes only\n those inference components that are hosted at the specified endpoint.
" + } + }, + "VariantNameEquals": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "A production variant name to filter the listed inference components. The response\n includes only those inference components that are hosted at the specified variant.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceComponentsOutput": { + "type": "structure", + "members": { + "InferenceComponents": { + "target": "com.amazonaws.sagemaker#InferenceComponentSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of inference components and their properties that matches any of the filters you\n specified in the request.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results following a\n truncated response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceExperiments": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceExperimentsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceExperimentsResponse" + }, + "traits": { + "smithy.api#documentation": "Returns the list of all inference experiments.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InferenceExperiments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceExperimentsRequest": { + "type": "structure", + "members": { + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Selects inference experiments whose names contain this name.
" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#InferenceExperimentType", + "traits": { + "smithy.api#documentation": "\n Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.\n
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", + "traits": { + "smithy.api#documentation": "\n Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.\n
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Selects inference experiments which were created after this timestamp.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Selects inference experiments which were created before this timestamp.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Selects inference experiments which were last modified after this timestamp.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Selects inference experiments which were last modified before this timestamp.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortInferenceExperimentsBy", + "traits": { + "smithy.api#documentation": "The column by which to sort the listed inference experiments.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "The direction of sorting (ascending or descending).
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "\n The response from the last list when returning a list large enough to need tokening.\n
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to select.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceExperimentsResponse": { + "type": "structure", + "members": { + "InferenceExperiments": { + "target": "com.amazonaws.sagemaker#InferenceExperimentList", + "traits": { + "smithy.api#documentation": "List of inference experiments.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The token to use when calling the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobSteps": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the subtasks for an Inference Recommender job.
\nThe supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Steps", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name for the Inference Recommender job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#documentation": "A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
" + } + }, + "StepType": { + "target": "com.amazonaws.sagemaker#RecommendationStepType", + "traits": { + "smithy.api#documentation": "A filter to return details about the specified type of subtask.
\n\n BENCHMARK: Evaluate the performance of your model on different instance types.
The maximum number of results to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobStepsResponse": { + "type": "structure", + "members": { + "Steps": { + "target": "com.amazonaws.sagemaker#InferenceRecommendationsJobSteps", + "traits": { + "smithy.api#documentation": "A list of all subtask details in Inference Recommender.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token that you can specify in your next request to return more results from the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists recommendation jobs that satisfy various filters.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InferenceRecommendationsJobs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs created after the specified time (timestamp).
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs created before the specified time (timestamp).
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs that were last modified after the specified time (timestamp).
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs that were last modified before the specified time (timestamp).
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "A string in the job name. This filter returns only recommendations whose name contains the specified string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#documentation": "A filter that retrieves only inference recommendations jobs with a specific status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsSortBy", + "traits": { + "smithy.api#documentation": "The parameter by which to sort the results.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order for the results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListInferenceRecommendationsJobsRequest request \n was truncated, the response includes a NextToken. To retrieve the next set \n of recommendations, use the token in the next request.
The maximum number of recommendations to return in the response.
" + } + }, + "ModelNameEquals": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs that were created for this model.
" + } + }, + "ModelPackageVersionArnEquals": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs that were created for this versioned model package.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsResponse": { + "type": "structure", + "members": { + "InferenceRecommendationsJobs": { + "target": "com.amazonaws.sagemaker#InferenceRecommendationsJobs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The recommendations created from the Amazon SageMaker Inference Recommender job.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of recommendations, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#ListLabelingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsResponse" + }, + "traits": { + "smithy.api#documentation": "Gets a list of labeling jobs.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LabelingJobSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsForWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of labeling jobs assigned to a specified work team.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LabelingJobSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team for which you want to see labeling\n jobs for.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of labeling jobs to return in each page of the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListLabelingJobsForWorkteam request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.
A filter that returns only labeling jobs created after the specified time\n (timestamp).
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only labeling jobs created before the specified time\n (timestamp).
" + } + }, + "JobReferenceCodeContains": { + "target": "com.amazonaws.sagemaker#JobReferenceCodeContains", + "traits": { + "smithy.api#documentation": "A filter the limits jobs to only the ones whose job reference code contains the\n specified string.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamSortByOptions", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of LabelingJobSummary objects, each describing a labeling\n job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamSortByOptions": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only labeling jobs created after the specified time\n (timestamp).
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only labeling jobs created before the specified time\n (timestamp).
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only labeling jobs modified after the specified time\n (timestamp).
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only labeling jobs modified before the specified time\n (timestamp).
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of labeling jobs to return in each page of the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListLabelingJobs request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.
A string in the labeling job name. This filter returns only labeling jobs whose name\n contains the specified string.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that retrieves only labeling jobs with a specific status.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListLabelingJobsResponse": { + "type": "structure", + "members": { + "LabelingJobSummaryList": { + "target": "com.amazonaws.sagemaker#LabelingJobSummaryList", + "traits": { + "smithy.api#documentation": "An array of LabelingJobSummary objects, each describing a labeling\n job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListLineageEntityParameterKey": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#StringParameterValue" + } + }, + "com.amazonaws.sagemaker#ListLineageGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListLineageGroupsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListLineageGroupsResponse" + }, + "traits": { + "smithy.api#documentation": "A list of lineage groups shared with your Amazon Web Services account. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LineageGroupSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListLineageGroupsRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp to filter against lineage groups created after a certain point in time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp to filter against lineage groups created before a certain point in time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortLineageGroupsBy", + "traits": { + "smithy.api#documentation": "The parameter by which to sort the results. The default is\n CreationTime.
The sort order for the results. The default is Ascending.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of endpoints to return in the response. This value defaults to\n 10.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListLineageGroupsResponse": { + "type": "structure", + "members": { + "LineageGroupSummaries": { + "target": "com.amazonaws.sagemaker#LineageGroupSummaries", + "traits": { + "smithy.api#documentation": "A list of lineage groups and their properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServers": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMlflowTrackingServersRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMlflowTrackingServersResponse" + }, + "traits": { + "smithy.api#documentation": "Lists all MLflow Tracking Servers.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrackingServerSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServersRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Use the CreatedAfter filter to only list tracking servers created after a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a\n Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Use the CreatedBefore filter to only list tracking servers created before a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in\n a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Filter for tracking servers with a specified creation status.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "Filter for tracking servers using the specified MLflow version.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortTrackingServerBy", + "traits": { + "smithy.api#documentation": "Filter for trackings servers sorting by name, creation time, or creation status.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. \n To change the list order, you can specify SortOrder to be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of tracking servers to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServersResponse": { + "type": "structure", + "members": { + "TrackingServerSummaries": { + "target": "com.amazonaws.sagemaker#TrackingServerSummaryList", + "traits": { + "smithy.api#documentation": "A list of tracking servers according to chosen filters.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelBiasJobDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists model bias jobs definitions that satisfy various filters.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "Name of the endpoint to monitor for model bias.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", + "traits": { + "smithy.api#documentation": "Whether to sort results by the Name or CreationTime field. \n The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of model bias jobs to return in the response. The default value is\n 10.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Filter for model bias jobs whose name contains a specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only model bias jobs created before a specified time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only model bias jobs created after a specified time.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelBiasJobDefinitionsResponse": { + "type": "structure", + "members": { + "JobDefinitionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A JSON array in which each element is a summary for a model bias jobs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardExportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelCardExportJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelCardExportJobsResponse" + }, + "traits": { + "smithy.api#documentation": "List the export jobs for the Amazon SageMaker Model Card.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelCardExportJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelCardExportJobsRequest": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List export jobs for the model card with the specified name.
", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "List export jobs for the model card with the specified version.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list model card export jobs that were created after the time specified.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list model card export jobs that were created before the time specified.
" + } + }, + "ModelCardExportJobNameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "Only list model card export jobs with names that contain the specified string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", + "traits": { + "smithy.api#documentation": "Only list model card export jobs with the specified status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobSortBy", + "traits": { + "smithy.api#documentation": "Sort model card export jobs by either name or creation time. Sorts by creation time by default.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobSortOrder", + "traits": { + "smithy.api#documentation": "Sort model card export jobs by ascending or descending order.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListModelCardExportJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model card export jobs, use the token in the next request.
The maximum number of model card export jobs to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardExportJobsResponse": { + "type": "structure", + "members": { + "ModelCardExportJobSummaries": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The summaries of the listed model card export jobs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n card export jobs, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelCardVersionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelCardVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "List existing versions of an Amazon SageMaker Model Card.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelCardVersionSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelCardVersionsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list model card versions that were created after the time specified.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list model card versions that were created before the time specified.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of model card versions to list.
" + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List model card versions for the model card with the specified name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "Only list model card versions with the specified approval status.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListModelCardVersions request was truncated,\n the response includes a NextToken. To retrieve the next set of model card\n versions, use the token in the next request.
Sort listed model card versions by version. Sorts by version by default.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ModelCardSortOrder", + "traits": { + "smithy.api#documentation": "Sort model card versions by ascending or descending order.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardVersionsResponse": { + "type": "structure", + "members": { + "ModelCardVersionSummaryList": { + "target": "com.amazonaws.sagemaker#ModelCardVersionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The summaries of the listed versions of the model card.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n card versions, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelCards": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelCardsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelCardsResponse" + }, + "traits": { + "smithy.api#documentation": "List existing model cards.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelCardSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelCardsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list model cards that were created after the time specified.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Only list model cards that were created before the time specified.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of model cards to list.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "Only list model cards with names that contain the specified string.
" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "Only list model cards with the specified approval status.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListModelCards request was truncated, the\n response includes a NextToken. To retrieve the next set of model cards, use\n the token in the next request.
Sort model cards by either name or creation time. Sorts by creation time by default.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#ModelCardSortOrder", + "traits": { + "smithy.api#documentation": "Sort model cards by ascending or descending order.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelCardsResponse": { + "type": "structure", + "members": { + "ModelCardSummaries": { + "target": "com.amazonaws.sagemaker#ModelCardSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The summaries of the listed model cards.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n cards, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists model explainability job definitions that satisfy various filters.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "Name of the endpoint to monitor for model explainability.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", + "traits": { + "smithy.api#documentation": "Whether to sort results by the Name or CreationTime field. \n The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of jobs to return in the response. The default value is 10.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Filter for model explainability jobs whose name contains a specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only model explainability jobs created before a specified\n time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only model explainability jobs created after a specified\n time.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitionsResponse": { + "type": "structure", + "members": { + "JobDefinitionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A JSON array in which each element is a summary for a explainability bias jobs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelMetadataRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelMetadataResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the domain, framework, task, and model name of standard \n machine learning models found in common model zoos.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelMetadataSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelMetadataRequest": { + "type": "structure", + "members": { + "SearchExpression": { + "target": "com.amazonaws.sagemaker#ModelMetadataSearchExpression", + "traits": { + "smithy.api#documentation": "One or more filters that searches for the specified resource or resources \n in a search. All resource objects that satisfy the expression's condition are \n included in the search results. Specify the Framework, FrameworkVersion, Domain \n or Task to filter supported. Filter names and values are case-sensitive.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListModelMetadataResponse request was truncated, \n the response includes a NextToken. To retrieve the next set of model metadata, \n use the token in the next request.
The maximum number of models to return in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelMetadataResponse": { + "type": "structure", + "members": { + "ModelMetadataSummaries": { + "target": "com.amazonaws.sagemaker#ModelMetadataSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A structure that holds model metadata.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of recommendations, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelPackageGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelPackageGroupsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelPackageGroupsOutput" + }, + "traits": { + "smithy.api#documentation": "Gets a list of the model groups in your Amazon Web Services account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelPackageGroupSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelPackageGroupsInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only model groups created after the specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only model groups created before the specified time.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "A string in the model group name. This filter returns only model groups whose name\n contains the specified string.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListModelPackageGroups request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model groups, use the token in the next request.
The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that returns either model groups shared with you or model groups in\n\t your own account. When the value is CrossAccount, the results show\n\t the resources made discoverable to you from other accounts. When the value is\n SameAccount or null, the results show resources from your\n \t account. The default is SameAccount.
A list of summaries of the model groups in your Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set\n of model groups, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelPackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelPackagesInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelPackagesOutput" + }, + "traits": { + "smithy.api#documentation": "Lists the model packages that have been created.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ModelPackageSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelPackagesInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only model packages created after the specified time\n (timestamp).
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only model packages created before the specified time\n (timestamp).
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of model packages to return in the response.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "A string in the model package name. This filter returns only model packages whose name\n contains the specified string.
" + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "A filter that returns only the model packages with the specified approval\n status.
" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#documentation": "A filter that returns only model versions that belong to the specified model group.
" + } + }, + "ModelPackageType": { + "target": "com.amazonaws.sagemaker#ModelPackageType", + "traits": { + "smithy.api#documentation": "A filter that returns only the model packages of the specified type. This can be one\n of the following values.
\n\n UNVERSIONED - List only unversioined models. \n This is the default value if no ModelPackageType is specified.
\n VERSIONED - List only versioned models.
\n BOTH - List both versioned and unversioned models.
If the response to a previous ListModelPackages request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n packages, use the token in the next request.
The parameter by which to sort the results. The default is\n CreationTime.
The sort order for the results. The default is Ascending.
An array of ModelPackageSummary objects, each of which lists a model\n package.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n model packages, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModelQualityJobDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsResponse" + }, + "traits": { + "smithy.api#documentation": "Gets a list of model quality monitoring job definitions in your account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobDefinitionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions that are associated\n with the specified endpoint.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
If the result of the previous ListModelQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model quality monitoring job definitions, use the token in the next request.
The maximum number of results to return in a call to\n ListModelQualityJobDefinitions.
A string in the transform job name. This filter returns only model quality monitoring\n job definitions whose name contains the specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions created before the\n specified time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions created after the\n specified time.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelQualityJobDefinitionsResponse": { + "type": "structure", + "members": { + "JobDefinitionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of summaries of model quality monitoring job definitions.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the\n next set of model quality monitoring job definitions, use it in the next request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelsOutput" + }, + "traits": { + "smithy.api#documentation": "Lists models created with the CreateModel API.
Sorts the list of results. The default is CreationTime.
The sort order for results. The default is Descending.
If the response to a previous ListModels request was truncated, the\n response includes a NextToken. To retrieve the next set of models, use the\n token in the next request.
The maximum number of models to return in the response.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#ModelNameContains", + "traits": { + "smithy.api#documentation": "A string in the model name. This filter returns only models whose name contains the\n specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only models created before the specified time\n (timestamp).
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only models with a creation time greater than or equal to the\n specified time (timestamp).
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListModelsOutput": { + "type": "structure", + "members": { + "Models": { + "target": "com.amazonaws.sagemaker#ModelSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of ModelSummary objects, each of which lists a\n model.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n models, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMonitoringAlertHistoryRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMonitoringAlertHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of past alerts in a model monitoring schedule.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MonitoringAlertHistory", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertHistoryRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#documentation": "The name of a monitoring schedule.
" + } + }, + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#documentation": "The name of a monitoring alert.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringAlertHistorySortKey", + "traits": { + "smithy.api#documentation": "The field used to sort results. The default is CreationTime.
The sort order, whether Ascending or Descending, of the alert\n history. The default is Descending.
If the result of the previous ListMonitoringAlertHistory request was\n truncated, the response includes a NextToken. To retrieve the next set of\n alerts in the history, use the token in the next request.
The maximum number of results to display. The default is 100.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only alerts created on or before the specified time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only alerts created on or after the specified time.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#MonitoringAlertStatus", + "traits": { + "smithy.api#documentation": "A filter that retrieves only alerts with a specific status.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertHistoryResponse": { + "type": "structure", + "members": { + "MonitoringAlertHistory": { + "target": "com.amazonaws.sagemaker#MonitoringAlertHistoryList", + "traits": { + "smithy.api#documentation": "An alert history for a model monitoring schedule.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n alerts, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlerts": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMonitoringAlertsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMonitoringAlertsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets the alerts for a single monitoring schedule.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MonitoringAlertSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertsRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of a monitoring schedule.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListMonitoringAlerts request was truncated,\n the response includes a NextToken. To retrieve the next set of alerts in the\n history, use the token in the next request.
The maximum number of results to display. The default is 100.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringAlertsResponse": { + "type": "structure", + "members": { + "MonitoringAlertSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringAlertSummaryList", + "traits": { + "smithy.api#documentation": "A JSON array where each element is a summary for a monitoring alert.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n alerts, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMonitoringExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMonitoringExecutionsResponse" + }, + "traits": { + "smithy.api#documentation": "Returns list of all monitoring job executions.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MonitoringExecutionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMonitoringExecutionsRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#documentation": "Name of a specific schedule to fetch jobs for.
" + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "Name of a specific endpoint to fetch jobs for.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSortKey", + "traits": { + "smithy.api#documentation": "Whether to sort the results by the Status, CreationTime, or \n ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of jobs to return in the response. The default value is 10.
" + } + }, + "ScheduledTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for jobs scheduled before a specified time.
" + } + }, + "ScheduledTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter for jobs scheduled after a specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs created before a specified time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs created after a specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs modified after a specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs modified before a specified time.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ExecutionStatus", + "traits": { + "smithy.api#documentation": "A filter that retrieves only jobs with a specific status.
" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "Gets a list of the monitoring job runs of the specified monitoring job\n definitions.
" + } + }, + "MonitoringTypeEquals": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "A filter that returns only the monitoring job runs of the specified monitoring\n type.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringExecutionsResponse": { + "type": "structure", + "members": { + "MonitoringExecutionSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A JSON array in which each element is a summary for a monitoring execution.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListMonitoringSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListMonitoringSchedulesResponse" + }, + "traits": { + "smithy.api#documentation": "Returns list of all monitoring schedules.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MonitoringScheduleSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMonitoringSchedulesRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "Name of a specific endpoint to fetch schedules for.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleSortKey", + "traits": { + "smithy.api#documentation": "Whether to sort the results by the Status, CreationTime, or \n ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of jobs to return in the response. The default value is 10.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Filter for monitoring schedules whose name contains a specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only monitoring schedules created before a specified time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only monitoring schedules created after a specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only monitoring schedules modified before a specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only monitoring schedules modified after a specified time.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#documentation": "A filter that returns only monitoring schedules modified before a specified time.
" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "Gets a list of the monitoring schedules for the specified monitoring job\n definition.
" + } + }, + "MonitoringTypeEquals": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "A filter that returns only the monitoring schedules for the specified monitoring\n type.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMonitoringSchedulesResponse": { + "type": "structure", + "members": { + "MonitoringScheduleSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A JSON array in which each element is a summary for a monitoring schedule.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsOutput" + }, + "traits": { + "smithy.api#documentation": "Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NotebookInstanceLifecycleConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of a ListNotebookInstanceLifecycleConfigs request was\n truncated, the response includes a NextToken. To get the next set of\n lifecycle configurations, use the token in the next request.
The maximum number of lifecycle configurations to return in the response.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortKey", + "traits": { + "smithy.api#documentation": "Sorts the list of results. The default is CreationTime.
The sort order for results.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigNameContains", + "traits": { + "smithy.api#documentation": "A string in the lifecycle configuration name. This filter returns only lifecycle\n configurations whose name contains the specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only lifecycle configurations that were created before the\n specified time (timestamp).
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only lifecycle configurations that were created after the\n specified time (timestamp).
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns only lifecycle configurations that were modified before the\n specified time (timestamp).
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns only lifecycle configurations that were modified after the\n specified time (timestamp).
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker AI returns this token. To get the next\n set of lifecycle configurations, use it in the next request.
" + } + }, + "NotebookInstanceLifecycleConfigs": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummaryList", + "traits": { + "smithy.api#documentation": "An array of NotebookInstanceLifecycleConfiguration objects, each listing\n a lifecycle configuration.
Returns a list of the SageMaker AI notebook instances in the requester's\n account in an Amazon Web Services Region.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NotebookInstances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListNotebookInstancesInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": " If the previous call to the ListNotebookInstances is truncated, the\n response includes a NextToken. You can use this token in your subsequent\n ListNotebookInstances request to fetch the next set of notebook\n instances.
You might specify a filter or a sort order in your request. When response is\n truncated, you must use the same values for the filer and sort order in the next\n request.
\nThe maximum number of notebook instances to return.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#NotebookInstanceSortKey", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is Name.
The sort order for results.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NotebookInstanceNameContains", + "traits": { + "smithy.api#documentation": "A string in the notebook instances' name. This filter returns only notebook\n instances whose name contains the specified string.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only notebook instances that were created before the\n specified time (timestamp).
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only notebook instances that were created after the specified\n time (timestamp).
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns only notebook instances that were modified before the\n specified time (timestamp).
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns only notebook instances that were modified after the\n specified time (timestamp).
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "traits": { + "smithy.api#documentation": "A filter that returns only notebook instances with the specified status.
" + } + }, + "NotebookInstanceLifecycleConfigNameContains": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "A string in the name of a notebook instances lifecycle configuration associated with\n this notebook instance. This filter returns only notebook instances associated with a\n lifecycle configuration with a name that contains the specified string.
" + } + }, + "DefaultCodeRepositoryContains": { + "target": "com.amazonaws.sagemaker#CodeRepositoryContains", + "traits": { + "smithy.api#documentation": "A string in the name or URL of a Git repository associated with this notebook\n instance. This filter returns only notebook instances associated with a git repository\n with a name that contains the specified string.
" + } + }, + "AdditionalCodeRepositoryEquals": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "A filter that returns only notebook instances with associated with the specified git\n repository.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListNotebookInstancesOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to the previous ListNotebookInstances request was\n truncated, SageMaker AI returns this token. To retrieve the next set of notebook\n instances, use the token in the next request.
An array of NotebookInstanceSummary objects, one for each notebook\n instance.
Lists the optimization jobs in your account and their properties.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "OptimizationJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListOptimizationJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of optimization jobs to return in the response. The default is\n 50.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that were created after the\n specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that were created before the\n specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated after the\n specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated before the\n specified time.
" + } + }, + "OptimizationContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that apply the specified\n optimization techniques. You can specify either Quantization or\n Compilation.
Filters the results to only those optimization jobs with a name that contains the\n specified string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#OptimizationJobStatus", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs with the specified status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListOptimizationJobsSortBy", + "traits": { + "smithy.api#documentation": "The field by which to sort the optimization jobs in the response. The default is\n CreationTime\n
The sort order for results. The default is Ascending\n
A list of optimization jobs and their properties that matches any of the filters you\n specified in the request.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results following a\n truncated response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListOptimizationJobsSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#ListPartnerApps": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListPartnerAppsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListPartnerAppsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists all of the SageMaker Partner AI Apps in an account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPartnerAppsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "This parameter defines the maximum number of results that can be returned in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPartnerAppsResponse": { + "type": "structure", + "members": { + "Summaries": { + "target": "com.amazonaws.sagemaker#PartnerAppSummaries", + "traits": { + "smithy.api#documentation": "The information related to each of the SageMaker Partner AI Apps in an account.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListPipelineExecutionSteps": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListPipelineExecutionStepsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListPipelineExecutionStepsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of PipeLineExecutionStep objects.
The Amazon Resource Name (ARN) of the pipeline execution.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListPipelineExecutionSteps request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
The maximum number of pipeline execution steps to return in the response.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "The field by which to sort results. The default is CreatedTime.
A list of PipeLineExecutionStep objects. Each\n PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus,\n and Metadata. Metadata is an object with properties for each job that contains relevant\n information about the job created by the step.
If the result of the previous ListPipelineExecutionSteps request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
Gets a list of the pipeline executions.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PipelineExecutionSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPipelineExecutionsRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the pipeline.
", + "smithy.api#required": {} + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns the pipeline executions that were created after a specified\n time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns the pipeline executions that were created before a specified\n time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortPipelineExecutionsBy", + "traits": { + "smithy.api#documentation": "The field by which to sort results. The default is CreatedTime.
The sort order for results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListPipelineExecutions request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
The maximum number of pipeline executions to return in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPipelineExecutionsResponse": { + "type": "structure", + "members": { + "PipelineExecutionSummaries": { + "target": "com.amazonaws.sagemaker#PipelineExecutionSummaryList", + "traits": { + "smithy.api#documentation": "Contains a sorted list of pipeline execution summary objects matching the specified\n filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date,\n and the status. This list can be empty.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListPipelineExecutions request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
Gets a list of parameters for a pipeline execution.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PipelineParameters", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPipelineParametersForExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListPipelineParametersForExecution request was truncated,\n the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
The maximum number of parameters to return in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPipelineParametersForExecutionResponse": { + "type": "structure", + "members": { + "PipelineParameters": { + "target": "com.amazonaws.sagemaker#ParameterList", + "traits": { + "smithy.api#documentation": "Contains a list of pipeline parameters. This list can be empty.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListPipelineParametersForExecution request was truncated,\n the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
Gets a list of pipelines.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PipelineSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListPipelinesRequest": { + "type": "structure", + "members": { + "PipelineNamePrefix": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "The prefix of the pipeline name.
" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns the pipelines that were created after a specified\n time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns the pipelines that were created before a specified\n time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortPipelinesBy", + "traits": { + "smithy.api#documentation": "The field by which to sort results. The default is CreatedTime.
The sort order for results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListPipelines request was truncated,\n the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
The maximum number of pipelines to return in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListPipelinesResponse": { + "type": "structure", + "members": { + "PipelineSummaries": { + "target": "com.amazonaws.sagemaker#PipelineSummaryList", + "traits": { + "smithy.api#documentation": "Contains a sorted list of PipelineSummary objects matching the specified\n filters. Each PipelineSummary consists of PipelineArn, PipelineName,\n ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and\n RoleArn. This list can be empty.
If the result of the previous ListPipelines request was truncated,\n the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
Lists processing jobs that satisfy various filters.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProcessingJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListProcessingJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only processing jobs created after the specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only processing jobs created after the specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only processing jobs modified after the specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only processing jobs modified before the specified time.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "A string in the processing job name. This filter returns only processing jobs whose\n name contains the specified string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#documentation": "A filter that retrieves only processing jobs with a specific status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
If the result of the previous ListProcessingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of processing\n jobs, use the token in the next request.
The maximum number of processing jobs to return in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListProcessingJobsResponse": { + "type": "structure", + "members": { + "ProcessingJobSummaries": { + "target": "com.amazonaws.sagemaker#ProcessingJobSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of ProcessingJobSummary objects, each listing a processing\n job.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n processing jobs, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListProjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListProjectsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListProjectsOutput" + }, + "traits": { + "smithy.api#documentation": "Gets a list of the projects in an Amazon Web Services account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListProjectsInput": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns the projects that were created after a specified\n time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns the projects that were created before a specified\n time.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of projects to return in the response.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#documentation": "A filter that returns the projects whose name contains a specified\n string.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListProjects request was truncated,\n the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.
The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
A list of summaries of projects.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.
Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of\n ResourceCatalogs viewable is 1000.
A string that partially matches one or more ResourceCatalogs names.\n Filters ResourceCatalog by name.
Use this parameter to search for ResourceCatalogs created after a\n specific date and time.
Use this parameter to search for ResourceCatalogs created before a\n specific date and time.
The order in which the resource catalogs are listed.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ResourceCatalogSortBy", + "traits": { + "smithy.api#documentation": "The value on which the resource catalog list is sorted.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": " The maximum number of results returned by ListResourceCatalogs.
A token to resume pagination of ListResourceCatalogs results.
A list of the requested ResourceCatalogs.
A token to resume pagination of ListResourceCatalogs results.
Lists spaces.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Spaces", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListSpacesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
The sort order for the results. The default is Ascending.
The parameter by which to sort the results. The default is\n CreationTime.
A parameter to search for the domain ID.
" + } + }, + "SpaceNameContains": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "A parameter by which to filter the results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListSpacesResponse": { + "type": "structure", + "members": { + "Spaces": { + "target": "com.amazonaws.sagemaker#SpaceList", + "traits": { + "smithy.api#documentation": "The list of spaces.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListStageDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListStageDevicesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListStageDevicesResponse" + }, + "traits": { + "smithy.api#documentation": "Lists devices allocated to the stage, containing detailed device information and\n deployment status.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DeviceDeploymentSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListStageDevicesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The response from the last list when returning a list large enough to neeed\n tokening.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ListMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of requests to select.
" + } + }, + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan.
", + "smithy.api#required": {} + } + }, + "ExcludeDevicesDeployedInOtherStage": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Toggle for excluding devices deployed in other stages.
" + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stage in the deployment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListStageDevicesResponse": { + "type": "structure", + "members": { + "DeviceDeploymentSummaries": { + "target": "com.amazonaws.sagemaker#DeviceDeploymentSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List of summaries of devices allocated to the stage.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The token to use when calling the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListStudioLifecycleConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListStudioLifecycleConfigsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListStudioLifecycleConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services\n Account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StudioLifecycleConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListStudioLifecycleConfigsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The total number of items to return in the response. If the total number of items\n available is more than the value specified, a NextToken is provided in the\n response. To resume pagination, provide the NextToken value in the as part of a\n subsequent call. The default value is 10.
If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle\n Configurations, the call returns a token for getting the next set of Lifecycle\n Configurations.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#documentation": "A string in the Lifecycle Configuration name. This filter returns only Lifecycle\n Configurations whose name contains the specified string.
" + } + }, + "AppTypeEquals": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", + "traits": { + "smithy.api#documentation": "A parameter to search for the App Type to which the Lifecycle Configuration is\n attached.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or before the specified\n time.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or after the specified\n time.
" + } + }, + "ModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified before the specified\n time.
" + } + }, + "ModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified after the specified\n time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigSortKey", + "traits": { + "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order. The default value is Descending.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListStudioLifecycleConfigsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + }, + "StudioLifecycleConfigs": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigsList", + "traits": { + "smithy.api#documentation": "A list of Lifecycle Configurations and their properties.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListSubscribedWorkteams": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListSubscribedWorkteamsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListSubscribedWorkteamsResponse" + }, + "traits": { + "smithy.api#documentation": "Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The\n list may be empty if no work team satisfies the filter specified in the\n NameContains parameter.
A string in the work team name. This filter returns only work teams whose name\n contains the specified string.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListSubscribedWorkteams request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.
The maximum number of work teams to return in each page of the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListSubscribedWorkteamsResponse": { + "type": "structure", + "members": { + "SubscribedWorkteams": { + "target": "com.amazonaws.sagemaker#SubscribedWorkteams", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of Workteam objects, each describing a work team.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n work teams, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTagsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTagsOutput" + }, + "traits": { + "smithy.api#documentation": "Returns the tags for the specified SageMaker resource.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tags", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTagsInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sagemaker#ResourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource whose tags you want to\n retrieve.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": " If the response to the previous ListTags request is truncated, SageMaker\n returns this token. To retrieve the next set of tags, use it in the subsequent request.\n
Maximum number of tags to return.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTagsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 50 + } + } + }, + "com.amazonaws.sagemaker#ListTagsOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of Tag objects, each with a tag key and a value.
If response is truncated, SageMaker includes a token in the response. You can use this\n token in your subsequent request to fetch next set of tokens.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTrainingJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTrainingJobsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists training jobs.
\nWhen StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.
For example, if ListTrainingJobs is invoked with the following\n parameters:
\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n
First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.
You can quickly test the API using the following Amazon Web Services CLI\n code.
\n\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n
Gets a list of TrainingJobSummary objects that describe the training jobs that a\n hyperparameter tuning job launched.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrainingJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJobRequest": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tuning job whose training jobs you want to list.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListTrainingJobsForHyperParameterTuningJob\n request was truncated, the response includes a NextToken. To retrieve the\n next set of training jobs, use the token in the next request.
The maximum number of training jobs to return. The default value is 10.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#documentation": "A filter that returns only training jobs with the specified status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#TrainingJobSortByOptions", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is Name.
If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.
The sort order for results. The default is Ascending.
A list of TrainingJobSummary objects that\n describe\n the training jobs that the\n ListTrainingJobsForHyperParameterTuningJob request returned.
If the result of this ListTrainingJobsForHyperParameterTuningJob request\n was truncated, the response includes a NextToken. To retrieve the next set\n of training jobs, use the token in the next request.
If the result of the previous ListTrainingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of training\n jobs, use the token in the next request.
The maximum number of training jobs to return in the response.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only training jobs created after the specified time\n (timestamp).
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only training jobs created before the specified time\n (timestamp).
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only training jobs modified after the specified time\n (timestamp).
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only training jobs modified before the specified time\n (timestamp).
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "A string in the training job name. This filter returns only training jobs whose\n name contains the specified string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#documentation": "A filter that retrieves only training jobs with a specific status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that retrieves only training jobs with a specific warm pool status.
" + } + }, + "TrainingPlanArnEquals": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information\n about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
An array of TrainingJobSummary objects, each listing a training\n job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingPlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTrainingPlansRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTrainingPlansResponse" + }, + "traits": { + "smithy.api#documentation": "Retrieves a list of training plans for the current account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrainingPlanSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTrainingPlansRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token to continue pagination if more results are available.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
" + } + }, + "StartTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter to list only training plans with an actual start time after this date.
" + } + }, + "StartTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Filter to list only training plans with an actual start time before this date.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#TrainingPlanSortBy", + "traits": { + "smithy.api#documentation": "The training plan field to sort the results by (e.g., StartTime, Status).
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#TrainingPlanSortOrder", + "traits": { + "smithy.api#documentation": "The order to sort the results (Ascending or Descending).
" + } + }, + "Filters": { + "target": "com.amazonaws.sagemaker#TrainingPlanFilters", + "traits": { + "smithy.api#documentation": "Additional filters to apply to the list of training plans.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListTrainingPlansResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token to continue pagination if more results are available.
" + } + }, + "TrainingPlanSummaries": { + "target": "com.amazonaws.sagemaker#TrainingPlanSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of summary information for the training plans.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTransformJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTransformJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTransformJobsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists transform jobs.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransformJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTransformJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only transform jobs created after the specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only transform jobs created before the specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only transform jobs modified after the specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only transform jobs modified before the specified time.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "A string in the transform job name. This filter returns only transform jobs whose name\n contains the specified string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", + "traits": { + "smithy.api#documentation": "A filter that retrieves only transform jobs with a specific status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", + "traits": { + "smithy.api#documentation": "The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
If the result of the previous ListTransformJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of transform\n jobs, use the token in the next request.
The maximum number of transform jobs to return in the response. The default value is 10.
An array of\n TransformJobSummary\n objects.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n transform jobs, use it in the next request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTrialComponentKey256": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialComponentKey256" + } + }, + "com.amazonaws.sagemaker#ListTrialComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTrialComponentsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTrialComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Lists the trial components in your account. You can sort the list by trial component name\n or creation time. You can filter the list to show only components that were created in a\n specific time range. You can also filter on one of the following:
\n\n ExperimentName\n
\n SourceArn\n
\n TrialName\n
A filter that returns only components that are part of the specified experiment. If you\n specify ExperimentName, you can't filter by SourceArn or\n TrialName.
A filter that returns only components that are part of the specified trial. If you specify\n TrialName, you can't filter by ExperimentName or\n SourceArn.
A filter that returns only components that have the specified source Amazon Resource Name (ARN). \n If you specify SourceArn, you can't filter by ExperimentName\n or TrialName.
A filter that returns only components created after the specified time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only components created before the specified time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortTrialComponentsBy", + "traits": { + "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of components to return in the response. The default value is\n 10.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous call to ListTrialComponents didn't return the full set of\n components, the call returns a token for getting the next set of components.
A list of the summaries of your trial components.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of components, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListTrials": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListTrialsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListTrialsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Lists the trials in your account. Specify an experiment name to limit the list to the\n trials that are part of that experiment. Specify a trial component name to limit the list to\n the trials that associated with that trial component. The list can be filtered to show only\n trials that were created in a specific time range. The list can be sorted by trial name or\n creation time.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrialSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListTrialsRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "A filter that returns only trials that are part of the specified experiment.
" + } + }, + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "A filter that returns only trials that are associated with the specified trial\n component.
" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only trials created after the specified time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns only trials created before the specified time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortTrialsBy", + "traits": { + "smithy.api#documentation": "The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of trials to return in the response. The default value is 10.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous call to ListTrials didn't return the full set of trials, the\n call returns a token for getting the next set of trials.
A list of the summaries of your trials.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of trials, if there are any.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListUserProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListUserProfilesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListUserProfilesResponse" + }, + "traits": { + "smithy.api#documentation": "Lists user profiles.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UserProfiles", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListUserProfilesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
The sort order for the results. The default is Ascending.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#UserProfileSortKey", + "traits": { + "smithy.api#documentation": "The parameter by which to sort the results. The default is CreationTime.
" + } + }, + "DomainIdEquals": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "A parameter by which to filter the results.
" + } + }, + "UserProfileNameContains": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "A parameter by which to filter the results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListUserProfilesResponse": { + "type": "structure", + "members": { + "UserProfiles": { + "target": "com.amazonaws.sagemaker#UserProfileList", + "traits": { + "smithy.api#documentation": "The list of user profiles.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListWorkforces": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListWorkforcesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListWorkforcesResponse" + }, + "traits": { + "smithy.api#documentation": "Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only \n have one private workforce per Amazon Web Services Region.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Workforces", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListWorkforcesRequest": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#ListWorkforcesSortByOptions", + "traits": { + "smithy.api#documentation": "Sort workforces using the workforce name or creation date.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "Sort workforces in ascending or descending order.
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#documentation": "A filter you can use to search for workforces using part of the workforce name.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token to resume pagination.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of workforces returned in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListWorkforcesResponse": { + "type": "structure", + "members": { + "Workforces": { + "target": "com.amazonaws.sagemaker#Workforces", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list containing information about your workforce.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token to resume pagination.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListWorkforcesSortByOptions": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreateDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDate" + } + } + } + }, + "com.amazonaws.sagemaker#ListWorkteams": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListWorkteamsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListWorkteamsResponse" + }, + "traits": { + "smithy.api#documentation": "Gets a list of private work teams that you have defined in a region. The list may be empty if\n no work team satisfies the filter specified in the NameContains\n parameter.
The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A string in the work team's name. This filter returns only work teams whose name\n contains the specified string.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous ListWorkteams request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.
The maximum number of work teams to return in each page of the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListWorkteamsResponse": { + "type": "structure", + "members": { + "Workteams": { + "target": "com.amazonaws.sagemaker#Workteams", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of Workteam objects, each describing a work team.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n work teams, use it in the subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListWorkteamsSortByOptions": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreateDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDate" + } + } + } + }, + "com.amazonaws.sagemaker#Long": { + "type": "long" + }, + "com.amazonaws.sagemaker#MLFramework": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxCandidates": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 750 + } + } + }, + "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.sagemaker#MaxConcurrentTaskCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.sagemaker#MaxConcurrentTransforms": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#MaxHumanLabeledObjectCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxNumberOfTests": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxNumberOfTrainingJobsNotImproving": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 3 + } + } + }, + "com.amazonaws.sagemaker#MaxParallelExecutionSteps": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxParallelOfTests": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxParallelTrainingJobs": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxPayloadInMB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#MaxPendingTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Maximum job scheduler pending time in seconds.", + "smithy.api#range": { + "min": 7200, + "max": 2419200 + } + } + }, + "com.amazonaws.sagemaker#MaxPercentageOfInputDatasetLabeled": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MaxRuntimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaxWaitTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 600, + "max": 28800 + } + } + }, + "com.amazonaws.sagemaker#MaximumRetryAttempts": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#MediaType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[-\\w]+\\/[-\\w+]+$" + } + }, + "com.amazonaws.sagemaker#MemberDefinition": { + "type": "structure", + "members": { + "CognitoMemberDefinition": { + "target": "com.amazonaws.sagemaker#CognitoMemberDefinition", + "traits": { + "smithy.api#documentation": "The Amazon Cognito user group that is part of the work team.
" + } + }, + "OidcMemberDefinition": { + "target": "com.amazonaws.sagemaker#OidcMemberDefinition", + "traits": { + "smithy.api#documentation": "A list user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.
Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
" + } + }, + "com.amazonaws.sagemaker#MemberDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MemberDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#MemoryInMb": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 128 + } + } + }, + "com.amazonaws.sagemaker#MetadataProperties": { + "type": "structure", + "members": { + "CommitId": { + "target": "com.amazonaws.sagemaker#MetadataPropertyValue", + "traits": { + "smithy.api#documentation": "The commit ID.
" + } + }, + "Repository": { + "target": "com.amazonaws.sagemaker#MetadataPropertyValue", + "traits": { + "smithy.api#documentation": "The repository.
" + } + }, + "GeneratedBy": { + "target": "com.amazonaws.sagemaker#MetadataPropertyValue", + "traits": { + "smithy.api#documentation": "The entity this entity was generated by.
" + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#MetadataPropertyValue", + "traits": { + "smithy.api#documentation": "The project ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata properties of the tracking entity, trial, or trial component.
" + } + }, + "com.amazonaws.sagemaker#MetadataPropertyValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#MetricData": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#documentation": "The name of the metric.
" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "The value of the metric.
" + } + }, + "Timestamp": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the algorithm emitted the metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
" + } + }, + "com.amazonaws.sagemaker#MetricDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MetricDatum" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.sagemaker#MetricDatum": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", + "traits": { + "smithy.api#documentation": "The name of the metric.
" + } + }, + "StandardMetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricExtendedEnum", + "traits": { + "smithy.api#documentation": "The name of the standard metric.
\nFor definitions of the standard metrics, see \n Autopilot candidate metrics\n .
The value of the metric.
" + } + }, + "Set": { + "target": "com.amazonaws.sagemaker#MetricSetSource", + "traits": { + "smithy.api#documentation": "The dataset split from which the AutoML job produced the metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the metric for a candidate produced by an AutoML job.
" + } + }, + "com.amazonaws.sagemaker#MetricDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the metric.
", + "smithy.api#required": {} + } + }, + "Regex": { + "target": "com.amazonaws.sagemaker#MetricRegex", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A regular expression that searches the output of a training job and gets the value of\n the metric. For more information about using regular expressions to define metrics, see\n Defining metrics and environment variables.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a metric that the training algorithm writes to stderr or\n stdout. You can view these logs to understand how your training job\n performs and check for any errors encountered during training. SageMaker hyperparameter\n tuning captures all defined metrics. Specify one of the defined metrics to use as an\n objective metric using the TuningObjective parameter in the\n HyperParameterTrainingJobDefinition API to evaluate job performance\n during hyperparameter tuning.
Information about a predefined metric.
" + } + }, + "Customized": { + "target": "com.amazonaws.sagemaker#CustomizedMetricSpecification", + "traits": { + "smithy.api#documentation": "Information about a customized metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing information about a metric.
" + } + }, + "com.amazonaws.sagemaker#MetricValue": { + "type": "float" + }, + "com.amazonaws.sagemaker#MetricsSource": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The metric source content type.
", + "smithy.api#required": {} + } + }, + "ContentDigest": { + "target": "com.amazonaws.sagemaker#ContentDigest", + "traits": { + "smithy.api#documentation": "The hash key used for the metrics source.
" + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The S3 URI for the metrics source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the metrics source.
" + } + }, + "com.amazonaws.sagemaker#MinimumInstanceMetadataServiceVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + }, + "smithy.api#pattern": "^1|2$" + } + }, + "com.amazonaws.sagemaker#MlTools": { + "type": "enum", + "members": { + "DATA_WRANGLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DataWrangler" + } + }, + "FEATURE_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureStore" + } + }, + "EMR_CLUSTERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EmrClusters" + } + }, + "AUTO_ML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoMl" + } + }, + "EXPERIMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Experiments" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Training" + } + }, + "MODEL_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelEvaluation" + } + }, + "PIPELINES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipelines" + } + }, + "MODELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Models" + } + }, + "JUMP_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JumpStart" + } + }, + "INFERENCE_RECOMMENDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InferenceRecommender" + } + }, + "ENDPOINTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Endpoints" + } + }, + "PROJECTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Projects" + } + }, + "INFERENCE_OPTIMIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InferenceOptimization" + } + }, + "PERFORMANCE_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PerformanceEvaluation" + } + }, + "LAKERA_GUARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LakeraGuard" + } + }, + "COMET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Comet" + } + }, + "DEEPCHECKS_LLM_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeepchecksLLMEvaluation" + } + }, + "FIDDLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Fiddler" + } + }, + "HYPER_POD_CLUSTERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HyperPodClusters" + } + } + } + }, + "com.amazonaws.sagemaker#MlflowVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#pattern": "^[0-9]*.[0-9]*.[0-9]*$" + } + }, + "com.amazonaws.sagemaker#Model": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model.
" + } + }, + "PrimaryContainer": { + "target": "com.amazonaws.sagemaker#ContainerDefinition" + }, + "Containers": { + "target": "com.amazonaws.sagemaker#ContainerDefinitionList", + "traits": { + "smithy.api#documentation": "The containers in the inference pipeline.
" + } + }, + "InferenceExecutionConfig": { + "target": "com.amazonaws.sagemaker#InferenceExecutionConfig" + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the model was created.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model.
" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of key-value pairs associated with the model. For more information, see\n Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + } + }, + "DeploymentRecommendation": { + "target": "com.amazonaws.sagemaker#DeploymentRecommendation", + "traits": { + "smithy.api#documentation": "A set of recommended deployment configurations for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of a model as returned by the Search API.
" + } + }, + "com.amazonaws.sagemaker#ModelAccessConfig": { + "type": "structure", + "members": { + "AcceptEula": { + "target": "com.amazonaws.sagemaker#AcceptEula", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies agreement to the model end-user license agreement (EULA). The\n AcceptEula value must be explicitly defined as True in order\n to accept the EULA that this model requires. You are responsible for reviewing and\n complying with any applicable license terms and making sure they are acceptable for your\n use case before downloading or using a model.
The access configuration file to control access to the ML model. You can explicitly accept the model\n end-user license agreement (EULA) within the ModelAccessConfig.
If you are a Jumpstart user, see the End-user license agreements section for more details on accepting the EULA.
\nIf you are an AutoML user, see the Optional Parameters section of\n Create an AutoML job to fine-tune text generation models using the\n API for details on How to set the EULA acceptance when fine-tuning a model using the AutoML\n API.
\nThe path of the S3 object that contains the model artifacts. For example,\n s3://bucket-name/keynameprefix/model.tar.gz.
Provides information about the location that is configured for storing model\n artifacts.
\nModel artifacts are outputs that result from training a model. They typically consist\n of trained parameters, a model definition that describes how to compute inferences, and\n other metadata. A SageMaker container stores your trained model artifacts in the\n /opt/ml/model directory. After training has completed, by default,\n these artifacts are uploaded to your Amazon S3 bucket as compressed files.
The container image to be run by the model bias job.
", + "smithy.api#required": {} + } + }, + "ConfigUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "JSON formatted S3 file that defines bias parameters. For more information on this JSON\n configuration file, see Configure\n bias parameters.
", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "Sets the environment variables in the Docker container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Docker container image configuration object for the model bias job.
" + } + }, + "com.amazonaws.sagemaker#ModelBiasBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "The name of the baseline model bias job.
" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a baseline model bias job.
" + } + }, + "com.amazonaws.sagemaker#ModelBiasJobInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "Input object for the batch transform job.
" + } + }, + "GroundTruthS3Input": { + "target": "com.amazonaws.sagemaker#MonitoringGroundTruthS3Input", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Location of ground truth labels to use in model bias job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Inputs for the model bias job.
" + } + }, + "com.amazonaws.sagemaker#ModelCacheSetting": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCard": { + "type": "structure", + "members": { + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card.
" + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The unique name of the model card.
" + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The version of the model card.
" + } + }, + "Content": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#documentation": "The content of the model card. Content uses the model card JSON schema and provided as a string.
" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The security configuration used to protect model card data.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the model card was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the model card was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Key-value pairs used to manage metadata for the model card.
" + } + }, + "ModelId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The unique name (ID) of the model.
" + } + }, + "RiskRating": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon SageMaker Model Card.
" + } + }, + "com.amazonaws.sagemaker#ModelCardArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ModelCardContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100000 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sagemaker#ModelCardExportArtifacts": { + "type": "structure", + "members": { + "S3ExportArtifacts": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 URI of the exported model artifacts.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The artifacts of the model card export job.
" + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + }, + "traits": { + "smithy.api#documentation": "Attribute by which to sort returned export jobs." + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobSummary": { + "type": "structure", + "members": { + "ModelCardExportJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model card export job.
", + "smithy.api#required": {} + } + }, + "ModelCardExportJobArn": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card export job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The completion status of the model card export job.
", + "smithy.api#required": {} + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model card that the export job exports.
", + "smithy.api#required": {} + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the model card that the export job exports.
", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the model card export job was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedAt": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the model card export job was last modified..
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the Amazon SageMaker Model Card export job.
" + } + }, + "com.amazonaws.sagemaker#ModelCardExportJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelCardExportJobSummary" + } + }, + "com.amazonaws.sagemaker#ModelCardExportOutputConfig": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 output path to export your model card PDF.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configure the export output details for an Amazon SageMaker Model Card.
" + } + }, + "com.amazonaws.sagemaker#ModelCardNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" + } + }, + "com.amazonaws.sagemaker#ModelCardProcessingStatus": { + "type": "enum", + "members": { + "DELETE_INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInProgress" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeletePending" + } + }, + "CONTENT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContentDeleted" + } + }, + "EXPORTJOBS_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExportJobsDeleted" + } + }, + "DELETE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteCompleted" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardSecurityConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "A Key Management Service\n key\n ID to use for encrypting a model card.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configure the security settings to protect model card data.
" + } + }, + "com.amazonaws.sagemaker#ModelCardSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardStatus": { + "type": "enum", + "members": { + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Draft" + } + }, + "PENDINGREVIEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingReview" + } + }, + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Approved" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Archived" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardSummary": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model card.
", + "smithy.api#required": {} + } + }, + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card.
", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The date and time that the model card was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the model card was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the model card.
" + } + }, + "com.amazonaws.sagemaker#ModelCardSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelCardSummary" + } + }, + "com.amazonaws.sagemaker#ModelCardVersionSortBy": { + "type": "enum", + "members": { + "VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Version" + } + } + } + }, + "com.amazonaws.sagemaker#ModelCardVersionSummary": { + "type": "structure", + "members": { + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model card.
", + "smithy.api#required": {} + } + }, + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model card.
", + "smithy.api#required": {} + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
A version of the model card.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The date and time that the model card version was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time date and time that the model card version was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a specific version of the model card.
" + } + }, + "com.amazonaws.sagemaker#ModelCardVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelCardVersionSummary" + } + }, + "com.amazonaws.sagemaker#ModelClientConfig": { + "type": "structure", + "members": { + "InvocationsTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "The timeout value in seconds for an invocation request. The default value is\n 600.
" + } + }, + "InvocationsMaxRetries": { + "target": "com.amazonaws.sagemaker#InvocationsMaxRetries", + "traits": { + "smithy.api#documentation": "The maximum number of retries when invocation requests are failing. The default value\n is 3.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the timeout and maximum number of retries for processing a transform job\n invocation.
" + } + }, + "com.amazonaws.sagemaker#ModelCompilationConfig": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
" + } + }, + "OverrideEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "Environment variables that override the default ones in the model container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for the model compilation technique that's applied by a model optimization job.
" + } + }, + "com.amazonaws.sagemaker#ModelCompressionType": { + "type": "enum", + "members": { + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "Gzip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gzip" + } + } + } + }, + "com.amazonaws.sagemaker#ModelConfiguration": { + "type": "structure", + "members": { + "InferenceSpecificationName": { + "target": "com.amazonaws.sagemaker#InferenceSpecificationName", + "traits": { + "smithy.api#documentation": "The inference specification name in the model package version.
" + } + }, + "EnvironmentParameters": { + "target": "com.amazonaws.sagemaker#EnvironmentParameters", + "traits": { + "smithy.api#documentation": "Defines the environment parameters that includes key, value types, and values.
" + } + }, + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobCompilationJobName", + "traits": { + "smithy.api#documentation": "The name of the compilation job used to create the recommended model artifacts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the model configuration. Includes the specification name and environment parameters.
" + } + }, + "com.amazonaws.sagemaker#ModelDashboardEndpoint": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The endpoint name.
", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that indicates when the endpoint was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The last time the endpoint was modified.
", + "smithy.api#required": {} + } + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The endpoint status.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.
" + } + }, + "com.amazonaws.sagemaker#ModelDashboardEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelDashboardEndpoint" + } + }, + "com.amazonaws.sagemaker#ModelDashboardIndicatorAction": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the alert action is turned on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into\n InAlert status.
A model displayed in the Model Dashboard.
" + } + }, + "Endpoints": { + "target": "com.amazonaws.sagemaker#ModelDashboardEndpoints", + "traits": { + "smithy.api#documentation": "The endpoints that host a model.
" + } + }, + "LastBatchTransformJob": { + "target": "com.amazonaws.sagemaker#TransformJob" + }, + "MonitoringSchedules": { + "target": "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedules", + "traits": { + "smithy.api#documentation": "The monitoring schedules for a model.
" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelDashboardModelCard", + "traits": { + "smithy.api#documentation": "The model card for a model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A model displayed in the Amazon SageMaker Model Dashboard.
" + } + }, + "com.amazonaws.sagemaker#ModelDashboardModelCard": { + "type": "structure", + "members": { + "ModelCardArn": { + "target": "com.amazonaws.sagemaker#ModelCardArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a model card.
" + } + }, + "ModelCardName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of a model card.
" + } + }, + "ModelCardVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The model card version.
" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "The model card status.
" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelCardSecurityConfig", + "traits": { + "smithy.api#documentation": "The KMS Key ID (KMSKeyId) for encryption of model card information.
A timestamp that indicates when the model card was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the model card was last updated.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with a model card.
" + } + }, + "ModelId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "For models created in SageMaker, this is the model ARN. For models created\n outside of SageMaker, this is a user-customized string.
" + } + }, + "RiskRating": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "A model card's risk rating. Can be low, medium, or high.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The model card for a model displayed in the Amazon SageMaker Model Dashboard.
" + } + }, + "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedule": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a monitoring schedule.
" + } + }, + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#documentation": "The name of a monitoring schedule.
" + } + }, + "MonitoringScheduleStatus": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#documentation": "The status of the monitoring schedule.
" + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "The monitor type of a model monitor.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If a monitoring job failed, provides the reason.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the monitoring schedule was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the monitoring schedule was last updated.
" + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig" + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "The endpoint which is monitored.
" + } + }, + "MonitoringAlertSummaries": { + "target": "com.amazonaws.sagemaker#MonitoringAlertSummaryList", + "traits": { + "smithy.api#documentation": "A JSON array where each element is a summary for a monitoring alert.
" + } + }, + "LastMonitoringExecutionSummary": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput" + } + }, + "traits": { + "smithy.api#documentation": "A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.
" + } + }, + "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedules": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelDashboardMonitoringSchedule" + } + }, + "com.amazonaws.sagemaker#ModelDataQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "Data quality statistics for a model.
" + } + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "Data quality constraints for a model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Data quality constraints and statistics for a model.
" + } + }, + "com.amazonaws.sagemaker#ModelDataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#S3ModelDataSource", + "traits": { + "smithy.api#documentation": "Specifies the S3 location of ML model data to deploy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the location of ML model data to deploy. If specified, you must specify one\n and only one of the available data sources.
" + } + }, + "com.amazonaws.sagemaker#ModelDeployConfig": { + "type": "structure", + "members": { + "AutoGenerateEndpointName": { + "target": "com.amazonaws.sagemaker#AutoGenerateEndpointName", + "traits": { + "smithy.api#documentation": "Set to True to automatically generate an endpoint name for a one-click\n Autopilot model deployment; set to False otherwise. The default value is\n False.
If you set AutoGenerateEndpointName to True, do not specify\n the EndpointName; otherwise a 400 error is thrown.
Specifies the endpoint name to use for a one-click Autopilot model deployment if the\n endpoint name is not generated automatically.
\nSpecify the EndpointName if and only if you set\n AutoGenerateEndpointName to False; otherwise a 400 error is\n thrown.
Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.
" + } + }, + "com.amazonaws.sagemaker#ModelDeployResult": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the endpoint to which the model has been deployed.
\nIf model deployment fails, this field is omitted from the response.
\nProvides information about the endpoint of the model deployment.
" + } + }, + "com.amazonaws.sagemaker#ModelDigests": { + "type": "structure", + "members": { + "ArtifactDigest": { + "target": "com.amazonaws.sagemaker#ArtifactDigest", + "traits": { + "smithy.api#documentation": "Provides a hash value that uniquely identifies the stored model\n artifacts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information to verify the integrity of stored model artifacts.
" + } + }, + "com.amazonaws.sagemaker#ModelExplainabilityAppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The container image to be run by the model explainability job.
", + "smithy.api#required": {} + } + }, + "ConfigUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "JSON formatted Amazon S3 file that defines explainability parameters. For more\n information on this JSON configuration file, see Configure model explainability parameters.
", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "Sets the environment variables in the Docker container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Docker container image configuration object for the model explainability job.
" + } + }, + "com.amazonaws.sagemaker#ModelExplainabilityBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "The name of the baseline model explainability job.
" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a baseline model explainability job.
" + } + }, + "com.amazonaws.sagemaker#ModelExplainabilityJobInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "Input object for the batch transform job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Inputs for the model explainability job.
" + } + }, + "com.amazonaws.sagemaker#ModelInfrastructureConfig": { + "type": "structure", + "members": { + "InfrastructureType": { + "target": "com.amazonaws.sagemaker#ModelInfrastructureType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The inference option to which to deploy your model. Possible values are the following:
\n\n RealTime: Deploy to real-time inference.
The infrastructure configuration for deploying the model to real-time inference.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the infrastructure that the model will be deployed to.
" + } + }, + "com.amazonaws.sagemaker#ModelInfrastructureType": { + "type": "enum", + "members": { + "REAL_TIME_INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RealTimeInference" + } + } + } + }, + "com.amazonaws.sagemaker#ModelInput": { + "type": "structure", + "members": { + "DataInputConfig": { + "target": "com.amazonaws.sagemaker#DataInputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The input configuration object for the model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input object for the model.
" + } + }, + "com.amazonaws.sagemaker#ModelInsightsLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ModelLatencyThreshold": { + "type": "structure", + "members": { + "Percentile": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#documentation": "The model latency percentile threshold. Acceptable values are P95 and P99.\n For custom load tests, specify the value as P95.
The model latency percentile value in milliseconds.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The model latency threshold.
" + } + }, + "com.amazonaws.sagemaker#ModelLatencyThresholds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelLatencyThreshold" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#ModelLifeCycle": { + "type": "structure", + "members": { + "Stage": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The current stage in the model life cycle.\n
", + "smithy.api#required": {} + } + }, + "StageStatus": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The current status of a stage in model life cycle.\n
", + "smithy.api#required": {} + } + }, + "StageDescription": { + "target": "com.amazonaws.sagemaker#StageDescription", + "traits": { + "smithy.api#documentation": "\n Describes the stage related details.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n A structure describing the current state of the model in its life cycle.\n
" + } + }, + "com.amazonaws.sagemaker#ModelMetadataFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ModelMetadataFilterType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the of the model to filter by.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value to filter the model metadata.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Part of the search expression. You can specify the name and value \n (domain, task, framework, framework version, task, and model).
" + } + }, + "com.amazonaws.sagemaker#ModelMetadataFilterType": { + "type": "enum", + "members": { + "DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Domain" + } + }, + "FRAMEWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Framework" + } + }, + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Task" + } + }, + "FRAMEWORKVERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FrameworkVersion" + } + } + } + }, + "com.amazonaws.sagemaker#ModelMetadataFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelMetadataFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.sagemaker#ModelMetadataSearchExpression": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.sagemaker#ModelMetadataFilters", + "traits": { + "smithy.api#documentation": "A list of filter objects.
" + } + } + }, + "traits": { + "smithy.api#documentation": "One or more filters that searches for the specified resource or resources in \n a search. All resource objects that satisfy the expression's condition are \n included in the search results
" + } + }, + "com.amazonaws.sagemaker#ModelMetadataSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelMetadataSummary" + } + }, + "com.amazonaws.sagemaker#ModelMetadataSummary": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The machine learning domain of the model.
", + "smithy.api#required": {} + } + }, + "Framework": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The machine learning framework of the model.
", + "smithy.api#required": {} + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The machine learning task of the model.
", + "smithy.api#required": {} + } + }, + "Model": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model.
", + "smithy.api#required": {} + } + }, + "FrameworkVersion": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The framework version of the model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the model metadata.
" + } + }, + "com.amazonaws.sagemaker#ModelMetrics": { + "type": "structure", + "members": { + "ModelQuality": { + "target": "com.amazonaws.sagemaker#ModelQuality", + "traits": { + "smithy.api#documentation": "Metrics that measure the quality of a model.
" + } + }, + "ModelDataQuality": { + "target": "com.amazonaws.sagemaker#ModelDataQuality", + "traits": { + "smithy.api#documentation": "Metrics that measure the quality of the input data for a model.
" + } + }, + "Bias": { + "target": "com.amazonaws.sagemaker#Bias", + "traits": { + "smithy.api#documentation": "Metrics that measure bias in a model.
" + } + }, + "Explainability": { + "target": "com.amazonaws.sagemaker#Explainability", + "traits": { + "smithy.api#documentation": "Metrics that help explain a model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains metrics captured from a model.
" + } + }, + "com.amazonaws.sagemaker#ModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + } + }, + "com.amazonaws.sagemaker#ModelNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#ModelPackage": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the model.
" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The model group to which the model belongs.
" + } + }, + "ModelPackageVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageVersion", + "traits": { + "smithy.api#documentation": "The version number of a versioned model.
" + } + }, + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
" + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "The description of the model package.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "The time that the model package was created.
" + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "Defines how to perform inference generation after a training job is run.
" + } + }, + "SourceAlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", + "traits": { + "smithy.api#documentation": "A list of algorithms that were used to create a model package.
" + } + }, + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", + "traits": { + "smithy.api#documentation": "Specifies batch transform jobs that SageMaker runs to validate your model package.
" + } + }, + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "traits": { + "smithy.api#documentation": "The status of the model package. This can be one of the following values.
\n\n PENDING - The model package is pending being created.
\n IN_PROGRESS - The model package is in the process of being\n created.
\n COMPLETED - The model package was successfully created.
\n FAILED - The model package failed.
\n DELETING - The model package is in the process of being deleted.
Specifies the validation and image scan statuses of the model package.
" + } + }, + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "traits": { + "smithy.api#documentation": "Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For\n information about listing model packages on Amazon Web Services Marketplace, see List Your\n Algorithm or Model Package on Amazon Web Services Marketplace.
" + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "The approval status of the model. This can be one of the following values.
\n\n APPROVED - The model is approved
\n REJECTED - The model is rejected.
\n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.
Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties", + "traits": { + "smithy.api#documentation": "Metadata properties of the tracking entity, trial, or trial component.
" + } + }, + "ModelMetrics": { + "target": "com.amazonaws.sagemaker#ModelMetrics", + "traits": { + "smithy.api#documentation": "Metrics for the model.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last time the model package was modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
" + } + }, + "ApprovalDescription": { + "target": "com.amazonaws.sagemaker#ApprovalDescription", + "traits": { + "smithy.api#documentation": "A description provided when the model approval is set.
" + } + }, + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.
" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification.
" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to\n a single gzip compressed tar archive (.tar.gz suffix).
" + } + }, + "AdditionalInferenceSpecifications": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "An array of additional Inference Specification objects.
" + } + }, + "SourceUri": { + "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", + "traits": { + "smithy.api#documentation": "The URI of the source for the model package.
" + } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig" + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard" + }, + "ModelLifeCycle": { + "target": "com.amazonaws.sagemaker#ModelLifeCycle", + "traits": { + "smithy.api#documentation": "\n A structure describing the current state of the model in its life cycle.\n
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + } + }, + "CustomerMetadataProperties": { + "target": "com.amazonaws.sagemaker#CustomerMetadataMap", + "traits": { + "smithy.api#documentation": "The metadata properties for the model package.
" + } + }, + "DriftCheckBaselines": { + "target": "com.amazonaws.sagemaker#DriftCheckBaselines", + "traits": { + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.
" + } + }, + "SkipModelValidation": { + "target": "com.amazonaws.sagemaker#SkipModelValidation", + "traits": { + "smithy.api#documentation": "Indicates if you want to skip model validation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A versioned model that can be deployed for SageMaker inference.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#ModelPackageArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ModelPackageContainerDefinition": { + "type": "structure", + "members": { + "ContainerHostname": { + "target": "com.amazonaws.sagemaker#ContainerHostname", + "traits": { + "smithy.api#documentation": "The DNS host name for the Docker container.
" + } + }, + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon EC2 Container Registry path where inference code is stored.
\nIf you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.
An MD5 hash of the training algorithm that identifies the Docker image used for\n training.
" + } + }, + "ModelDataUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same region as the\n model package.
\nSpecifies the location of ML model data to deploy during endpoint creation.
" + } + }, + "ProductId": { + "target": "com.amazonaws.sagemaker#ProductId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Marketplace product ID of the model package.
" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.
A structure with Model Input details.
" + } + }, + "Framework": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning framework of the model package container image.
" + } + }, + "FrameworkVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageFrameworkVersion", + "traits": { + "smithy.api#documentation": "The framework version of the Model Package Container Image.
" + } + }, + "NearestModelName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The name of a pre-trained machine learning benchmarked by \n Amazon SageMaker Inference Recommender model that matches your model. \n You can find a list of benchmarked models by calling ListModelMetadata.
The additional data source that is used during inference in the Docker container for\n your model package.
" + } + }, + "ModelDataETag": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The ETag associated with Model Data URL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the Docker container for the model package.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + } + } + }, + "com.amazonaws.sagemaker#ModelPackageFrameworkVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 10 + }, + "smithy.api#pattern": "^[0-9]\\.[A-Za-z0-9.-]+$" + } + }, + "com.amazonaws.sagemaker#ModelPackageGroup": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the model group.
" + } + }, + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model group.
" + } + }, + "ModelPackageGroupDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "The description for the model group.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "The time that the model group was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ModelPackageGroupStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", + "traits": { + "smithy.api#documentation": "The status of the model group. This can be one of the following values.
\n\n PENDING - The model group is pending being created.
\n IN_PROGRESS - The model group is in the process of being\n created.
\n COMPLETED - The model group was successfully created.
\n FAILED - The model group failed.
\n DELETING - The model group is in the process of being deleted.
\n DELETE_FAILED - SageMaker failed to delete the model group.
A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A group of versioned models in the model registry.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupSummary": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model group.
", + "smithy.api#required": {} + } + }, + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model group.
", + "smithy.api#required": {} + } + }, + "ModelPackageGroupDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A description of the model group.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time that the model group was created.
", + "smithy.api#required": {} + } + }, + "ModelPackageGroupStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the model group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a model group.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageGroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupSummary" + } + }, + "com.amazonaws.sagemaker#ModelPackageModelCard": { + "type": "structure", + "members": { + "ModelCardContent": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#documentation": "The content of the model card. The content must follow the schema described\n in Model\n Package Model Card Schema.
" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates can be made to the model\n card content. If you try to update the model card content, you will receive the message Model Card\n \t is in Archived state.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
The KMS Key ID (KMSKeyId) used for encryption of model package information.
An optional Key Management Service\n key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with\n highly sensitive data.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageSourceUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{N}\\p{P}]{0,1024}$" + } + }, + "com.amazonaws.sagemaker#ModelPackageStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageStatusDetails": { + "type": "structure", + "members": { + "ValidationStatuses": { + "target": "com.amazonaws.sagemaker#ModelPackageStatusItemList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The validation status of the model package.
", + "smithy.api#required": {} + } + }, + "ImageScanStatuses": { + "target": "com.amazonaws.sagemaker#ModelPackageStatusItemList", + "traits": { + "smithy.api#documentation": "The status of the scan of the Docker image container for the model package.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the validation and image scan statuses of the model package.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageStatusItem": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model package for which the overall status is being reported.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#DetailedModelPackageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "if the overall status is Failed, the reason for the failure.
Represents the overall status of a model package.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageStatusItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageStatusItem" + } + }, + "com.amazonaws.sagemaker#ModelPackageSummaries": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ModelPackageArn" + }, + "value": { + "target": "com.amazonaws.sagemaker#BatchDescribeModelPackageSummary" + } + }, + "com.amazonaws.sagemaker#ModelPackageSummary": { + "type": "structure", + "members": { + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the model package.
" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "If the model package is a versioned model, the model group that the versioned model\n belongs to.
" + } + }, + "ModelPackageVersion": { + "target": "com.amazonaws.sagemaker#ModelPackageVersion", + "traits": { + "smithy.api#documentation": "If the model package is a versioned model, the version of the model.
" + } + }, + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
", + "smithy.api#required": {} + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A brief description of the model package.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the model package was created.
", + "smithy.api#required": {} + } + }, + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The overall status of the model package.
", + "smithy.api#required": {} + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "The approval status of the model. This can be one of the following values.
\n\n APPROVED - The model is approved
\n REJECTED - The model is rejected.
\n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.
Provides summary information about a model package.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageSummary" + } + }, + "com.amazonaws.sagemaker#ModelPackageType": { + "type": "enum", + "members": { + "VERSIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Versioned" + } + }, + "UNVERSIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unversioned" + } + }, + "BOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Both" + } + } + } + }, + "com.amazonaws.sagemaker#ModelPackageValidationProfile": { + "type": "structure", + "members": { + "ProfileName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the profile for the model package.
", + "smithy.api#required": {} + } + }, + "TransformJobDefinition": { + "target": "com.amazonaws.sagemaker#TransformJobDefinition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The TransformJobDefinition object that describes the transform job used\n for the validation of the model package.
Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.
\nThe data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageValidationProfiles": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationProfile" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#ModelPackageValidationSpecification": { + "type": "structure", + "members": { + "ValidationRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IAM roles to be used for the validation of the model package.
", + "smithy.api#required": {} + } + }, + "ValidationProfiles": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationProfiles", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of ModelPackageValidationProfile objects, each of which\n specifies a batch transform job that SageMaker runs to validate your model package.
Specifies batch transform jobs that SageMaker runs to validate your model package.
" + } + }, + "com.amazonaws.sagemaker#ModelPackageVersion": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ModelQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "Model quality statistics.
" + } + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource", + "traits": { + "smithy.api#documentation": "Model quality constraints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Model quality statistics and constraints.
" + } + }, + "com.amazonaws.sagemaker#ModelQualityAppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The address of the container image that the monitoring job runs.
", + "smithy.api#required": {} + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "traits": { + "smithy.api#documentation": "Specifies the entrypoint for a container that the monitoring job runs.
" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", + "traits": { + "smithy.api#documentation": "An array of arguments for the container used to run the monitoring job.
" + } + }, + "RecordPreprocessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" + } + }, + "PostAnalyticsProcessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" + } + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#MonitoringProblemType", + "traits": { + "smithy.api#documentation": "The machine learning problem type of the model that the monitoring job monitors.
" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "Sets the environment variables in the container that the monitoring job runs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container image configuration object for the monitoring job.
" + } + }, + "com.amazonaws.sagemaker#ModelQualityBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "The name of the job that performs baselining for the monitoring job.
" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" + } + }, + "com.amazonaws.sagemaker#ModelQualityJobInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput" + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "Input object for the batch transform job.
" + } + }, + "GroundTruthS3Input": { + "target": "com.amazonaws.sagemaker#MonitoringGroundTruthS3Input", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ground truth label provided for the model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the model quality monitoring job. Currently endpoints are supported for\n input for model quality monitoring jobs.
" + } + }, + "com.amazonaws.sagemaker#ModelQuantizationConfig": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
" + } + }, + "OverrideEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "Environment variables that override the default ones in the model container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for the model quantization technique that's applied by a model optimization job.
" + } + }, + "com.amazonaws.sagemaker#ModelRegisterSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "Describes whether the integration to the model registry is enabled or disabled in the\n Canvas application.
" + } + }, + "CrossAccountModelRegisterRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions\n created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services\n account in which SageMaker model registry is set up.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The model registry settings for the SageMaker Canvas application.
" + } + }, + "com.amazonaws.sagemaker#ModelSetupTime": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ModelShardingConfig": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
" + } + }, + "OverrideEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "Environment variables that override the default ones in the model container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for the model sharding technique that's applied by a model optimization job.
" + } + }, + "com.amazonaws.sagemaker#ModelSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ModelStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for Model steps.
" + } + }, + "com.amazonaws.sagemaker#ModelSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model that you want a summary for.
", + "smithy.api#required": {} + } + }, + "ModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that indicates when the model was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about a model.
" + } + }, + "com.amazonaws.sagemaker#ModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelSummary" + } + }, + "com.amazonaws.sagemaker#ModelVariantAction": { + "type": "enum", + "members": { + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Retain" + } + }, + "REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Remove" + } + }, + "PROMOTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Promote" + } + } + } + }, + "com.amazonaws.sagemaker#ModelVariantActionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ModelVariantName" + }, + "value": { + "target": "com.amazonaws.sagemaker#ModelVariantAction" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#ModelVariantConfig": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Amazon SageMaker Model entity.
", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#ModelVariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the variant.
", + "smithy.api#required": {} + } + }, + "InfrastructureConfig": { + "target": "com.amazonaws.sagemaker#ModelInfrastructureConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The configuration for the infrastructure that the model will be deployed to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the deployment options of a model.
" + } + }, + "com.amazonaws.sagemaker#ModelVariantConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelVariantConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sagemaker#ModelVariantConfigSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Amazon SageMaker Model entity.
", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#ModelVariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the variant.
", + "smithy.api#required": {} + } + }, + "InfrastructureConfig": { + "target": "com.amazonaws.sagemaker#ModelInfrastructureConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The configuration of the infrastructure that the model has been deployed to.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ModelVariantStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of deployment for the model variant on the hosted inference endpoint.
\n\n Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.\n
\n InService - The model variant is running on the hosted inference endpoint.\n
\n Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.\n
\n Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.\n
\n Deleted - The model variant has been deleted on the hosted inference endpoint. This\n can only happen after stopping the experiment.\n
Summary of the deployment configuration of a model.
" + } + }, + "com.amazonaws.sagemaker#ModelVariantConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelVariantConfigSummary" + } + }, + "com.amazonaws.sagemaker#ModelVariantName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + } + }, + "com.amazonaws.sagemaker#ModelVariantStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringAlertActions": { + "type": "structure", + "members": { + "ModelDashboardIndicator": { + "target": "com.amazonaws.sagemaker#ModelDashboardIndicatorAction", + "traits": { + "smithy.api#documentation": "An alert action taken to light up an icon on the Model Dashboard when an alert goes into\n InAlert status.
A list of alert actions taken in response to an alert going into\n InAlert status.
The name of a monitoring schedule.
", + "smithy.api#required": {} + } + }, + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of a monitoring alert.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that indicates when the first alert transition occurred in an alert history.\n An alert transition can be from status InAlert to OK, \n or from OK to InAlert.
The current alert status of an alert.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information of an alert's history.
" + } + }, + "com.amazonaws.sagemaker#MonitoringAlertName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#MonitoringAlertStatus": { + "type": "enum", + "members": { + "IN_ALERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InAlert" + } + }, + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringAlertSummary": { + "type": "structure", + "members": { + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of a monitoring alert.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that indicates when a monitor alert was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that indicates when a monitor alert was last updated.
", + "smithy.api#required": {} + } + }, + "AlertStatus": { + "target": "com.amazonaws.sagemaker#MonitoringAlertStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of an alert.
", + "smithy.api#required": {} + } + }, + "DatapointsToAlert": { + "target": "com.amazonaws.sagemaker#MonitoringDatapointsToAlert", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Within EvaluationPeriod, how many execution failures will raise an\n alert.
The number of most recent monitoring executions to consider when evaluating alert\n status.
", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.sagemaker#MonitoringAlertActions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of alert actions taken in response to an alert going into\n InAlert status.
Provides summary information about a monitor alert.
" + } + }, + "com.amazonaws.sagemaker#MonitoringAlertSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringAlertSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MonitoringAppSpecification": { + "type": "structure", + "members": { + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The container image to be run by the monitoring job.
", + "smithy.api#required": {} + } + }, + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "traits": { + "smithy.api#documentation": "Specifies the entrypoint for a container used to run the monitoring job.
" + } + }, + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", + "traits": { + "smithy.api#documentation": "An array of arguments for the container used to run the monitoring job.
" + } + }, + "RecordPreprocessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" + } + }, + "PostAnalyticsProcessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container image configuration object for the monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringBaselineConfig": { + "type": "structure", + "members": { + "BaseliningJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "The name of the job that performs baselining for the monitoring job.
" + } + }, + "ConstraintsResource": { + "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource", + "traits": { + "smithy.api#documentation": "The baseline constraint file in Amazon S3 that the current monitoring job should\n validated against.
" + } + }, + "StatisticsResource": { + "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource", + "traits": { + "smithy.api#documentation": "The baseline statistics file in Amazon S3 that the current monitoring job should\n be validated against.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" + } + }, + "com.amazonaws.sagemaker#MonitoringClusterConfig": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of ML compute instances to use in the model monitoring job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ML compute instance type for the processing job.
", + "smithy.api#required": {} + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The size of the ML storage volume, in gigabytes, that you want to provision. You must\n specify sufficient ML storage for your scenario.
", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker AI uses to\n encrypt data on the storage volume attached to the ML compute instance(s) that run the\n model monitoring job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for the cluster used to run model monitoring jobs.
" + } + }, + "com.amazonaws.sagemaker#MonitoringConstraintsResource": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI for the constraints resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The constraints resource for a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringContainerArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ContainerArgument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#MonitoringCsvDatasetFormat": { + "type": "structure", + "members": { + "Header": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the CSV data has a header.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the CSV dataset format used when running a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringDatapointsToAlert": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MonitoringDatasetFormat": { + "type": "structure", + "members": { + "Csv": { + "target": "com.amazonaws.sagemaker#MonitoringCsvDatasetFormat", + "traits": { + "smithy.api#documentation": "The CSV dataset used in the monitoring job.
" + } + }, + "Json": { + "target": "com.amazonaws.sagemaker#MonitoringJsonDatasetFormat", + "traits": { + "smithy.api#documentation": "The JSON dataset used in the monitoring job
" + } + }, + "Parquet": { + "target": "com.amazonaws.sagemaker#MonitoringParquetDatasetFormat", + "traits": { + "smithy.api#documentation": "The Parquet dataset used in the monitoring job
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the dataset format used when running a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#MonitoringEvaluationPeriod": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#MonitoringExecutionSortKey": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "SCHEDULED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ScheduledTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringExecutionSummary": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "ScheduledTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time the monitoring job was scheduled.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time at which the monitoring job was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that indicates the last time the monitoring job was modified.
", + "smithy.api#required": {} + } + }, + "MonitoringExecutionStatus": { + "target": "com.amazonaws.sagemaker#ExecutionStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the monitoring job.
", + "smithy.api#required": {} + } + }, + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring job.
" + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the endpoint used to run the monitoring job.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "Contains the reason a monitoring job failed, if it failed.
" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "The name of the monitoring job.
" + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "The type of the monitoring job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of information about the last monitoring job to run.
" + } + }, + "com.amazonaws.sagemaker#MonitoringExecutionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary" + } + }, + "com.amazonaws.sagemaker#MonitoringGroundTruthS3Input": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#MonitoringS3Uri", + "traits": { + "smithy.api#documentation": "The address of the Amazon S3 location of the ground truth labels.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The ground truth labels for the dataset used for the monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringInput": { + "type": "structure", + "members": { + "EndpointInput": { + "target": "com.amazonaws.sagemaker#EndpointInput", + "traits": { + "smithy.api#documentation": "The endpoint for a monitoring job.
" + } + }, + "BatchTransformInput": { + "target": "com.amazonaws.sagemaker#BatchTransformInput", + "traits": { + "smithy.api#documentation": "Input object for the batch transform job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The inputs for a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinition": { + "type": "structure", + "members": { + "BaselineConfig": { + "target": "com.amazonaws.sagemaker#MonitoringBaselineConfig", + "traits": { + "smithy.api#documentation": "Baseline configuration used to validate that the data conforms to the specified\n constraints and statistics
" + } + }, + "MonitoringInputs": { + "target": "com.amazonaws.sagemaker#MonitoringInputs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.
", + "smithy.api#required": {} + } + }, + "MonitoringOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The array of outputs from the monitoring job to be uploaded to Amazon S3.
", + "smithy.api#required": {} + } + }, + "MonitoringResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n monitoring job. In distributed processing, you specify more than one instance.
", + "smithy.api#required": {} + } + }, + "MonitoringAppSpecification": { + "target": "com.amazonaws.sagemaker#MonitoringAppSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Configures the monitoring job to run a specified Docker container image.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition", + "traits": { + "smithy.api#documentation": "Specifies a time limit for how long the monitoring job is allowed to run.
" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#MonitoringEnvironmentMap", + "traits": { + "smithy.api#documentation": "Sets the environment variables in the Docker container.
" + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig", + "traits": { + "smithy.api#documentation": "Specifies networking options for an monitoring job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionSummary": { + "type": "structure", + "members": { + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the monitoring job.
", + "smithy.api#required": {} + } + }, + "MonitoringJobDefinitionArn": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time that the monitoring job was created.
", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the endpoint that the job monitors.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringJobDefinitionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSummary" + } + }, + "com.amazonaws.sagemaker#MonitoringJsonDatasetFormat": { + "type": "structure", + "members": { + "Line": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the file should be read as a JSON object per line.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the JSON dataset format used when running a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 86400 + } + } + }, + "com.amazonaws.sagemaker#MonitoringNetworkConfig": { + "type": "structure", + "members": { + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Whether to encrypt all communications between the instances used for the monitoring\n jobs. Choose True to encrypt communications. Encryption provides greater\n security for distributed jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for\n the monitoring job.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "The networking configuration for the monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringOutput": { + "type": "structure", + "members": { + "S3Output": { + "target": "com.amazonaws.sagemaker#MonitoringS3Output", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 storage location where the results of a monitoring job are\n saved.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The output object for a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringOutputConfig": { + "type": "structure", + "members": { + "MonitoringOutputs": { + "target": "com.amazonaws.sagemaker#MonitoringOutputs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Monitoring outputs for monitoring jobs. This is where the output of the periodic\n monitoring jobs is uploaded.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker AI uses to\n encrypt the model artifacts at rest using Amazon S3 server-side encryption.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output configuration for monitoring jobs.
" + } + }, + "com.amazonaws.sagemaker#MonitoringOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringOutput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#MonitoringParquetDatasetFormat": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Represents the Parquet dataset format used when running a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringProblemType": { + "type": "enum", + "members": { + "BINARY_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BinaryClassification" + } + }, + "MULTICLASS_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MulticlassClassification" + } + }, + "REGRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Regression" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringResources": { + "type": "structure", + "members": { + "ClusterConfig": { + "target": "com.amazonaws.sagemaker#MonitoringClusterConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The configuration for the cluster resources used to run the processing job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Identifies the resources to deploy for a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringS3Output": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#MonitoringS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker AI\n saves the results of a monitoring job.
", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The local path to the Amazon S3 storage location where Amazon SageMaker AI\n saves the results of a monitoring job. LocalPath is an absolute path for the output\n data.
", + "smithy.api#required": {} + } + }, + "S3UploadMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3UploadMode", + "traits": { + "smithy.api#documentation": "Whether to upload the results of the monitoring job continuously or after the job\n completes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about where and how you want to store the results of a monitoring\n job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.sagemaker#MonitoringSchedule": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
" + } + }, + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#documentation": "The name of the monitoring schedule.
" + } + }, + "MonitoringScheduleStatus": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#documentation": "The status of the monitoring schedule. This can be one of the following values.
\n\n PENDING - The schedule is pending being created.
\n FAILED - The schedule failed.
\n SCHEDULED - The schedule was successfully created.
\n STOPPED - The schedule was stopped.
The type of the monitoring job definition to schedule.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the monitoring schedule failed, the reason it failed.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the monitoring schedule was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last time the monitoring schedule was changed.
" + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig" + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "The endpoint that hosts the model being monitored.
" + } + }, + "LastMonitoringExecutionSummary": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A schedule for a model monitoring job. For information about model monitor, see\n Amazon SageMaker Model\n Monitor.
" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleConfig": { + "type": "structure", + "members": { + "ScheduleConfig": { + "target": "com.amazonaws.sagemaker#ScheduleConfig", + "traits": { + "smithy.api#documentation": "Configures the monitoring schedule.
" + } + }, + "MonitoringJobDefinition": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinition", + "traits": { + "smithy.api#documentation": "Defines the monitoring job.
" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "The name of the monitoring job definition to schedule.
" + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "The type of the monitoring job definition to schedule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the monitoring schedule and defines the monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringSchedule" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleSortKey": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleSummary": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The creation time of the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The last time the monitoring schedule was modified.
", + "smithy.api#required": {} + } + }, + "MonitoringScheduleStatus": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the endpoint using the monitoring schedule.
" + } + }, + "MonitoringJobDefinitionName": { + "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", + "traits": { + "smithy.api#documentation": "The name of the monitoring job definition that the schedule is for.
" + } + }, + "MonitoringType": { + "target": "com.amazonaws.sagemaker#MonitoringType", + "traits": { + "smithy.api#documentation": "The type of the monitoring job definition that the schedule is for.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summarizes the monitoring schedule.
" + } + }, + "com.amazonaws.sagemaker#MonitoringScheduleSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleSummary" + } + }, + "com.amazonaws.sagemaker#MonitoringStatisticsResource": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI for the statistics resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The statistics resource for a monitoring job.
" + } + }, + "com.amazonaws.sagemaker#MonitoringStoppingCondition": { + "type": "structure", + "members": { + "MaxRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The maximum runtime allowed in seconds.
\nThe MaxRuntimeInSeconds cannot exceed the frequency of the job. For data\n quality and model explainability, this can be up to 3600 seconds for an hourly schedule.\n For model bias and model quality hourly schedules, this can be up to 1800\n seconds.
A time limit for how long the monitoring job is allowed to run before stopping.
" + } + }, + "com.amazonaws.sagemaker#MonitoringTimeOffsetString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^.?P" + } + }, + "com.amazonaws.sagemaker#MonitoringType": { + "type": "enum", + "members": { + "DATA_QUALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DataQuality" + } + }, + "MODEL_QUALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelQuality" + } + }, + "MODEL_BIAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelBias" + } + }, + "MODEL_EXPLAINABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelExplainability" + } + } + } + }, + "com.amazonaws.sagemaker#MountPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^\\/" + } + }, + "com.amazonaws.sagemaker#MultiModelConfig": { + "type": "structure", + "members": { + "ModelCacheSetting": { + "target": "com.amazonaws.sagemaker#ModelCacheSetting", + "traits": { + "smithy.api#documentation": "Whether to cache models for a multi-model endpoint. By default, multi-model endpoints\n cache models so that a model does not have to be loaded into memory each time it is\n invoked. Some use cases do not benefit from model caching. For example, if an endpoint\n hosts a large number of models that are each invoked infrequently, the endpoint might\n perform better if you disable model caching. To disable model caching, set the value of\n this parameter to Disabled.
Specifies additional configuration for hosting multi-model endpoints.
" + } + }, + "com.amazonaws.sagemaker#NameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" + } + }, + "com.amazonaws.sagemaker#NeoVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#NeoVpcSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the\n security groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC that you want to connect the compilation job to for\n accessing the model in Amazon S3.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The VpcConfig configuration object that specifies the VPC that you want the\n compilation jobs to connect to. For more information on controlling access to your Amazon S3\n buckets used for compilation job, see Give Amazon SageMaker AI Compilation Jobs Access to\n Resources in Your Amazon VPC.
" + } + }, + "com.amazonaws.sagemaker#NeoVpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#NeoVpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NeoVpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#NeoVpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#NeoVpcSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NeoVpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#NestedFilters": { + "type": "structure", + "members": { + "NestedPropertyName": { + "target": "com.amazonaws.sagemaker#ResourcePropertyName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the property to use in the nested filters. The value must match a listed property name,\n such as InputDataConfig.
A list of filters. Each filter acts on a property. Filters must contain at least one\n Filters value. For example, a NestedFilters call might\n include a filter on the PropertyName parameter of the\n InputDataConfig property:\n InputDataConfig.DataSource.S3DataSource.S3Uri.
A list of nested Filter objects. A resource must satisfy the conditions\n of all filters to be included in the results returned from the Search API.
\nFor example, to filter on a training job's InputDataConfig property with a\n specific channel name and S3Uri prefix, define the following filters:
\n '{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"Equals\", \"Value\":\"train\"}',\n
\n '{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"Contains\",\n \"Value\":\"mybucket/catdata\"}'\n
Whether to encrypt all communications between distributed processing jobs. Choose\n True to encrypt communications. Encryption provides greater security for distributed\n processing jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for\n the processing job.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "Networking options for a job, such as network traffic encryption between containers,\n whether to allow inbound and outbound network calls to and from containers, and the VPC\n subnets and security groups to use for VPC-enabled jobs.
" + } + }, + "com.amazonaws.sagemaker#NetworkInterfaceId": { + "type": "string" + }, + "com.amazonaws.sagemaker#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#NonEmptyString256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.sagemaker#NonEmptyString64": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceAcceleratorType": { + "type": "enum", + "members": { + "ML_EIA1_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.medium" + } + }, + "ML_EIA1_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.large" + } + }, + "ML_EIA1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.xlarge" + } + }, + "ML_EIA2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.medium" + } + }, + "ML_EIA2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.large" + } + }, + "ML_EIA2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorType" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleHook" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortKey": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LAST_MODIFIED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummary": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the lifecycle configuration.
", + "smithy.api#required": {} + } + }, + "NotebookInstanceLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle configuration.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A timestamp that tells when the lifecycle configuration was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A timestamp that tells when the lifecycle configuration was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of a notebook instance lifecycle configuration.
" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummary" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceLifecycleHook": { + "type": "structure", + "members": { + "Content": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigContent", + "traits": { + "smithy.api#documentation": "A base64-encoded string that contains a shell script for a notebook instance lifecycle\n configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the notebook instance lifecycle configuration script.
\nEach lifecycle configuration script has a limit of 16384 characters.
\nThe value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log\n group /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceSortKey": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceStatus": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + } + } + }, + "com.amazonaws.sagemaker#NotebookInstanceSummary": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the notebook instance that you want a summary for.
", + "smithy.api#required": {} + } + }, + "NotebookInstanceArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the notebook instance.
", + "smithy.api#required": {} + } + }, + "NotebookInstanceStatus": { + "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "traits": { + "smithy.api#documentation": "The status of the notebook instance.
" + } + }, + "Url": { + "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", + "traits": { + "smithy.api#documentation": "The URL that you use to connect to the Jupyter notebook running in your notebook\n instance.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", + "traits": { + "smithy.api#documentation": "The type of ML compute instance that the notebook instance is running on.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the notebook instance was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the notebook instance was last modified.
" + } + }, + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "The name of a notebook instance lifecycle configuration associated with this notebook\n instance.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "traits": { + "smithy.api#documentation": "An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information for an SageMaker AI notebook instance.
" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NotebookInstanceSummary" + } + }, + "com.amazonaws.sagemaker#NotebookInstanceUrl": { + "type": "string" + }, + "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 16384 + } + } + }, + "com.amazonaws.sagemaker#NotebookOutputOption": { + "type": "enum", + "members": { + "Allowed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Allowed" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#NotificationConfiguration": { + "type": "structure", + "members": { + "NotificationTopicArn": { + "target": "com.amazonaws.sagemaker#NotificationTopicArn", + "traits": { + "smithy.api#documentation": "The ARN for the Amazon SNS topic to which notifications should be published.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures Amazon SNS notifications of available or expiring work items for work\n teams.
" + } + }, + "com.amazonaws.sagemaker#NotificationTopicArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*$" + } + }, + "com.amazonaws.sagemaker#NumberOfAcceleratorDevices": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#NumberOfCpuCores": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0.25 + } + } + }, + "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 9 + } + } + }, + "com.amazonaws.sagemaker#NumberOfSteps": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ObjectiveStatus": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.sagemaker#ObjectiveStatusCounter": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ObjectiveStatusCounters": { + "type": "structure", + "members": { + "Succeeded": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", + "traits": { + "smithy.api#documentation": "The number of training jobs whose final objective metric was evaluated by the\n hyperparameter tuning job and used in the hyperparameter tuning process.
" + } + }, + "Pending": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", + "traits": { + "smithy.api#documentation": "The number of training jobs that are in progress and pending evaluation of their final\n objective metric.
" + } + }, + "Failed": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", + "traits": { + "smithy.api#documentation": "The number of training jobs whose final objective metric was not evaluated and used in\n the hyperparameter tuning process. This typically occurs when the training job failed or\n did not emit an objective metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the number of training jobs that this hyperparameter tuning job launched,\n categorized by the status of their objective metric. The objective metric status shows\n whether the\n final\n objective metric for the training job has been evaluated by the\n tuning job and used in the hyperparameter tuning process.
" + } + }, + "com.amazonaws.sagemaker#OfflineStoreConfig": { + "type": "structure", + "members": { + "S3StorageConfig": { + "target": "com.amazonaws.sagemaker#S3StorageConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Simple Storage (Amazon S3) location of OfflineStore.
Set to True to disable the automatic creation of an Amazon Web Services Glue\n table when configuring an OfflineStore. If set to False, Feature\n Store will name the OfflineStore Glue table following Athena's\n naming recommendations.
The default value is False.
The meta data of the Glue table that is autogenerated when an OfflineStore\n is created.
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of an OfflineStore.
Provide an OfflineStoreConfig in a request to\n CreateFeatureGroup to create an OfflineStore.
To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in\n S3StorageConfig.
An OfflineStore status.
The justification for why the OfflineStoreStatus is Blocked (if applicable).
" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of OfflineStore.
The OIDC IdP client ID used to configure your private workforce.
", + "smithy.api#required": {} + } + }, + "ClientSecret": { + "target": "com.amazonaws.sagemaker#ClientSecret", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The OIDC IdP client secret used to configure your private workforce.
", + "smithy.api#required": {} + } + }, + "Issuer": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The OIDC IdP issuer used to configure your private workforce.
", + "smithy.api#required": {} + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The OIDC IdP authorization endpoint used to configure your private workforce.
", + "smithy.api#required": {} + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The OIDC IdP token endpoint used to configure your private workforce.
", + "smithy.api#required": {} + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The OIDC IdP user information endpoint used to configure your private workforce.
", + "smithy.api#required": {} + } + }, + "LogoutEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The OIDC IdP logout endpoint used to configure your private workforce.
", + "smithy.api#required": {} + } + }, + "JwksUri": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.sagemaker#Scope", + "traits": { + "smithy.api#documentation": "An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
" + } + }, + "AuthenticationRequestExtraParams": { + "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParams", + "traits": { + "smithy.api#documentation": "A string to string map of identifiers specific to the custom identity provider (IdP) being used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Use this parameter to configure your OIDC Identity Provider (IdP).
" + } + }, + "com.amazonaws.sagemaker#OidcConfigForResponse": { + "type": "structure", + "members": { + "ClientId": { + "target": "com.amazonaws.sagemaker#ClientId", + "traits": { + "smithy.api#documentation": "The OIDC IdP client ID used to configure your private workforce.
" + } + }, + "Issuer": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "The OIDC IdP issuer used to configure your private workforce.
" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "The OIDC IdP authorization endpoint used to configure your private workforce.
" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "The OIDC IdP token endpoint used to configure your private workforce.
" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "The OIDC IdP user information endpoint used to configure your private workforce.
" + } + }, + "LogoutEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "The OIDC IdP logout endpoint used to configure your private workforce.
" + } + }, + "JwksUri": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
" + } + }, + "Scope": { + "target": "com.amazonaws.sagemaker#Scope", + "traits": { + "smithy.api#documentation": "An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
" + } + }, + "AuthenticationRequestExtraParams": { + "target": "com.amazonaws.sagemaker#AuthenticationRequestExtraParams", + "traits": { + "smithy.api#documentation": "A string to string map of identifiers specific to the custom identity provider (IdP) being used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Your OIDC IdP workforce configuration.
" + } + }, + "com.amazonaws.sagemaker#OidcEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^https://\\S+$" + } + }, + "com.amazonaws.sagemaker#OidcMemberDefinition": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.sagemaker#Groups", + "traits": { + "smithy.api#documentation": "A list of comma seperated strings that identifies\n user groups in your OIDC IdP. Each user group is\n made up of a group of private workers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.
Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your\n OnlineStore.
Turn OnlineStore off by specifying False for the\n EnableOnlineStore flag. Turn OnlineStore on by specifying\n True for the EnableOnlineStore flag.
The default value is False.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Option for different tiers of low latency storage for real-time data retrieval.
\n\n Standard: A managed low latency data store for feature groups.
\n InMemory: A managed data store for feature groups that supports very\n low latency retrieval.
Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or\n KMSKeyId, for at rest data encryption. You can turn\n OnlineStore on or off by specifying the EnableOnlineStore flag\n at General Assembly.
The default value is False.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Updates the feature group online store configuration.
" + } + }, + "com.amazonaws.sagemaker#OnlineStoreSecurityConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store\n uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side\n encryption.
\nThe caller (either user or IAM role) of CreateFeatureGroup must have below\n permissions to the OnlineStore\n KmsKeyId:
\n \"kms:Encrypt\"\n
\n \"kms:Decrypt\"\n
\n \"kms:DescribeKey\"\n
\n \"kms:CreateGrant\"\n
\n \"kms:RetireGrant\"\n
\n \"kms:ReEncryptFrom\"\n
\n \"kms:ReEncryptTo\"\n
\n \"kms:GenerateDataKey\"\n
\n \"kms:ListAliases\"\n
\n \"kms:ListGrants\"\n
\n \"kms:RevokeGrant\"\n
The caller (either user or IAM role) to all DataPlane operations\n (PutRecord, GetRecord, DeleteRecord) must have the\n following permissions to the KmsKeyId:
\n \"kms:Decrypt\"\n
The security configuration for OnlineStore.
Settings for the model quantization technique that's applied by a model optimization job.
" + } + }, + "ModelCompilationConfig": { + "target": "com.amazonaws.sagemaker#ModelCompilationConfig", + "traits": { + "smithy.api#documentation": "Settings for the model compilation technique that's applied by a model optimization job.
" + } + }, + "ModelShardingConfig": { + "target": "com.amazonaws.sagemaker#ModelShardingConfig", + "traits": { + "smithy.api#documentation": "Settings for the model sharding technique that's applied by a model optimization job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for an optimization technique that you apply with a model optimization\n job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#OptimizationContainerImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.sagemaker#OptimizationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:optimization-job/" + } + }, + "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType": { + "type": "enum", + "members": { + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "value": { + "target": "com.amazonaws.sagemaker#String256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#OptimizationJobModelSource": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.sagemaker#OptimizationJobModelSourceS3", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of a source model to optimize with an optimization job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location of the source model to optimize with an optimization job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationJobModelSourceS3": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "An Amazon S3 URI that locates a source model to optimize with an optimization job.
" + } + }, + "ModelAccessConfig": { + "target": "com.amazonaws.sagemaker#OptimizationModelAccessConfig", + "traits": { + "smithy.api#documentation": "The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location of a source model to optimize with an optimization job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationJobOutputConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the\n optimized model when SageMaker uploads the model to Amazon S3.
" + } + }, + "S3OutputLocation": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 URI for where to store the optimized model that you create with an optimization\n job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details for where to store the optimized model that you create with the optimization job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationJobStatus": { + "type": "enum", + "members": { + "INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#OptimizationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationJobSummary" + } + }, + "com.amazonaws.sagemaker#OptimizationJobSummary": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationJobArn": { + "target": "com.amazonaws.sagemaker#OptimizationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the optimization job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when you created the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationJobStatus": { + "target": "com.amazonaws.sagemaker#OptimizationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the optimization job started.
" + } + }, + "OptimizationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the optimization job finished processing.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "The time when the optimization job was last updated.
" + } + }, + "DeploymentInstanceType": { + "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of instance that hosts the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationTypes": { + "target": "com.amazonaws.sagemaker#OptimizationTypes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The optimization techniques that are applied by the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summarizes an optimization job by providing some of its key properties.
" + } + }, + "com.amazonaws.sagemaker#OptimizationModelAcceptEula": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#OptimizationModelAccessConfig": { + "type": "structure", + "members": { + "AcceptEula": { + "target": "com.amazonaws.sagemaker#OptimizationModelAcceptEula", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies agreement to the model end-user license agreement (EULA). The\n AcceptEula value must be explicitly defined as True in order\n to accept the EULA that this model requires. You are responsible for reviewing and\n complying with any applicable license terms and making sure they are acceptable for your\n use case before downloading or using a model.
The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
" + } + }, + "com.amazonaws.sagemaker#OptimizationOutput": { + "type": "structure", + "members": { + "RecommendedInferenceImage": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "The image that SageMaker recommends that you use to host the optimized model that you created\n with an optimization job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output values produced by an optimization job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationType": { + "type": "string" + }, + "com.amazonaws.sagemaker#OptimizationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationType" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your optimized\n model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization\n job. You can control access to and from your resources by configuring a VPC. For more\n information, see Give SageMaker Access to Resources in your Amazon VPC.
" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#OptionalDouble": { + "type": "double" + }, + "com.amazonaws.sagemaker#OptionalInteger": { + "type": "integer" + }, + "com.amazonaws.sagemaker#OptionalVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#OrderKey": { + "type": "enum", + "members": { + "Ascending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "Descending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#OutputCompressionType": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.sagemaker#OutputConfig": { + "type": "structure", + "members": { + "S3OutputLocation": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies the S3 bucket where you want Amazon SageMaker AI to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.
Identifies the target device or the machine learning instance that you want to run\n your model on after the compilation has completed. Alternatively, you can specify OS,\n architecture, and accelerator using TargetPlatform\n fields. It can be used instead of TargetPlatform.
Currently ml_trn1 is available only in US East (N. Virginia) Region,\n and ml_inf2 is available only in US East (Ohio) Region.
Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.
The following examples show how to configure the TargetPlatform and\n CompilerOptions JSON strings for popular target platforms:
Raspberry Pi 3 Model B+
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},\n
\n \"CompilerOptions\": {'mattr': ['+neon']}\n
Jetson TX2
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"NVIDIA\"},\n
\n \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1',\n 'cuda-ver': '10.0'}\n
EC2 m5.2xlarge instance OS
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\":\n \"NVIDIA\"},\n
\n \"CompilerOptions\": {'mcpu': 'skylake-avx512'}\n
RK3399
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"MALI\"}\n
ARMv7 phone (CPU)
\n\n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},\n
\n \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr':\n ['+neon']}\n
ARMv8 phone (CPU)
\n\n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},\n
\n \"CompilerOptions\": {'ANDROID_PLATFORM': 29}\n
Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA accelerators\n and highly recommended for CPU compilations. For any other cases, it is optional to\n specify CompilerOptions.\n
\n DTYPE: Specifies the data type for the input. When compiling for\n ml_* (except for ml_inf) instances using PyTorch\n framework, provide the data type (dtype) of the model's input.\n \"float32\" is used if \"DTYPE\" is not specified.\n Options for data type are:
float32: Use either \"float\" or\n \"float32\".
int64: Use either \"int64\" or \"long\".
For example, {\"dtype\" : \"float32\"}.
\n CPU: Compilation for CPU supports the following compiler\n options.
\n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n
\n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n
\n ARM: Details of ARM CPU compilations.
\n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.
For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.
\n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.
\n gpu_code: Specifies the targeted architecture.
\n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.
\n cuda-ver: Specifies the CUDA version in x.y\n format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n
\n ANDROID: Compilation for the Android OS supports the following\n compiler options:
\n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.
\n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.
\n INFERENTIA: Compilation for target ml_inf1 uses compiler options\n passed in as a JSON string. For example, \"CompilerOptions\": \"\\\"--verbose 1\n --num-neuroncores 2 -O2\\\"\".
For information about supported compiler options, see Neuron Compiler CLI Reference Guide.
\n\n CoreML: Compilation for the CoreML OutputConfig\n TargetDevice supports the following compiler options:
\n class_labels: Specifies the classification labels file\n name inside input tar.gz file. For example, {\"class_labels\":\n \"imagenet_labels_1000.txt\"}. Labels inside the txt file\n should be separated by newlines.
The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker AI\n uses to encrypt your output models with Amazon S3 server-side encryption after compilation\n job. If you don't provide a KMS key ID, Amazon SageMaker AI uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer\n Guide.\n
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
Contains information about the output location for the compiled model and the target\n device that the model runs on. TargetDevice and TargetPlatform\n are mutually exclusive, so you need to choose one between the two to specify your target\n device or platform. If you cannot find your device you want to use from the\n TargetDevice list, use TargetPlatform to describe the\n platform of your edge device and CompilerOptions if there are specific\n settings that are required or recommended to use for particular TargetPlatform.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account.\n \n For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide. If the output\n data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3\n managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services\n Key Management Service Developer Guide.
Identifies the S3 path where you want SageMaker to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.
The model output compression type. Select None to output an uncompressed\n model, recommended for large model outputs. Defaults to gzip.
Provides information about how to store model training results (model\n artifacts).
" + } + }, + "com.amazonaws.sagemaker#OutputParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the output parameter.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value of the output parameter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An output parameter of a pipeline step.
" + } + }, + "com.amazonaws.sagemaker#OutputParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OutputParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#OwnershipSettings": { + "type": "structure", + "members": { + "OwnerUserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The user profile who is the owner of the space.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of ownership settings for a space.
" + } + }, + "com.amazonaws.sagemaker#OwnershipSettingsSummary": { + "type": "structure", + "members": { + "OwnerUserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "The user profile who is the owner of the space.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies summary information about the ownership settings.
" + } + }, + "com.amazonaws.sagemaker#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ParallelismConfiguration": { + "type": "structure", + "members": { + "MaxParallelExecutionSteps": { + "target": "com.amazonaws.sagemaker#MaxParallelExecutionSteps", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The max number of steps that can be executed in parallel.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration that controls the parallelism of the pipeline. \n By default, the parallelism configuration specified applies to all \n executions of the pipeline unless overridden.
" + } + }, + "com.amazonaws.sagemaker#Parameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#PipelineParameterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the parameter to assign a value to. This \n parameter name must match a named parameter in the \n pipeline definition.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The literal value for the parameter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Assigns a value to a named Pipeline parameter.
" + } + }, + "com.amazonaws.sagemaker#ParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Parameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.sagemaker#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" + } + }, + "com.amazonaws.sagemaker#ParameterRange": { + "type": "structure", + "members": { + "IntegerParameterRangeSpecification": { + "target": "com.amazonaws.sagemaker#IntegerParameterRangeSpecification", + "traits": { + "smithy.api#documentation": "A IntegerParameterRangeSpecification object that defines the possible\n values for an integer hyperparameter.
A ContinuousParameterRangeSpecification object that defines the possible\n values for a continuous hyperparameter.
A CategoricalParameterRangeSpecification object that defines the possible\n values for a categorical hyperparameter.
Defines the possible values for categorical, continuous, and integer hyperparameters\n to be used by an algorithm.
" + } + }, + "com.amazonaws.sagemaker#ParameterRanges": { + "type": "structure", + "members": { + "IntegerParameterRanges": { + "target": "com.amazonaws.sagemaker#IntegerParameterRanges", + "traits": { + "smithy.api#documentation": "The array of IntegerParameterRange objects that specify ranges of integer\n hyperparameters that a hyperparameter tuning job searches.
" + } + }, + "ContinuousParameterRanges": { + "target": "com.amazonaws.sagemaker#ContinuousParameterRanges", + "traits": { + "smithy.api#documentation": "The array of ContinuousParameterRange objects that specify ranges of continuous\n hyperparameters that a hyperparameter tuning job searches.
" + } + }, + "CategoricalParameterRanges": { + "target": "com.amazonaws.sagemaker#CategoricalParameterRanges", + "traits": { + "smithy.api#documentation": "The array of CategoricalParameterRange objects that specify ranges of categorical\n hyperparameters that a hyperparameter tuning job searches.
" + } + }, + "AutoParameters": { + "target": "com.amazonaws.sagemaker#AutoParameters", + "traits": { + "smithy.api#documentation": "A list containing hyperparameter names and example values to be used by Autotune to\n determine optimal ranges for your tuning job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.
\nThe maximum number of items specified for Array Members refers to the\n maximum number of hyperparameters for each range and also the maximum for the\n hyperparameter tuning job itself. That is, the sum of the number of hyperparameters\n for all the ranges can't exceed the maximum number specified.
The name of the trial.
" + } + }, + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The trial that a trial component is associated with and the experiment the trial is part\n of. A component might not be associated with a trial. A component can be associated with\n multiple trials.
" + } + }, + "com.amazonaws.sagemaker#ParentHyperParameterTuningJob": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#documentation": "The name of the hyperparameter tuning job to be used as a starting point for a new\n hyperparameter tuning job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A previously completed or stopped hyperparameter tuning job to be used as a starting\n point for a new hyperparameter tuning job.
" + } + }, + "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJob" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#Parents": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Parent" + } + }, + "com.amazonaws.sagemaker#PartnerAppAdminUserList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#PartnerAppArguments": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "value": { + "target": "com.amazonaws.sagemaker#String1024" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#PartnerAppArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:partner-app\\/app-[A-Z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#PartnerAppAuthType": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + } + } + }, + "com.amazonaws.sagemaker#PartnerAppConfig": { + "type": "structure", + "members": { + "AdminUsers": { + "target": "com.amazonaws.sagemaker#PartnerAppAdminUserList", + "traits": { + "smithy.api#documentation": "The list of users that are given admin access to the SageMaker Partner AI App.
" + } + }, + "Arguments": { + "target": "com.amazonaws.sagemaker#PartnerAppArguments", + "traits": { + "smithy.api#documentation": "This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig": { + "type": "structure", + "members": { + "MaintenanceWindowStart": { + "target": "com.amazonaws.sagemaker#WeeklyScheduleTimeFormat", + "traits": { + "smithy.api#documentation": "The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.
Maintenance configuration settings for the SageMaker Partner AI App.
" + } + }, + "com.amazonaws.sagemaker#PartnerAppName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.sagemaker#PartnerAppStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + } + } + }, + "com.amazonaws.sagemaker#PartnerAppSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PartnerAppSummary" + } + }, + "com.amazonaws.sagemaker#PartnerAppSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App.
" + } + }, + "Name": { + "target": "com.amazonaws.sagemaker#PartnerAppName", + "traits": { + "smithy.api#documentation": "The name of the SageMaker Partner AI App.
" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#PartnerAppType", + "traits": { + "smithy.api#documentation": "The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The status of the SageMaker Partner AI App.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the SageMaker Partner AI App.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A subset of information related to a SageMaker Partner AI App. This information is used as part of the ListPartnerApps API response.
The name of the endpoint configuration used in the deployment.
", + "smithy.api#required": {} + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint for the in-progress deployment.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the deployment.
" + } + }, + "ShadowProductionVariants": { + "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint in shadow mode with production traffic replicated from the model specified\n on ProductionVariants for the in-progress deployment.
The summary of an in-progress deployment when an endpoint is creating or updating with\n a new endpoint configuration.
" + } + }, + "com.amazonaws.sagemaker#PendingProductionVariantSummary": { + "type": "structure", + "members": { + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the variant.
", + "smithy.api#required": {} + } + }, + "DeployedImages": { + "target": "com.amazonaws.sagemaker#DeployedImages", + "traits": { + "smithy.api#documentation": "An array of DeployedImage objects that specify the Amazon EC2 Container\n Registry paths of the inference images deployed on instances of this\n ProductionVariant.
The weight associated with the variant.
" + } + }, + "DesiredWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "The requested weight for the variant in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
" + } + }, + "CurrentInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "The number of instances associated with the variant.
" + } + }, + "DesiredInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "The number of instances requested in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "The type of instances associated with the variant.
" + } + }, + "AcceleratorType": { + "target": "com.amazonaws.sagemaker#ProductionVariantAcceleratorType", + "traits": { + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify the size of the EI instance to use for the\n production variant.
" + } + }, + "VariantStatus": { + "target": "com.amazonaws.sagemaker#ProductionVariantStatusList", + "traits": { + "smithy.api#documentation": "The endpoint variant status which describes the current deployment stage status or\n operational status.
" + } + }, + "CurrentServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "The serverless configuration for the endpoint.
" + } + }, + "DesiredServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.
" + } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The production variant summary for a deployment when an endpoint is creating or\n updating with the CreateEndpoint\n or UpdateEndpoint\n operations. Describes the VariantStatus , weight and capacity for a\n production variant associated with an endpoint.
Specifies how many concurrent users to start with. The value should be between 1 and 3.
" + } + }, + "SpawnRate": { + "target": "com.amazonaws.sagemaker#SpawnRate", + "traits": { + "smithy.api#documentation": "Specified how many new users to spawn in a minute.
" + } + }, + "DurationInSeconds": { + "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", + "traits": { + "smithy.api#documentation": "Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600.\n This value should not exceed JobDurationInSeconds.
Defines the traffic pattern.
" + } + }, + "com.amazonaws.sagemaker#Phases": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Phase" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#Pipeline": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" + } + }, + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "The name of the pipeline.
" + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline.
" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "The description of the pipeline.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that created the pipeline.
" + } + }, + "PipelineStatus": { + "target": "com.amazonaws.sagemaker#PipelineStatus", + "traits": { + "smithy.api#documentation": "The status of the pipeline.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the pipeline.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the pipeline was last modified.
" + } + }, + "LastRunTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the pipeline was last run.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "The parallelism configuration applied to the pipeline.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags that apply to the pipeline.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A SageMaker Model Building Pipeline instance.
" + } + }, + "com.amazonaws.sagemaker#PipelineArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/" + } + }, + "com.amazonaws.sagemaker#PipelineDefinition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1048576 + }, + "smithy.api#pattern": "(?:[ \\r\\n\\t].*)*$" + } + }, + "com.amazonaws.sagemaker#PipelineDefinitionS3Location": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.sagemaker#BucketName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the S3 bucket.
", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.sagemaker#Key", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The object key (or key name) uniquely identifies the \n object in an S3 bucket.
", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.sagemaker#VersionId", + "traits": { + "smithy.api#documentation": "Version Id of the pipeline definition file. If not specified, Amazon SageMaker \n will retrieve the latest version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3.
" + } + }, + "com.amazonaws.sagemaker#PipelineDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3072 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PipelineExecution": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline that was executed.
" + } + }, + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline execution.
" + } + }, + "PipelineExecutionStatus": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStatus", + "traits": { + "smithy.api#documentation": "The status of the pipeline status.
" + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "The description of the pipeline execution.
" + } + }, + "PipelineExperimentConfig": { + "target": "com.amazonaws.sagemaker#PipelineExperimentConfig" + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#PipelineExecutionFailureReason", + "traits": { + "smithy.api#documentation": "If the execution failed, a message describing why.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the pipeline execution.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the pipeline execution was last modified.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "The parallelism configuration applied to the pipeline execution.
" + } + }, + "SelectiveExecutionConfig": { + "target": "com.amazonaws.sagemaker#SelectiveExecutionConfig", + "traits": { + "smithy.api#documentation": "The selective execution configuration applied to the pipeline run.
" + } + }, + "PipelineParameters": { + "target": "com.amazonaws.sagemaker#ParameterList", + "traits": { + "smithy.api#documentation": "Contains a list of pipeline parameters. This list can be empty.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An execution of a pipeline.
" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3072 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionFailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1300 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 82 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}$" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionStatus": { + "type": "enum", + "members": { + "EXECUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Executing" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } + } + }, + "com.amazonaws.sagemaker#PipelineExecutionStep": { + "type": "structure", + "members": { + "StepName": { + "target": "com.amazonaws.sagemaker#StepName", + "traits": { + "smithy.api#documentation": "The name of the step that is executed.
" + } + }, + "StepDisplayName": { + "target": "com.amazonaws.sagemaker#StepDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the step.
" + } + }, + "StepDescription": { + "target": "com.amazonaws.sagemaker#StepDescription", + "traits": { + "smithy.api#documentation": "The description of the step.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the step started executing.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the step stopped executing.
" + } + }, + "StepStatus": { + "target": "com.amazonaws.sagemaker#StepStatus", + "traits": { + "smithy.api#documentation": "The status of the step execution.
" + } + }, + "CacheHitResult": { + "target": "com.amazonaws.sagemaker#CacheHitResult", + "traits": { + "smithy.api#documentation": "If this pipeline execution step was cached, details on the cache hit.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "The reason why the step failed execution. This is only returned if the step failed its execution.
" + } + }, + "Metadata": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStepMetadata", + "traits": { + "smithy.api#documentation": "Metadata to run the pipeline step.
" + } + }, + "AttemptCount": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
" + } + }, + "SelectiveExecutionResult": { + "target": "com.amazonaws.sagemaker#SelectiveExecutionResult", + "traits": { + "smithy.api#documentation": "The ARN from an execution of the current pipeline from which\n results are reused for this step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An execution of a step in a pipeline.
" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStep" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#PipelineExecutionStepMetadata": { + "type": "structure", + "members": { + "TrainingJob": { + "target": "com.amazonaws.sagemaker#TrainingJobStepMetadata", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job that was run by this step execution.
" + } + }, + "ProcessingJob": { + "target": "com.amazonaws.sagemaker#ProcessingJobStepMetadata", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
" + } + }, + "TransformJob": { + "target": "com.amazonaws.sagemaker#TransformJobStepMetadata", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
" + } + }, + "TuningJob": { + "target": "com.amazonaws.sagemaker#TuningJobStepMetaData", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
" + } + }, + "Model": { + "target": "com.amazonaws.sagemaker#ModelStepMetadata", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model that was created by this step execution.
" + } + }, + "RegisterModel": { + "target": "com.amazonaws.sagemaker#RegisterModelStepMetadata", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
" + } + }, + "Condition": { + "target": "com.amazonaws.sagemaker#ConditionStepMetadata", + "traits": { + "smithy.api#documentation": "The outcome of the condition evaluation that was run by this step execution.
" + } + }, + "Callback": { + "target": "com.amazonaws.sagemaker#CallbackStepMetadata", + "traits": { + "smithy.api#documentation": "The URL of the Amazon SQS queue used by this step execution, the pipeline generated token,\n and a list of output parameters.
" + } + }, + "Lambda": { + "target": "com.amazonaws.sagemaker#LambdaStepMetadata", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of\n output parameters.
" + } + }, + "EMR": { + "target": "com.amazonaws.sagemaker#EMRStepMetadata", + "traits": { + "smithy.api#documentation": "The configurations and outcomes of an Amazon EMR step execution.
" + } + }, + "QualityCheck": { + "target": "com.amazonaws.sagemaker#QualityCheckStepMetadata", + "traits": { + "smithy.api#documentation": "The configurations and outcomes of the check step execution. This includes:
\nThe type of the check conducted.
\nThe Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
\nThe Amazon S3 URIs of newly calculated baseline constraints and statistics.
\nThe model package group name provided.
\nThe Amazon S3 URI of the violation report if violations detected.
\nThe Amazon Resource Name (ARN) of check processing job initiated by the step execution.
\nThe Boolean flags indicating if the drift check is skipped.
\nIf step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.
Container for the metadata for a Clarify check step. The configurations \n and outcomes of the check step execution. This includes:
\nThe type of the check conducted,
\nThe Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
\nThe Amazon S3 URIs of newly calculated baseline constraints and statistics.
\nThe model package group name provided.
\nThe Amazon S3 URI of the violation report if violations detected.
\nThe Amazon Resource Name (ARN) of check processing job initiated by the step execution.
\nThe boolean flags indicating if the drift check is skipped.
\nIf step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.
The configurations and outcomes of a Fail step execution.
" + } + }, + "AutoMLJob": { + "target": "com.amazonaws.sagemaker#AutoMLJobStepMetadata", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
" + } + }, + "Endpoint": { + "target": "com.amazonaws.sagemaker#EndpointStepMetadata", + "traits": { + "smithy.api#documentation": "The endpoint that was invoked during this step execution.
" + } + }, + "EndpointConfig": { + "target": "com.amazonaws.sagemaker#EndpointConfigStepMetadata", + "traits": { + "smithy.api#documentation": "The endpoint configuration used to create an endpoint during this step execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for a step execution.
" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionSummary": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the pipeline execution.
" + } + }, + "PipelineExecutionStatus": { + "target": "com.amazonaws.sagemaker#PipelineExecutionStatus", + "traits": { + "smithy.api#documentation": "The status of the pipeline execution.
" + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "The description of the pipeline execution.
" + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline execution.
" + } + }, + "PipelineExecutionFailureReason": { + "target": "com.amazonaws.sagemaker#String3072", + "traits": { + "smithy.api#documentation": "A message generated by SageMaker Pipelines describing why the pipeline execution failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A pipeline execution summary.
" + } + }, + "com.amazonaws.sagemaker#PipelineExecutionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PipelineExecutionSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#PipelineExperimentConfig": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment.
" + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the names of the experiment and trial created by a pipeline.
" + } + }, + "com.amazonaws.sagemaker#PipelineName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$" + } + }, + "com.amazonaws.sagemaker#PipelineNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})$" + } + }, + "com.amazonaws.sagemaker#PipelineParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.sagemaker#PipelineStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#PipelineSummary": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" + } + }, + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "The name of the pipeline.
" + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline.
" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "The description of the pipeline.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that the pipeline used to execute.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the pipeline.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the pipeline was last modified.
" + } + }, + "LastExecutionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that a pipeline execution began.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a pipeline.
" + } + }, + "com.amazonaws.sagemaker#PipelineSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PipelineSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#PlatformIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + }, + "smithy.api#pattern": "^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3)$" + } + }, + "com.amazonaws.sagemaker#PolicyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20480 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PredefinedMetricSpecification": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The metric type. You can only apply SageMaker metric types to SageMaker endpoints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A specification for a predefined metric.
" + } + }, + "com.amazonaws.sagemaker#PreemptTeamTasks": { + "type": "enum", + "members": { + "NEVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Never" + } + }, + "LOWERPRIORITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LowerPriority" + } + } + } + }, + "com.amazonaws.sagemaker#PresignedDomainUrl": { + "type": "string" + }, + "com.amazonaws.sagemaker#PriorityClass": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerPriorityClassName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name of the priority class.
", + "smithy.api#required": {} + } + }, + "Weight": { + "target": "com.amazonaws.sagemaker#PriorityWeight", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Weight of the priority class. The value is within a range from 0 to 100, where 0 is the\n default.
\nA weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Priority class configuration. When included in PriorityClasses, these class\n configurations define how tasks are queued.
The number of ML compute instances to use in the processing job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ML compute instance type for the processing job.
", + "smithy.api#required": {} + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.
\nCertain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts\n the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.
For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.
\nThe Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the\n storage volume attached to the ML compute instance(s) that run the processing job.\n
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nConfiguration for the cluster used to run a processing job.
" + } + }, + "com.amazonaws.sagemaker#ProcessingEnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.sagemaker#ProcessingEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ProcessingEnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#ProcessingFeatureStoreOutput": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your \n processing script is responsible for putting records into your Feature Store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for processing job outputs in Amazon SageMaker Feature Store.
" + } + }, + "com.amazonaws.sagemaker#ProcessingInput": { + "type": "structure", + "members": { + "InputName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name for the processing job input.
", + "smithy.api#required": {} + } + }, + "AppManaged": { + "target": "com.amazonaws.sagemaker#AppManaged", + "traits": { + "smithy.api#documentation": "When True, input operations such as data download are managed natively by the\n processing job application. When False (default), input operations are managed by Amazon SageMaker.
Configuration for downloading input data from Amazon S3 into the processing container.
" + } + }, + "DatasetDefinition": { + "target": "com.amazonaws.sagemaker#DatasetDefinition", + "traits": { + "smithy.api#documentation": "Configuration for a Dataset Definition input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The inputs for a processing job. The processing input must specify exactly one of either\n S3Input or DatasetDefinition types.
List of input configurations for the processing job.
" + } + }, + "ProcessingOutputConfig": { + "target": "com.amazonaws.sagemaker#ProcessingOutputConfig" + }, + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#documentation": "The name of the processing job.
" + } + }, + "ProcessingResources": { + "target": "com.amazonaws.sagemaker#ProcessingResources" + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition" + }, + "AppSpecification": { + "target": "com.amazonaws.sagemaker#AppSpecification" + }, + "Environment": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", + "traits": { + "smithy.api#documentation": "Sets the environment variables in the Docker container.
" + } + }, + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig" + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the role used to create the processing job.
" + } + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "The ARN of the processing job.
" + } + }, + "ProcessingJobStatus": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#documentation": "The status of the processing job.
" + } + }, + "ExitMessage": { + "target": "com.amazonaws.sagemaker#ExitMessage", + "traits": { + "smithy.api#documentation": "A string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.
" + } + }, + "ProcessingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the processing job ended.
" + } + }, + "ProcessingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the processing job started.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time the processing job was last modified.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time the processing job was created.
" + } + }, + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#documentation": "The ARN of a monitoring schedule for an endpoint associated with this processing\n job.
" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
" + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#documentation": "The ARN of the training job associated with this processing job.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information,\n see Process\n Data and Evaluate Models.
" + } + }, + "com.amazonaws.sagemaker#ProcessingJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/" + } + }, + "com.amazonaws.sagemaker#ProcessingJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#ProcessingJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingJobStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for a processing job step.
" + } + }, + "com.amazonaws.sagemaker#ProcessingJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProcessingJobSummary" + } + }, + "com.amazonaws.sagemaker#ProcessingJobSummary": { + "type": "structure", + "members": { + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the processing job.
", + "smithy.api#required": {} + } + }, + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the processing job..
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time at which the processing job was created.
", + "smithy.api#required": {} + } + }, + "ProcessingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the processing job completed.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates the last time the processing job was modified.
" + } + }, + "ProcessingJobStatus": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the processing job.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.
" + } + }, + "ExitMessage": { + "target": "com.amazonaws.sagemaker#ExitMessage", + "traits": { + "smithy.api#documentation": "An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of information about a processing job.
" + } + }, + "com.amazonaws.sagemaker#ProcessingLocalPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ProcessingMaxRuntimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 777600 + } + } + }, + "com.amazonaws.sagemaker#ProcessingOutput": { + "type": "structure", + "members": { + "OutputName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name for the processing job output.
", + "smithy.api#required": {} + } + }, + "S3Output": { + "target": "com.amazonaws.sagemaker#ProcessingS3Output", + "traits": { + "smithy.api#documentation": "Configuration for processing job outputs in Amazon S3.
" + } + }, + "FeatureStoreOutput": { + "target": "com.amazonaws.sagemaker#ProcessingFeatureStoreOutput", + "traits": { + "smithy.api#documentation": "Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output\n type is only supported when AppManaged is specified.
When True, output operations such as data upload are managed natively by the\n processing job application. When False (default), output operations are managed by\n Amazon SageMaker.
Describes the results of a processing job. The processing output must specify exactly one of\n either S3Output or FeatureStoreOutput types.
An array of outputs configuring the data to upload from the processing container.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing\n job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of\n a KMS key, or alias of a KMS key. The KmsKeyId is applied to all\n outputs.
Configuration for uploading output from the processing container.
" + } + }, + "com.amazonaws.sagemaker#ProcessingOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProcessingOutput" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#ProcessingResources": { + "type": "structure", + "members": { + "ClusterConfig": { + "target": "com.amazonaws.sagemaker#ProcessingClusterConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The configuration for the resources in a cluster used to run the processing\n job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.
" + } + }, + "com.amazonaws.sagemaker#ProcessingS3CompressionType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gzip" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingS3DataDistributionType": { + "type": "enum", + "members": { + "FULLYREPLICATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FullyReplicated" + } + }, + "SHARDEDBYS3KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShardedByS3Key" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingS3DataType": { + "type": "enum", + "members": { + "MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManifestFile" + } + }, + "S3_PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingS3Input": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#documentation": "The local path in your container where you want Amazon SageMaker to write input data to. \n LocalPath is an absolute path to the input data and must begin with \n /opt/ml/processing/. LocalPath is a required \n parameter when AppManaged is False (default).
Whether you use an S3Prefix or a ManifestFile for\n the data type. If you choose S3Prefix, S3Uri identifies a key\n name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing\n job. If you choose ManifestFile, S3Uri identifies an object\n that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for\n the processing job.
Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data \n from the input source onto the local ML storage volume before starting your processing \n container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker \n streams input data from the source directly to your processing container into named \n pipes without using the ML storage volume.
Whether to distribute the data from Amazon S3 to all processing instances with \n FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, \n downloading one shard of data to each processing instance.
Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing \n container. Gzip can only be used when Pipe mode is \n specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input \n data from the source directly to your container without using the EBS volume.
Configuration for downloading input data from Amazon S3 into the processing container.
" + } + }, + "com.amazonaws.sagemaker#ProcessingS3InputMode": { + "type": "enum", + "members": { + "PIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipe" + } + }, + "FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "File" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingS3Output": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of\n a processing job.
", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "traits": { + "smithy.api#documentation": "The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. \n LocalPath is an absolute path to a directory containing output files. \n This directory will be created by the platform and exist when your container's \n entrypoint is invoked.
Whether to upload the results of the processing job continuously or after the job\n completes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for uploading output data to Amazon S3 from the processing container.
" + } + }, + "com.amazonaws.sagemaker#ProcessingS3UploadMode": { + "type": "enum", + "members": { + "CONTINUOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Continuous" + } + }, + "END_OF_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EndOfJob" + } + } + } + }, + "com.amazonaws.sagemaker#ProcessingStoppingCondition": { + "type": "structure", + "members": { + "MaxRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#ProcessingMaxRuntimeInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the maximum runtime in seconds.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configures conditions under which the processing job should be stopped, such as how long \n the processing job has been running. After the condition is met, the processing job is stopped.
" + } + }, + "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.sagemaker#Processor": { + "type": "enum", + "members": { + "CPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPU" + } + }, + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GPU" + } + } + } + }, + "com.amazonaws.sagemaker#ProductId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ProductListings": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#String" + } + }, + "com.amazonaws.sagemaker#ProductionVariant": { + "type": "structure", + "members": { + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the production variant.
", + "smithy.api#required": {} + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that you want to host. This is the name that you specified\n when creating the model.
" + } + }, + "InitialInstanceCount": { + "target": "com.amazonaws.sagemaker#InitialTaskCount", + "traits": { + "smithy.api#documentation": "Number of instances to launch initially.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "The ML compute instance type.
" + } + }, + "InitialVariantWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "Determines initial traffic distribution among all of the models that you specify in\n the endpoint configuration. The traffic to a production variant is determined by the\n ratio of the VariantWeight to the sum of all VariantWeight\n values across all ProductionVariants. If unspecified, it defaults to 1.0.\n
This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify the size of the EI instance to use for the\n production variant.
" + } + }, + "CoreDumpConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantCoreDumpConfig", + "traits": { + "smithy.api#documentation": "Specifies configuration for a core dump from the model container when the process\n crashes.
" + } + }, + "ServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ProductionVariantVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to individual inference instance\n associated with the production variant. Currently only Amazon EBS gp2 storage volumes are\n supported.
" + } + }, + "ModelDataDownloadTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this production\n variant.
" + } + }, + "ContainerStartupHealthCheckTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "The timeout value, in seconds, for your inference container to pass health check by\n SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
" + } + }, + "EnableSSMAccess": { + "target": "com.amazonaws.sagemaker#ProductionVariantSSMAccess", + "traits": { + "smithy.api#documentation": " You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM)\n access for a production variant behind an endpoint. By default, SSM access is disabled\n for all production variants behind an endpoint. You can turn on or turn off SSM access\n for a production variant behind an existing endpoint by creating a new endpoint\n configuration and calling UpdateEndpoint.
Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" + } + }, + "InferenceAmiVersion": { + "target": "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion", + "traits": { + "smithy.api#documentation": "Specifies an option from a collection of preconfigured Amazon Machine Image (AMI)\n images. Each image is configured by Amazon Web Services with a set of software and driver\n versions. Amazon Web Services optimizes these configurations for different machine\n learning workloads.
\nBy selecting an AMI version, you can ensure that your inference environment is\n compatible with specific software requirements, such as CUDA driver versions, Linux\n kernel versions, or Amazon Web Services Neuron driver versions.
\nThe AMI version names, and their configurations, are the following:
\nAccelerator: GPU
\nNVIDIA driver version: 535.54.03
\nCUDA driver version: 12.2
\nSupported instance types: ml.g4dn.*, ml.g5.*, ml.g6.*, ml.p3.*,\n ml.p4d.*, ml.p4de.*, ml.p5.*
\nIdentifies a model that you want to host and the resources chosen to deploy for\n hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic\n among the models by specifying variant weights. For more information on production\n variants, check Production variants.\n
" + } + }, + "com.amazonaws.sagemaker#ProductionVariantAcceleratorType": { + "type": "enum", + "members": { + "ML_EIA1_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.medium" + } + }, + "ML_EIA1_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.large" + } + }, + "ML_EIA1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia1.xlarge" + } + }, + "ML_EIA2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.medium" + } + }, + "ML_EIA2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.large" + } + }, + "ML_EIA2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.eia2.xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantCoreDumpConfig": { + "type": "structure", + "members": { + "DestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 bucket to send the core dump to.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management\n Service Developer Guide.
Specifies configuration for a core dump from the model container when the process\n crashes.
" + } + }, + "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion": { + "type": "enum", + "members": { + "AL2_GPU_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "al2-ami-sagemaker-inference-gpu-2" + } + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantInstanceType": { + "type": "enum", + "members": { + "ML_T2_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.medium" + } + }, + "ML_T2_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.large" + } + }, + "ML_T2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.xlarge" + } + }, + "ML_T2_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t2.2xlarge" + } + }, + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.large" + } + }, + "ML_M5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.xlarge" + } + }, + "ML_M5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.2xlarge" + } + }, + "ML_M5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.4xlarge" + } + }, + "ML_M5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.12xlarge" + } + }, + "ML_M5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5d.24xlarge" + } + }, + "ML_C4_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.large" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_C5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.large" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.large" + } + }, + "ML_C5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.xlarge" + } + }, + "ML_C5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.2xlarge" + } + }, + "ML_C5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.4xlarge" + } + }, + "ML_C5D_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.9xlarge" + } + }, + "ML_C5D_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5d.18xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + }, + "ML_R5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.large" + } + }, + "ML_R5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.xlarge" + } + }, + "ML_R5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.2xlarge" + } + }, + "ML_R5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.4xlarge" + } + }, + "ML_R5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.12xlarge" + } + }, + "ML_R5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.24xlarge" + } + }, + "ML_INF1_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.xlarge" + } + }, + "ML_INF1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.2xlarge" + } + }, + "ML_INF1_6XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.6xlarge" + } + }, + "ML_INF1_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf1.24xlarge" + } + }, + "ML_DL1_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.dl1.24xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_G6E_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.xlarge" + } + }, + "ML_G6E_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.2xlarge" + } + }, + "ML_G6E_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.4xlarge" + } + }, + "ML_G6E_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.8xlarge" + } + }, + "ML_G6E_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.12xlarge" + } + }, + "ML_G6E_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.16xlarge" + } + }, + "ML_G6E_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.24xlarge" + } + }, + "ML_G6E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.48xlarge" + } + }, + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_C7G_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.large" + } + }, + "ML_C7G_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.xlarge" + } + }, + "ML_C7G_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.2xlarge" + } + }, + "ML_C7G_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.4xlarge" + } + }, + "ML_C7G_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.8xlarge" + } + }, + "ML_C7G_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.12xlarge" + } + }, + "ML_C7G_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7g.16xlarge" + } + }, + "ML_M6G_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.large" + } + }, + "ML_M6G_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.xlarge" + } + }, + "ML_M6G_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.2xlarge" + } + }, + "ML_M6G_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.4xlarge" + } + }, + "ML_M6G_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.8xlarge" + } + }, + "ML_M6G_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.12xlarge" + } + }, + "ML_M6G_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6g.16xlarge" + } + }, + "ML_M6GD_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.large" + } + }, + "ML_M6GD_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.xlarge" + } + }, + "ML_M6GD_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.2xlarge" + } + }, + "ML_M6GD_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.4xlarge" + } + }, + "ML_M6GD_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.8xlarge" + } + }, + "ML_M6GD_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.12xlarge" + } + }, + "ML_M6GD_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6gd.16xlarge" + } + }, + "ML_C6G_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.large" + } + }, + "ML_C6G_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.xlarge" + } + }, + "ML_C6G_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.2xlarge" + } + }, + "ML_C6G_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.4xlarge" + } + }, + "ML_C6G_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.8xlarge" + } + }, + "ML_C6G_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.12xlarge" + } + }, + "ML_C6G_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6g.16xlarge" + } + }, + "ML_C6GD_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.large" + } + }, + "ML_C6GD_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.xlarge" + } + }, + "ML_C6GD_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.2xlarge" + } + }, + "ML_C6GD_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.4xlarge" + } + }, + "ML_C6GD_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.8xlarge" + } + }, + "ML_C6GD_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.12xlarge" + } + }, + "ML_C6GD_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gd.16xlarge" + } + }, + "ML_C6GN_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.large" + } + }, + "ML_C6GN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.xlarge" + } + }, + "ML_C6GN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.2xlarge" + } + }, + "ML_C6GN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.4xlarge" + } + }, + "ML_C6GN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.8xlarge" + } + }, + "ML_C6GN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.12xlarge" + } + }, + "ML_C6GN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6gn.16xlarge" + } + }, + "ML_R6G_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.large" + } + }, + "ML_R6G_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.xlarge" + } + }, + "ML_R6G_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.2xlarge" + } + }, + "ML_R6G_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.4xlarge" + } + }, + "ML_R6G_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.8xlarge" + } + }, + "ML_R6G_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.12xlarge" + } + }, + "ML_R6G_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6g.16xlarge" + } + }, + "ML_R6GD_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.large" + } + }, + "ML_R6GD_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.xlarge" + } + }, + "ML_R6GD_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.2xlarge" + } + }, + "ML_R6GD_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.4xlarge" + } + }, + "ML_R6GD_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.8xlarge" + } + }, + "ML_R6GD_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.12xlarge" + } + }, + "ML_R6GD_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6gd.16xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_TRN2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn2.48xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_P5E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5e.48xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProductionVariant" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingStatus", + "traits": { + "smithy.api#documentation": "Indicates whether managed instance scaling is enabled.
" + } + }, + "MinInstanceCount": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount", + "traits": { + "smithy.api#documentation": "The minimum number of instances that the endpoint must retain when it scales down to\n accommodate a decrease in traffic.
" + } + }, + "MaxInstanceCount": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount", + "traits": { + "smithy.api#documentation": "The maximum number of instances that the endpoint can provision when it scales up to\n accommodate an increase in traffic.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" + } + }, + "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantRoutingConfig": { + "type": "structure", + "members": { + "RoutingStrategy": { + "target": "com.amazonaws.sagemaker#RoutingStrategy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Sets how the endpoint routes incoming traffic:
\n\n LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the\n specific instances that have more capacity to process them.
\n RANDOM: The endpoint routes each request to a randomly chosen\n instance.
Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" + } + }, + "com.amazonaws.sagemaker#ProductionVariantSSMAccess": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#ProductionVariantServerlessConfig": { + "type": "structure", + "members": { + "MemorySizeInMB": { + "target": "com.amazonaws.sagemaker#ServerlessMemorySizeInMB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.
", + "smithy.api#required": {} + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.sagemaker#ServerlessMaxConcurrency", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The maximum number of concurrent invocations your serverless endpoint can process.
", + "smithy.api#required": {} + } + }, + "ProvisionedConcurrency": { + "target": "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency to allocate for the serverless endpoint.\n Should be less than or equal to MaxConcurrency.
This field is not supported for serverless endpoint recommendations for Inference Recommender jobs.\n For more information about creating an Inference Recommender job, see\n CreateInferenceRecommendationsJobs.
\nSpecifies the serverless configuration for an endpoint variant.
" + } + }, + "com.amazonaws.sagemaker#ProductionVariantServerlessUpdateConfig": { + "type": "structure", + "members": { + "MaxConcurrency": { + "target": "com.amazonaws.sagemaker#ServerlessMaxConcurrency", + "traits": { + "smithy.api#documentation": "The updated maximum number of concurrent invocations your serverless endpoint can process.
" + } + }, + "ProvisionedConcurrency": { + "target": "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency", + "traits": { + "smithy.api#documentation": "The updated amount of provisioned concurrency to allocate for the serverless endpoint.\n Should be less than or equal to MaxConcurrency.
Specifies the serverless update concurrency configuration for an endpoint variant.
" + } + }, + "com.amazonaws.sagemaker#ProductionVariantStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#VariantStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The endpoint variant status which describes the current deployment stage status or\n operational status.
\n\n Creating: Creating inference resources for the production\n variant.
\n Deleting: Terminating inference resources for the production\n variant.
\n Updating: Updating capacity for the production variant.
\n ActivatingTraffic: Turning on traffic for the production\n variant.
\n Baking: Waiting period to monitor the CloudWatch alarms in the\n automatic rollback configuration.
A message that describes the status of the production variant.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the current status change.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the status of the production variant.
" + } + }, + "com.amazonaws.sagemaker#ProductionVariantStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProductionVariantStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#ProductionVariantSummary": { + "type": "structure", + "members": { + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the variant.
", + "smithy.api#required": {} + } + }, + "DeployedImages": { + "target": "com.amazonaws.sagemaker#DeployedImages", + "traits": { + "smithy.api#documentation": "An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the\n inference images deployed on instances of this ProductionVariant.
The weight associated with the variant.
" + } + }, + "DesiredWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "The requested weight, as specified in the\n UpdateEndpointWeightsAndCapacities request.
The number of instances associated with the variant.
" + } + }, + "DesiredInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "The number of instances requested in the\n UpdateEndpointWeightsAndCapacities request.
The endpoint variant status which describes the current deployment stage status or\n operational status.
" + } + }, + "CurrentServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "The serverless configuration for the endpoint.
" + } + }, + "DesiredServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "The serverless configuration requested for the endpoint update.
" + } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes weight and capacities for a production variant associated with an\n endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities\n API and the endpoint status is Updating, you get different desired and\n current values.
Path to Amazon S3 storage location for system and framework metrics.
" + } + }, + "ProfilingIntervalInMilliseconds": { + "target": "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds", + "traits": { + "smithy.api#documentation": "A time interval for capturing system metrics in milliseconds. Available values are\n 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" + } + }, + "ProfilingParameters": { + "target": "com.amazonaws.sagemaker#ProfilingParameters", + "traits": { + "smithy.api#documentation": "Configuration information for capturing framework metrics. Available key strings for different profiling options are\n DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.\n The following codes are configuration structures for the ProfilingParameters parameter. To learn more about\n how to configure the ProfilingParameters parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n
Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and\n storage paths.
" + } + }, + "com.amazonaws.sagemaker#ProfilerConfigForUpdate": { + "type": "structure", + "members": { + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "Path to Amazon S3 storage location for system and framework metrics.
" + } + }, + "ProfilingIntervalInMilliseconds": { + "target": "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds", + "traits": { + "smithy.api#documentation": "A time interval for capturing system metrics in milliseconds. Available values are\n 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" + } + }, + "ProfilingParameters": { + "target": "com.amazonaws.sagemaker#ProfilingParameters", + "traits": { + "smithy.api#documentation": "Configuration information for capturing framework metrics. Available key strings for different profiling options are\n DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.\n The following codes are configuration structures for the ProfilingParameters parameter. To learn more about\n how to configure the ProfilingParameters parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n
To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.
Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and\n storage paths.
" + } + }, + "com.amazonaws.sagemaker#ProfilerRuleConfiguration": { + "type": "structure", + "members": { + "RuleConfigurationName": { + "target": "com.amazonaws.sagemaker#RuleConfigurationName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the rule configuration. It must be unique relative to other rule configuration names.
", + "smithy.api#required": {} + } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Path to Amazon S3 storage location for rules.
" + } + }, + "RuleEvaluatorImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Elastic Container Registry Image for the managed rule evaluation.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "traits": { + "smithy.api#documentation": "The instance type to deploy a custom rule for profiling a training job.
" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", + "traits": { + "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to the processing instance.
" + } + }, + "RuleParameters": { + "target": "com.amazonaws.sagemaker#RuleParameters", + "traits": { + "smithy.api#documentation": "Runtime configuration for rule container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information for profiling rules.
" + } + }, + "com.amazonaws.sagemaker#ProfilerRuleConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProfilerRuleConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatus": { + "type": "structure", + "members": { + "RuleConfigurationName": { + "target": "com.amazonaws.sagemaker#RuleConfigurationName", + "traits": { + "smithy.api#documentation": "The name of the rule configuration.
" + } + }, + "RuleEvaluationJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule evaluation job.
" + } + }, + "RuleEvaluationStatus": { + "target": "com.amazonaws.sagemaker#RuleEvaluationStatus", + "traits": { + "smithy.api#documentation": "Status of the rule evaluation.
" + } + }, + "StatusDetails": { + "target": "com.amazonaws.sagemaker#StatusDetails", + "traits": { + "smithy.api#documentation": "Details from the rule evaluation.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp when the rule evaluation status was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the status of the rule evaluation.
" + } + }, + "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProfilerRuleEvaluationStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds": { + "type": "long" + }, + "com.amazonaws.sagemaker#ProfilingParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ConfigKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#ProfilingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#ProgrammingLang": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" + } + }, + "com.amazonaws.sagemaker#Project": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
" + } + }, + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#documentation": "The name of the project.
" + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#ProjectId", + "traits": { + "smithy.api#documentation": "The ID of the project.
" + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "The description of the project.
" + } + }, + "ServiceCatalogProvisioningDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails" + }, + "ServiceCatalogProvisionedProductDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisionedProductDetails" + }, + "ProjectStatus": { + "target": "com.amazonaws.sagemaker#ProjectStatus", + "traits": { + "smithy.api#documentation": "The status of the project.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who created the project.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp specifying when the project was created.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp container for when the project was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#documentation": "The properties of a project as returned by the Search API.
" + } + }, + "com.amazonaws.sagemaker#ProjectArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}$" + } + }, + "com.amazonaws.sagemaker#ProjectEntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}$" + } + }, + "com.amazonaws.sagemaker#ProjectId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ProjectSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.sagemaker#ProjectSortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.sagemaker#ProjectStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInProgress" + } + }, + "CREATE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateCompleted" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInProgress" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "DELETE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteCompleted" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateInProgress" + } + }, + "UPDATE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateCompleted" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + } + } + }, + "com.amazonaws.sagemaker#ProjectSummary": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.sagemaker#ProjectEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the project.
", + "smithy.api#required": {} + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "The description of the project.
" + } + }, + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
", + "smithy.api#required": {} + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#ProjectId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the project.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time that the project was created.
", + "smithy.api#required": {} + } + }, + "ProjectStatus": { + "target": "com.amazonaws.sagemaker#ProjectStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the project.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a project.
" + } + }, + "com.amazonaws.sagemaker#ProjectSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProjectSummary" + } + }, + "com.amazonaws.sagemaker#PropertyNameHint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#PropertyNameQuery": { + "type": "structure", + "members": { + "PropertyNameHint": { + "target": "com.amazonaws.sagemaker#PropertyNameHint", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Text that begins a property's name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Part of the SuggestionQuery type. Specifies a hint for retrieving property\n names that begin with the specified text.
A suggested property name based on what you entered in the search textbox in the SageMaker\n console.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A property name returned from a GetSearchSuggestions call that specifies\n a value in the PropertyNameQuery field.
The key that identifies a provisioning parameter.
" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#ProvisioningParameterValue", + "traits": { + "smithy.api#documentation": "The value of the provisioning parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A key value pair used when you provision a project as a service catalog product. For\n information, see What is Amazon Web Services Service\n Catalog.
" + } + }, + "com.amazonaws.sagemaker#ProvisioningParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ProvisioningParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ProvisioningParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProvisioningParameter" + } + }, + "com.amazonaws.sagemaker#PublicWorkforceTaskPrice": { + "type": "structure", + "members": { + "AmountInUsd": { + "target": "com.amazonaws.sagemaker#USD", + "traits": { + "smithy.api#documentation": "Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.
\nUse one of the following prices for bounding box tasks. Prices are in US dollars and\n should be based on the complexity of the task; the longer it takes in your initial\n testing, the more you should offer.
\n0.036
\n0.048
\n0.060
\n0.072
\n0.120
\n0.240
\n0.360
\n0.480
\n0.600
\n0.720
\n0.840
\n0.960
\n1.080
\n1.200
\nUse one of the following prices for image classification, text classification, and\n custom tasks. Prices are in US dollars.
\n0.012
\n0.024
\n0.036
\n0.048
\n0.060
\n0.072
\n0.120
\n0.240
\n0.360
\n0.480
\n0.600
\n0.720
\n0.840
\n0.960
\n1.080
\n1.200
\nUse one of the following prices for semantic segmentation tasks. Prices are in US\n dollars.
\n0.840
\n0.960
\n1.080
\n1.200
\nUse one of the following prices for Textract AnalyzeDocument Important Form Key Amazon\n Augmented AI review tasks. Prices are in US dollars.
\n2.400
\n2.280
\n2.160
\n2.040
\n1.920
\n1.800
\n1.680
\n1.560
\n1.440
\n1.320
\n1.200
\n1.080
\n0.960
\n0.840
\n0.720
\n0.600
\n0.480
\n0.360
\n0.240
\n0.120
\n0.072
\n0.060
\n0.048
\n0.036
\n0.024
\n0.012
\nUse one of the following prices for Rekognition DetectModerationLabels Amazon\n Augmented AI review tasks. Prices are in US dollars.
\n1.200
\n1.080
\n0.960
\n0.840
\n0.720
\n0.600
\n0.480
\n0.360
\n0.240
\n0.120
\n0.072
\n0.060
\n0.048
\n0.036
\n0.024
\n0.012
\nUse one of the following prices for Amazon Augmented AI custom human review tasks.\n Prices are in US dollars.
\n1.200
\n1.080
\n0.960
\n0.840
\n0.720
\n0.600
\n0.480
\n0.360
\n0.240
\n0.120
\n0.072
\n0.060
\n0.048
\n0.036
\n0.024
\n0.012
\nAdds a resouce policy to control access to a model group. For information about\n resoure policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
" + } + }, + "com.amazonaws.sagemaker#PutModelPackageGroupPolicyInput": { + "type": "structure", + "members": { + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the model group to add a resource policy to.
", + "smithy.api#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.sagemaker#PolicyString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The resource policy for the model group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#PutModelPackageGroupPolicyOutput": { + "type": "structure", + "members": { + "ModelPackageGroupArn": { + "target": "com.amazonaws.sagemaker#ModelPackageGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#QProfileArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[-.a-z0-9]{1,63}:codewhisperer:([-.a-z0-9]{0,63}:){2}([a-zA-Z0-9-_:/]){1,1023}$" + } + }, + "com.amazonaws.sagemaker#QualityCheckStepMetadata": { + "type": "structure", + "members": { + "CheckType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the Quality check step.
" + } + }, + "BaselineUsedForDriftCheckStatistics": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the baseline statistics file used for the drift check.
" + } + }, + "BaselineUsedForDriftCheckConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the baseline constraints file used for the drift check.
" + } + }, + "CalculatedBaselineStatistics": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the newly calculated baseline statistics file.
" + } + }, + "CalculatedBaselineConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the newly calculated baseline constraints file.
" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The model package group name.
" + } + }, + "ViolationReport": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of violation report if violations are detected.
" + } + }, + "CheckJobArn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
" + } + }, + "SkipCheck": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints and \n BaselineUsedForDriftCheckStatistics properties.
Container for the metadata for a Quality check step. For more information, see \n the topic on QualityCheck step in the Amazon SageMaker Developer Guide.\n
" + } + }, + "com.amazonaws.sagemaker#QueryFilters": { + "type": "structure", + "members": { + "Types": { + "target": "com.amazonaws.sagemaker#QueryTypes", + "traits": { + "smithy.api#documentation": "Filter the lineage entities connected to the StartArn by type. For example: DataSet, \n Model, Endpoint, or ModelDeployment.
Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.
Filter the lineage entities connected to the StartArn(s) by created date.
Filter the lineage entities connected to the StartArn(s) after the create date.
Filter the lineage entities connected to the StartArn(s) before the last modified date.
Filter the lineage entities connected to the StartArn(s) after the last modified date.
Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. \n If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.
A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the \n QueryLineage API action.
Use this action to inspect your lineage and discover relationships between entities. \n For more information, see \n Querying Lineage Entities in the Amazon SageMaker Developer Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#QueryLineageMaxDepth": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#QueryLineageMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#QueryLineageRequest": { + "type": "structure", + "members": { + "StartArns": { + "target": "com.amazonaws.sagemaker#QueryLineageStartArns", + "traits": { + "smithy.api#documentation": "A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
" + } + }, + "Direction": { + "target": "com.amazonaws.sagemaker#Direction", + "traits": { + "smithy.api#documentation": "Associations between lineage entities have a direction. This parameter determines the direction from the \n StartArn(s) that the query traverses.
" + } + }, + "IncludeEdges": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": " Setting this value to True retrieves not only the entities of interest but also the \n Associations and \n lineage entities on the path. Set to False to only return lineage entities that match your query.
A set of filtering parameters that allow you to specify which entities should be returned.
\nProperties - Key-value pairs to match on the lineage entities' properties.
\nLineageTypes - A set of lineage entity types to match on. For example: TrialComponent, \n Artifact, or Context.
CreatedBefore - Filter entities created before this date.
\nModifiedBefore - Filter entities modified before this date.
\nModifiedAfter - Filter entities modified after this date.
\nThe maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number \n of Associations from the StartArn entity to the matched results.
Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.
Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.
A list of vertices connected to the start entity(ies) in the lineage graph.
" + } + }, + "Edges": { + "target": "com.amazonaws.sagemaker#Edges", + "traits": { + "smithy.api#documentation": "A list of edges that connect vertices in the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#String8192", + "traits": { + "smithy.api#documentation": "Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.
A list of custom SageMaker AI images that are configured to run as a RSession\n app.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of settings that apply to an RSessionGateway app.
Indicates whether the current user has access to the RStudioServerPro\n app.
The level of permissions that the user has within the RStudioServerPro app.\n This value defaults to `User`. The `Admin` value allows the user access to the RStudio\n Administrative Dashboard.
A collection of settings that configure user interaction with the\n RStudioServerPro app.
The ARN of the execution role for the RStudioServerPro Domain-level\n app.
A URL pointing to an RStudio Connect server.
" + } + }, + "RStudioPackageManagerUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "A URL pointing to an RStudio Package Manager server.
" + } + }, + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + } + }, + "traits": { + "smithy.api#documentation": "A collection of settings that configure the RStudioServerPro Domain-level\n app.
The execution role for the RStudioServerPro Domain-level app.
A URL pointing to an RStudio Connect server.
" + } + }, + "RStudioPackageManagerUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "A URL pointing to an RStudio Package Manager server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of settings that update the current configuration for the\n RStudioServerPro Domain-level app.
The instance type the model is deployed to.
", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of instances of the type specified by InstanceType.
The infrastructure configuration for deploying the model to a real-time inference endpoint.
" + } + }, + "com.amazonaws.sagemaker#RealTimeInferenceRecommendation": { + "type": "structure", + "members": { + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The recommendation ID which uniquely identifies each recommendation.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The recommended instance type for Real-Time Inference.
", + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "The recommended environment variables to set in the model container for Real-Time Inference.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The recommended configuration to use for Real-Time Inference.
" + } + }, + "com.amazonaws.sagemaker#RealTimeInferenceRecommendations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RealTimeInferenceRecommendation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType" + } + }, + "com.amazonaws.sagemaker#RecommendationFailureReason": { + "type": "string" + }, + "com.amazonaws.sagemaker#RecommendationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/" + } + }, + "com.amazonaws.sagemaker#RecommendationJobCompilationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobCompiledOutputConfig": { + "type": "structure", + "members": { + "S3OutputUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "Identifies the Amazon S3 bucket where you want SageMaker to store the \n compiled model artifacts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the output configuration for the compiled \n model.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobContainerConfig": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning domain of the model and its components.
\nValid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING |\n MACHINE_LEARNING\n
The machine learning task that the model accomplishes.
\nValid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION\n | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION |\n REGRESSION | OTHER\n
The machine learning framework of the container image.
\nValid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN\n
The framework version of the container image.
" + } + }, + "PayloadConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobPayloadConfig", + "traits": { + "smithy.api#documentation": "Specifies the SamplePayloadUrl and all other sample payload-related fields.
The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.
\nValid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn |\n densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet\n
A list of the instance types that are used to generate inferences in real-time.
" + } + }, + "SupportedEndpointType": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedEndpointType", + "traits": { + "smithy.api#documentation": "The endpoint type to receive recommendations for. By default this is null, and the results of \n the inference recommendation job return a combined list of both real-time and serverless benchmarks.\n By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
" + } + }, + "DataInputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobDataInputConfig", + "traits": { + "smithy.api#documentation": "Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form.\n This field is used for optimizing your model using SageMaker Neo. For more information, see\n DataInputConfig.
" + } + }, + "SupportedResponseMIMETypes": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMETypes", + "traits": { + "smithy.api#documentation": "The supported MIME types for the output data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies mandatory fields for running an Inference Recommender job directly in the\n CreateInferenceRecommendationsJob\n API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use\n ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.
The reason why a benchmark failed.
" + } + }, + "InvocationEndTime": { + "target": "com.amazonaws.sagemaker#InvocationEndTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the benchmark completed.
" + } + }, + "InvocationStartTime": { + "target": "com.amazonaws.sagemaker#InvocationStartTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the benchmark started.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for a specific benchmark from an Inference Recommender job.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobInputConfig": { + "type": "structure", + "members": { + "ModelPackageVersionArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a versioned model package.
" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "The name of the created model.
" + } + }, + "JobDurationInSeconds": { + "target": "com.amazonaws.sagemaker#JobDurationInSeconds", + "traits": { + "smithy.api#documentation": "Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.
" + } + }, + "TrafficPattern": { + "target": "com.amazonaws.sagemaker#TrafficPattern", + "traits": { + "smithy.api#documentation": "Specifies the traffic pattern of the job.
" + } + }, + "ResourceLimit": { + "target": "com.amazonaws.sagemaker#RecommendationJobResourceLimit", + "traits": { + "smithy.api#documentation": "Defines the resource limit of the job.
" + } + }, + "EndpointConfigurations": { + "target": "com.amazonaws.sagemaker#EndpointInputConfigurations", + "traits": { + "smithy.api#documentation": "Specifies the endpoint configuration to use for a job.
" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. \n This key will be passed to SageMaker Hosting for endpoint creation.
\nThe SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage \n volume of the endpoints created for inference recommendation. The inference recommendation job will fail \n asynchronously during endpoint configuration creation if the role passed does not have \n kms:CreateGrant permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:\n
For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
" + } + }, + "ContainerConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobContainerConfig", + "traits": { + "smithy.api#documentation": "Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig\n override the corresponding fields in the model package.
Existing customer endpoints on which to run an Inference Recommender job.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcConfig", + "traits": { + "smithy.api#documentation": "Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input configuration of the recommendation job.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobOutputConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. \n The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:\n
For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
" + } + }, + "CompiledOutputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobCompiledOutputConfig", + "traits": { + "smithy.api#documentation": "Provides information about the output configuration for the compiled \n model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the output configuration for the compiled model.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobPayloadConfig": { + "type": "structure", + "members": { + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
" + } + }, + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedContentTypes", + "traits": { + "smithy.api#documentation": "The supported MIME types for the input data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the payload for a recommendation job.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobResourceLimit": { + "type": "structure", + "members": { + "MaxNumberOfTests": { + "target": "com.amazonaws.sagemaker#MaxNumberOfTests", + "traits": { + "smithy.api#documentation": "Defines the maximum number of load tests.
" + } + }, + "MaxParallelOfTests": { + "target": "com.amazonaws.sagemaker#MaxParallelOfTests", + "traits": { + "smithy.api#documentation": "Defines the maximum number of parallel load tests.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the maximum number of jobs that can run in parallel \n and the maximum number of jobs that can run.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobStoppingConditions": { + "type": "structure", + "members": { + "MaxInvocations": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of requests per minute expected for the endpoint.
" + } + }, + "ModelLatencyThresholds": { + "target": "com.amazonaws.sagemaker#ModelLatencyThresholds", + "traits": { + "smithy.api#documentation": "The interval of time taken by a model to respond as viewed from SageMaker. \n The interval includes the local communication time taken to send the request \n and to fetch the response from the container of a model and the time taken to \n complete the inference in the container.
" + } + }, + "FlatInvocations": { + "target": "com.amazonaws.sagemaker#FlatInvocations", + "traits": { + "smithy.api#documentation": "Stops a load test when the number of invocations (TPS) peaks and flattens,\n which means that the instance has reached capacity. The default value is Stop.\n If you want the load test to continue after invocations have flattened, set the value to Continue.
Specifies conditions for stopping a job. When a job reaches a \n stopping condition limit, SageMaker ends the job.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedContentType" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedEndpointType": { + "type": "enum", + "members": { + "REALTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RealTime" + } + }, + "SERVERLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Serverless" + } + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#String" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMEType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[-\\w]+\\/.+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMETypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMEType" + } + }, + "com.amazonaws.sagemaker#RecommendationJobType": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Default" + } + }, + "ADVANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Advanced" + } + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The VPC security group IDs. IDs have the form of sg-xxxxxxxx.\n Specify the security groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#RecommendationMetrics": { + "type": "structure", + "members": { + "CostPerHour": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "Defines the cost per hour for the instance.
" + } + }, + "CostPerInference": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "Defines the cost per inference for the instance .
" + } + }, + "MaxInvocations": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The expected maximum number of requests per minute for the instance.
" + } + }, + "ModelLatency": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The expected model latency at maximum invocation per minute for the instance.
" + } + }, + "CpuUtilization": { + "target": "com.amazonaws.sagemaker#UtilizationMetric", + "traits": { + "smithy.api#documentation": "The expected CPU utilization at maximum invocations per minute for the instance.
\n\n NaN indicates that the value is not available.
The expected memory utilization at maximum invocations per minute for the instance.
\n\n NaN indicates that the value is not available.
The time it takes to launch new compute resources for a serverless endpoint.\n The time can vary depending on the model size, how long it takes to download the\n model, and the start-up time of the container.
\n\n NaN indicates that the value is not available.
The metrics of recommendations.
" + } + }, + "com.amazonaws.sagemaker#RecommendationStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } + } + } + }, + "com.amazonaws.sagemaker#RecommendationStepType": { + "type": "enum", + "members": { + "BENCHMARK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BENCHMARK" + } + } + } + }, + "com.amazonaws.sagemaker#RecordWrapper": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "RECORDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecordIO" + } + } + } + }, + "com.amazonaws.sagemaker#RedshiftClusterId": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Redshift cluster Identifier.
", + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RedshiftDatabase": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of the Redshift database used in Redshift query execution.
", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RedshiftDatasetDefinition": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.sagemaker#RedshiftClusterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.sagemaker#RedshiftDatabase", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "DbUser": { + "target": "com.amazonaws.sagemaker#RedshiftUserName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.sagemaker#RedshiftQueryString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "ClusterRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
", + "smithy.api#required": {} + } + }, + "OutputS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location in Amazon S3 where the Redshift query results are stored.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a\n Redshift execution.
" + } + }, + "OutputFormat": { + "target": "com.amazonaws.sagemaker#RedshiftResultFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "OutputCompression": { + "target": "com.amazonaws.sagemaker#RedshiftResultCompressionType" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for Redshift Dataset Definition input.
" + } + }, + "com.amazonaws.sagemaker#RedshiftQueryString": { + "type": "string", + "traits": { + "smithy.api#documentation": "The SQL query statements to be executed.
", + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.sagemaker#RedshiftResultCompressionType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "BZIP2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZIP2" + } + }, + "ZSTD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZSTD" + } + }, + "SNAPPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPPY" + } + } + }, + "traits": { + "smithy.api#documentation": "The compression used for Redshift query results.
" + } + }, + "com.amazonaws.sagemaker#RedshiftResultFormat": { + "type": "enum", + "members": { + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + }, + "traits": { + "smithy.api#documentation": "The data storage format for Redshift query results.
" + } + }, + "com.amazonaws.sagemaker#RedshiftUserName": { + "type": "string", + "traits": { + "smithy.api#documentation": "The database user name used in Redshift query execution.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#ReferenceMinVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 14 + }, + "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" + } + }, + "com.amazonaws.sagemaker#RegisterDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#RegisterDevicesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Register devices.
" + } + }, + "com.amazonaws.sagemaker#RegisterDevicesRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "Devices": { + "target": "com.amazonaws.sagemaker#Devices", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of devices to register with SageMaker Edge Manager.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with devices.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#RegisterModelStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for a register model job step.
" + } + }, + "com.amazonaws.sagemaker#ReleaseNotes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RemoteDebugConfig": { + "type": "structure", + "members": { + "EnableRemoteDebug": { + "target": "com.amazonaws.sagemaker#EnableRemoteDebug", + "traits": { + "smithy.api#documentation": "If set to True, enables remote debugging.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" + } + }, + "com.amazonaws.sagemaker#RemoteDebugConfigForUpdate": { + "type": "structure", + "members": { + "EnableRemoteDebug": { + "target": "com.amazonaws.sagemaker#EnableRemoteDebug", + "traits": { + "smithy.api#documentation": "If set to True, enables remote debugging.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" + } + }, + "com.amazonaws.sagemaker#RenderUiTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#RenderUiTemplateRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#RenderUiTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Renders the UI template so that you can preview the worker's experience.
" + } + }, + "com.amazonaws.sagemaker#RenderUiTemplateRequest": { + "type": "structure", + "members": { + "UiTemplate": { + "target": "com.amazonaws.sagemaker#UiTemplate", + "traits": { + "smithy.api#documentation": "A Template object containing the worker UI template to render.
A RenderableTask object containing a representative task to\n render.
The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the\n template.
", + "smithy.api#required": {} + } + }, + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#documentation": "The HumanTaskUiArn of the worker UI that you want to render. Do not\n provide a HumanTaskUiArn if you use the UiTemplate\n parameter.
See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#RenderUiTemplateResponse": { + "type": "structure", + "members": { + "RenderedContent": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Liquid template that renders the HTML for the worker UI.
", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.sagemaker#RenderingErrorList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of one or more RenderingError objects if any were encountered\n while rendering the template. If there were no errors, the list is empty.
A JSON object that contains values for the variables defined in the template. It is\n made available to the template under the substitution variable task.input.\n For example, if you define a variable task.input.text in your template, you\n can supply the variable in the JSON object as \"text\": \"sample text\".
Contains input values for a task.
" + } + }, + "com.amazonaws.sagemaker#RenderingError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique identifier for a specific class of errors.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A human-readable message describing the error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A description of an error that occurred while rendering the template.
" + } + }, + "com.amazonaws.sagemaker#RenderingErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RenderingError" + } + }, + "com.amazonaws.sagemaker#RepositoryAccessMode": { + "type": "enum", + "members": { + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Platform" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Vpc" + } + } + } + }, + "com.amazonaws.sagemaker#RepositoryAuthConfig": { + "type": "structure", + "members": { + "RepositoryCredentialsProviderArn": { + "target": "com.amazonaws.sagemaker#RepositoryCredentialsProviderArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides\n credentials to authenticate to the private Docker registry where your model image is\n hosted. For information about how to create an Amazon Web Services Lambda function, see\n Create a Lambda function\n with the console in the Amazon Web Services Lambda Developer\n Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an authentication configuration for the private docker registry where your\n model image is hosted. Specify a value for this property only if you specified\n Vpc as the value for the RepositoryAccessMode field of the\n ImageConfig object that you passed to a call to\n CreateModel and the private Docker registry where the model image is\n hosted requires authentication.
The instance type for the reserved capacity offering.
", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of instances in the reserved capacity offering.
", + "smithy.api#required": {} + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#AvailabilityZone", + "traits": { + "smithy.api#documentation": "The availability zone for the reserved capacity offering.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this reserved capacity\n offering.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this reserved\n capacity offering.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the reserved capacity offering.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the reserved capacity offering.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a reserved capacity offering for a training plan offering.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the reserved capacity.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance type for the reserved capacity.
", + "smithy.api#required": {} + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The total number of instances in the reserved capacity.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ReservedCapacityStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the reserved capacity.
", + "smithy.api#required": {} + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#AvailabilityZone", + "traits": { + "smithy.api#documentation": "The availability zone for the reserved capacity.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this reserved capacity.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this reserved\n capacity.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the reserved capacity.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the reserved capacity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a reserved capacity for the training plan.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The problem type.
" + } + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + } + }, + "traits": { + "smithy.api#documentation": "The resolved attributes.
" + } + }, + "com.amazonaws.sagemaker#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+$" + } + }, + "com.amazonaws.sagemaker#ResourceCatalog": { + "type": "structure", + "members": { + "ResourceCatalogArn": { + "target": "com.amazonaws.sagemaker#ResourceCatalogArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": " The Amazon Resource Name (ARN) of the ResourceCatalog.
The name of the ResourceCatalog.
A free form description of the ResourceCatalog.
The time the ResourceCatalog was created.
A resource catalog containing all of the resources of a specific resource type within\n a resource owner account. For an example on sharing the Amazon SageMaker Feature Store\n DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.\n
The ML compute instance type.
\nSageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting\n December 9th, 2022.
\n\n Amazon EC2 P4de instances\n (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance\n HBM2e GPU memory, which accelerate the speed of training ML models that need to be\n trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker\n supports ML training jobs on P4de instances (ml.p4de.24xlarge) to\n reduce model training time. The ml.p4de.24xlarge instances are\n available in the following Amazon Web Services Regions.
US East (N. Virginia) (us-east-1)
\nUS West (Oregon) (us-west-2)
\nTo request quota limit increase and start using P4de instances, contact the SageMaker\n Training service team through your account team.
\nThe number of ML compute instances to use. For distributed training, provide a\n value greater than 1.
" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#VolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The size of the ML storage volume that you want to provision.
\nML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.
When using an ML instance with NVMe SSD\n volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage.\n Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures\n storage paths for training datasets, checkpoints, model artifacts, and outputs to use\n the entire capacity of the instance storage. For example, ML instance families with the\n NVMe-type instance storage include ml.p4d, ml.g4dn, and\n ml.g5.
When using an ML instance with the EBS-only storage option and without instance\n storage, you must define the size of EBS volume through VolumeSizeInGB in\n the ResourceConfig API. For example, ML instance families that use EBS\n volumes include ml.c5 and ml.p2.
To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
\nTo find the default local paths defined by the SageMaker training platform, see Amazon SageMaker\n Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and\n Outputs.
", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training job.
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nThe VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The duration of time in seconds to retain configured resources in a warm pool for\n subsequent training jobs.
" + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#InstanceGroups", + "traits": { + "smithy.api#documentation": "The configuration of a heterogeneous cluster in JSON format.
" + } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to use for this resource configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the resources, including machine learning (ML) compute instances and ML\n storage volumes, to use for model training.
" + } + }, + "com.amazonaws.sagemaker#ResourceConfigForUpdate": { + "type": "structure", + "members": { + "KeepAlivePeriodInSeconds": { + "target": "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The KeepAlivePeriodInSeconds value specified in the\n ResourceConfig to update.
The ResourceConfig to update KeepAlivePeriodInSeconds. Other\n fields in the ResourceConfig cannot be updated.
Resource being accessed is in use.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sagemaker#ResourceLimitExceeded": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sagemaker#FailureReason" + } + }, + "traits": { + "smithy.api#documentation": "You have exceeded an SageMaker resource limit. For example, you might have too many\n training jobs created.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sagemaker#ResourceLimits": { + "type": "structure", + "members": { + "MaxNumberOfTrainingJobs": { + "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs", + "traits": { + "smithy.api#documentation": "The maximum number of training jobs that a hyperparameter tuning job can\n launch.
" + } + }, + "MaxParallelTrainingJobs": { + "target": "com.amazonaws.sagemaker#MaxParallelTrainingJobs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The maximum number of concurrent training jobs that a hyperparameter tuning job can\n launch.
", + "smithy.api#required": {} + } + }, + "MaxRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningMaxRuntimeInSeconds", + "traits": { + "smithy.api#documentation": "The maximum time in seconds that a hyperparameter tuning job can run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the maximum number of training jobs and parallel training jobs that a\n hyperparameter tuning job can launch.
" + } + }, + "com.amazonaws.sagemaker#ResourceNotFound": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sagemaker#FailureReason" + } + }, + "traits": { + "smithy.api#documentation": "Resource being access is not found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sagemaker#ResourcePolicyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20480 + }, + "smithy.api#pattern": "(?:[ \\r\\n\\t].*)*$" + } + }, + "com.amazonaws.sagemaker#ResourcePropertyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#ResourceRetainedBillableTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after\n resource reaches ResourceReused or ResourceReleased state.", + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ResourceSharingConfig": { + "type": "structure", + "members": { + "Strategy": { + "target": "com.amazonaws.sagemaker#ResourceSharingStrategy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The strategy of how idle compute is shared within the cluster. The following are the\n options of strategies.
\n\n DontLend: entities do not lend idle compute.
\n Lend: entities can lend idle compute to entities that can\n borrow.
\n LendandBorrow: entities can lend idle compute and borrow idle compute\n from other entities.
Default is LendandBorrow.
The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of\n idle compute that the team is allowed to borrow.
\nDefault is 50.
Resource sharing configuration.
" + } + }, + "com.amazonaws.sagemaker#ResourceSharingStrategy": { + "type": "enum", + "members": { + "LEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lend" + } + }, + "DONTLEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DontLend" + } + }, + "LENDANDBORROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LendAndBorrow" + } + } + } + }, + "com.amazonaws.sagemaker#ResourceSpec": { + "type": "structure", + "members": { + "SageMakerImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker AI image that the image version belongs to.
" + } + }, + "SageMakerImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the image version created on the instance.
" + } + }, + "SageMakerImageVersionAlias": { + "target": "com.amazonaws.sagemaker#ImageVersionAlias", + "traits": { + "smithy.api#documentation": "The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#AppInstanceType", + "traits": { + "smithy.api#documentation": "The instance type that the image version runs on.
\n\n JupyterServer apps only support the system value.
For KernelGateway apps, the system\n value is translated to ml.t3.medium. KernelGateway apps also support all other values for available\n instance types.
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the\n Resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that\n the version runs on.
" + } + }, + "com.amazonaws.sagemaker#ResourceType": { + "type": "enum", + "members": { + "TRAINING_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrainingJob" + } + }, + "EXPERIMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Experiment" + } + }, + "EXPERIMENT_TRIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExperimentTrial" + } + }, + "EXPERIMENT_TRIAL_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExperimentTrialComponent" + } + }, + "ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Endpoint" + } + }, + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Model" + } + }, + "MODEL_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelPackage" + } + }, + "MODEL_PACKAGE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelPackageGroup" + } + }, + "PIPELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipeline" + } + }, + "PIPELINE_EXECUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PipelineExecution" + } + }, + "FEATURE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureGroup" + } + }, + "FEATURE_METADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FeatureMetadata" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Image" + } + }, + "IMAGE_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageVersion" + } + }, + "PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Project" + } + }, + "HYPER_PARAMETER_TUNING_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HyperParameterTuningJob" + } + }, + "MODEL_CARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelCard" + } + } + } + }, + "com.amazonaws.sagemaker#ResponseMIMEType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[-\\w]+\\/.+$" + } + }, + "com.amazonaws.sagemaker#ResponseMIMETypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ResponseMIMEType" + } + }, + "com.amazonaws.sagemaker#RetentionPolicy": { + "type": "structure", + "members": { + "HomeEfsFileSystem": { + "target": "com.amazonaws.sagemaker#RetentionType", + "traits": { + "smithy.api#documentation": "The default is Retain, which specifies to keep the data stored on the\n Amazon EFS volume.
Specify Delete to delete the data stored on the Amazon EFS\n volume.
The retention policy for data stored on an Amazon Elastic File System volume.
" + } + }, + "com.amazonaws.sagemaker#RetentionType": { + "type": "enum", + "members": { + "Retain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Retain" + } + }, + "Delete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delete" + } + } + } + }, + "com.amazonaws.sagemaker#RetryPipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#RetryPipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#RetryPipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Retry the execution of the pipeline.
" + } + }, + "com.amazonaws.sagemaker#RetryPipelineExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#RetryPipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#RetryStrategy": { + "type": "structure", + "members": { + "MaximumRetryAttempts": { + "target": "com.amazonaws.sagemaker#MaximumRetryAttempts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of times to retry the job. When the job is retried, it's\n SecondaryStatus is changed to STARTING.
The retry strategy to use when a training job fails due to an\n InternalServerError. RetryStrategy is specified as part of\n the CreateTrainingJob and CreateHyperParameterTuningJob\n requests. You can add the StoppingCondition parameter to the request to\n limit the training time for the complete job.
Batch size for each rolling step to provision capacity and turn on traffic on the new\n endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between\n 5% to 50% of the variant's total instance count.
", + "smithy.api#required": {} + } + }, + "WaitIntervalInSeconds": { + "target": "com.amazonaws.sagemaker#WaitIntervalInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The length of the baking period, during which SageMaker monitors alarms for each batch on\n the new fleet.
", + "smithy.api#required": {} + } + }, + "MaximumExecutionTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "The time limit for the total deployment. Exceeding this limit causes a timeout.
" + } + }, + "RollbackMaximumBatchSize": { + "target": "com.amazonaws.sagemaker#CapacitySize", + "traits": { + "smithy.api#documentation": "Batch size for rollback to the old endpoint fleet. Each rolling step to provision\n capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the\n new endpoint fleet. If this field is absent, the default value will be set to 100% of\n total capacity which means to bring up the whole capacity of the old fleet at once\n during rollback.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a rolling deployment strategy for updating a SageMaker endpoint.
" + } + }, + "com.amazonaws.sagemaker#RootAccess": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.sagemaker#RoutingStrategy": { + "type": "enum", + "members": { + "LEAST_OUTSTANDING_REQUESTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEAST_OUTSTANDING_REQUESTS" + } + }, + "RANDOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANDOM" + } + } + } + }, + "com.amazonaws.sagemaker#RuleConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#RuleEvaluationStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "NO_ISSUES_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NoIssuesFound" + } + }, + "ISSUES_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IssuesFound" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Error" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#RuleParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#ConfigKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#ConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#S3DataDistribution": { + "type": "enum", + "members": { + "FULLY_REPLICATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FullyReplicated" + } + }, + "SHARDED_BY_S3_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShardedByS3Key" + } + } + } + }, + "com.amazonaws.sagemaker#S3DataSource": { + "type": "structure", + "members": { + "S3DataType": { + "target": "com.amazonaws.sagemaker#S3DataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want SageMaker to use for model\n training.
If you choose AugmentedManifestFile, S3Uri identifies an object that is\n an augmented manifest file in JSON lines format. This file contains the data you want to\n use for model training. AugmentedManifestFile can only be used if the\n Channel's input mode is Pipe.
Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:
A key name prefix might look like this:\n s3://bucketname/exampleprefix/\n
A manifest might look like this:\n s3://bucketname/example.manifest\n
A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set of\n S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
This JSON is equivalent to the following S3Uri\n list:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.
Your input bucket must be located in same Amazon Web Services region as your\n training job.
", + "smithy.api#required": {} + } + }, + "S3DataDistributionType": { + "target": "com.amazonaws.sagemaker#S3DataDistribution", + "traits": { + "smithy.api#documentation": "If you want SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.
If you want SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.
\nIn distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.
A list of one or more attribute names to use that are found in a specified augmented\n manifest file.
" + } + }, + "InstanceGroupNames": { + "target": "com.amazonaws.sagemaker#InstanceGroupNames", + "traits": { + "smithy.api#documentation": "A list of names of instance groups that get data from the S3 data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the S3 data source.
\nYour input bucket must be in the same Amazon Web Services region as your training\n job.
" + } + }, + "com.amazonaws.sagemaker#S3DataType": { + "type": "enum", + "members": { + "MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManifestFile" + } + }, + "S3_PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + }, + "AUGMENTED_MANIFEST_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AugmentedManifestFile" + } + } + } + }, + "com.amazonaws.sagemaker#S3ModelDataSource": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3ModelUri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the S3 path of ML model data to deploy.
", + "smithy.api#required": {} + } + }, + "S3DataType": { + "target": "com.amazonaws.sagemaker#S3ModelDataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the type of ML model data to deploy.
\nIf you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix as part of the ML model\n data to deploy. A valid key name prefix identified by S3Uri always ends\n with a forward slash (/).
If you choose S3Object, S3Uri identifies an object that is\n the ML model data to deploy.
Specifies how the ML model data is prepared.
\nIf you choose Gzip and choose S3Object as the value of\n S3DataType, S3Uri identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during\n model deployment.
If you choose None and chooose S3Object as the value of\n S3DataType, S3Uri identifies an object that represents an\n uncompressed ML model to deploy.
If you choose None and choose S3Prefix as the value of\n S3DataType, S3Uri identifies a key name prefix, under\n which all objects represents the uncompressed ML model to deploy.
If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:
\nIf you choose S3Object as the value of S3DataType,\n then SageMaker will split the key of the S3 object referenced by S3Uri\n by slash (/), and use the last part as the filename of the file holding the\n content of the S3 object.
If you choose S3Prefix as the value of S3DataType,\n then for each S3 object under the key name pefix referenced by\n S3Uri, SageMaker will trim its key by the prefix, and use the\n remainder as the path (relative to /opt/ml/model) of the file\n holding the content of the S3 object. SageMaker will split the remainder by slash\n (/), using intermediate parts as directory names and the last part as filename\n of the file holding the content of the S3 object.
Do not use any of the following as file names or directory names:
\nAn empty or blank string
\nA string which contains null bytes
\nA string longer than 255 bytes
\nA single dot (.)
A double dot (..)
Ambiguous file names will result in model deployment failure. For example, if\n your uncompressed ML model consists of two S3 objects\n s3://mybucket/model/weights and\n s3://mybucket/model/weights/part1 and you specify\n s3://mybucket/model/ as the value of S3Uri and\n S3Prefix as the value of S3DataType, then it will\n result in name clash between /opt/ml/model/weights (a regular file)\n and /opt/ml/model/weights/ (a directory).
Do not organize the model artifacts in S3 console using\n folders. When you create a folder in S3 console, S3 creates a 0-byte\n object with a key set to the folder name you provide. They key of the 0-byte\n object ends with a slash (/) which violates SageMaker restrictions on model artifact\n file names, leading to model deployment failure.
\nSpecifies the access configuration file for the ML model. You can explicitly accept the\n model end-user license agreement (EULA) within the ModelAccessConfig. You are\n responsible for reviewing and complying with any applicable license terms and making sure\n they are acceptable for your use case before downloading or using a model.
Configuration information for hub access.
" + } + }, + "ManifestS3Uri": { + "target": "com.amazonaws.sagemaker#S3ModelUri", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the manifest file. The manifest file is a CSV file that stores the\n artifact locations.
" + } + }, + "ETag": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The ETag associated with S3 URI.
" + } + }, + "ManifestEtag": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The ETag associated with Manifest S3 URI.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the S3 location of ML model data to deploy.
" + } + }, + "com.amazonaws.sagemaker#S3ModelDataType": { + "type": "enum", + "members": { + "S3Prefix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Prefix" + } + }, + "S3Object": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Object" + } + } + } + }, + "com.amazonaws.sagemaker#S3ModelUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.sagemaker#S3OutputPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.sagemaker#S3Presign": { + "type": "structure", + "members": { + "IamPolicyConstraints": { + "target": "com.amazonaws.sagemaker#IamPolicyConstraints", + "traits": { + "smithy.api#documentation": "Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp.
This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.
To learn more about how custom templates are created, see Create custom worker task templates.
" + } + }, + "com.amazonaws.sagemaker#S3StorageConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following:\n s3://example-bucket/prefix/.
The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt\n any objects written into the OfflineStore S3 location.
The IAM roleARN that is passed as a parameter to\n CreateFeatureGroup must have below permissions to the\n KmsKeyId:
\n \"kms:GenerateDataKey\"\n
The S3 path where offline records are written.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage (Amazon S3) location and security configuration for\n OfflineStore.
Provides APIs for creating and managing SageMaker resources.
\nOther Resources:
\nA target tracking scaling policy. Includes support for predefined or customized metrics.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing a recommended scaling policy.
" + } + }, + "com.amazonaws.sagemaker#ScalingPolicyMetric": { + "type": "structure", + "members": { + "InvocationsPerInstance": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The number of invocations sent to a model, normalized by InstanceCount\n in each ProductionVariant. 1/numberOfInstances is sent as the value on each\n request, where numberOfInstances is the number of active instances for the\n ProductionVariant behind the endpoint at the time of the request.
The interval of time taken by a model to respond as viewed from SageMaker.\n This interval includes the local communication times taken to send the request\n and to fetch the response from the container of a model and the time taken to\n complete the inference in the container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metric for a scaling policy.
" + } + }, + "com.amazonaws.sagemaker#ScalingPolicyObjective": { + "type": "structure", + "members": { + "MinInvocationsPerMinute": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The minimum number of expected requests to your endpoint per minute.
" + } + }, + "MaxInvocationsPerMinute": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of expected requests to your endpoint per minute.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object where you specify the anticipated traffic pattern for an endpoint.
" + } + }, + "com.amazonaws.sagemaker#ScheduleConfig": { + "type": "structure", + "members": { + "ScheduleExpression": { + "target": "com.amazonaws.sagemaker#ScheduleExpression", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A cron expression that describes details about the monitoring schedule.
\nThe supported cron expressions are:
\nIf you want to set the job to start every hour, use the following:
\n\n Hourly: cron(0 * ? * * *)\n
If you want to start the job daily:
\n\n cron(0 [00-23] ? * * *)\n
If you want to run the job one time, immediately, use the following\n keyword:
\n\n NOW\n
For example, the following are valid cron expressions:
\nDaily at noon UTC: cron(0 12 ? * * *)\n
Daily at midnight UTC: cron(0 0 ? * * *)\n
To support running every 6, 12 hours, the following are also supported:
\n\n cron(0 [00-23]/[01-24] ? * * *)\n
For example, the following are valid cron expressions:
\nEvery 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)\n
Every two hours starting at midnight: cron(0 0/2 ? * * *)\n
Even though the cron expression is set to start at 5PM UTC, note that there\n could be a delay of 0-20 minutes from the actual requested time to run the\n execution.
\nWe recommend that if you would like a daily schedule, you do not provide this\n parameter. Amazon SageMaker AI will pick a time for running every day.
\nYou can also specify the keyword NOW to run the monitoring job immediately,\n one time, without recurring.
Sets the start time for a monitoring job window. Express this time as an offset to the\n times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the\n ScheduleExpression parameter. Specify this offset in ISO 8601 duration\n format. For example, if you want to monitor the five hours of data in your dataset that\n precede the start of each monitoring job, you would specify: \"-PT5H\".
The start time that you specify must not precede the end time that you specify by more\n than 24 hours. You specify the end time with the DataAnalysisEndTime\n parameter.
If you set ScheduleExpression to NOW, this parameter is\n required.
Sets the end time for a monitoring job window. Express this time as an offset to the\n times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the\n ScheduleExpression parameter. Specify this offset in ISO 8601 duration\n format. For example, if you want to end the window one hour before the start of each\n monitoring job, you would specify: \"-PT1H\".
The end time that you specify must not follow the start time that you specify by more\n than 24 hours. You specify the start time with the DataAnalysisStartTime\n parameter.
If you set ScheduleExpression to NOW, this parameter is\n required.
Configuration details about the monitoring schedule.
" + } + }, + "com.amazonaws.sagemaker#ScheduleExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#ScheduleStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#SchedulerConfig": { + "type": "structure", + "members": { + "PriorityClasses": { + "target": "com.amazonaws.sagemaker#PriorityClassList", + "traits": { + "smithy.api#documentation": "List of the priority classes, PriorityClass, of the cluster policy. When\n specified, these class configurations define how tasks are queued.
When enabled, entities borrow idle compute based on their assigned\n FairShareWeight.
When disabled, entities borrow idle compute based on a first-come first-serve\n basis.
\nDefault is Enabled.
Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.
" + } + }, + "com.amazonaws.sagemaker#SchedulerResourceStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "CREATE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRollbackFailed" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "UPDATE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRollbackFailed" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updated" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "DELETE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteRollbackFailed" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + } + } + }, + "com.amazonaws.sagemaker#Scope": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[!#-\\[\\]-~]+( [!#-\\[\\]-~]+)*$" + } + }, + "com.amazonaws.sagemaker#Search": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#SearchRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#SearchResponse" + }, + "traits": { + "smithy.api#documentation": "Finds SageMaker resources that match a search query. Matching resources are returned\n as a list of SearchRecord objects in the response. You can sort the search\n results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and\n timestamp.
\nThe Search API may provide access to otherwise restricted data. See Amazon SageMaker \n API Permissions: Actions, Permissions, and Resources Reference for more\n information.
\nA list of filter objects.
" + } + }, + "NestedFilters": { + "target": "com.amazonaws.sagemaker#NestedFiltersList", + "traits": { + "smithy.api#documentation": "A list of nested filter objects.
" + } + }, + "SubExpressions": { + "target": "com.amazonaws.sagemaker#SearchExpressionList", + "traits": { + "smithy.api#documentation": "A list of search expression objects.
" + } + }, + "Operator": { + "target": "com.amazonaws.sagemaker#BooleanOperator", + "traits": { + "smithy.api#documentation": "A Boolean operator used to evaluate the search expression. If you want every\n conditional statement in all lists to be satisfied for the entire search expression to\n be true, specify And. If only a single conditional statement needs to be\n true for the entire search expression to be true, specify Or. The default\n value is And.
A multi-expression that searches for the specified resource or resources in a search. All resource\n objects that satisfy the expression's condition are included in the search results. You must specify at\n least one subexpression, filter, or nested filter. A SearchExpression can contain up to\n twenty elements.
A SearchExpression contains the following components:
A list of Filter objects. Each filter defines a simple Boolean\n expression comprised of a resource property name, Boolean operator, and\n value.
A list of NestedFilter objects. Each nested filter defines a list\n of Boolean expressions using a list of resource properties. A nested filter is\n satisfied if a single object in the list satisfies all Boolean\n expressions.
A list of SearchExpression objects. A search expression object\n can be nested in a list of search expression objects.
A Boolean operator: And or Or.
The properties of a training job.
" + } + }, + "Experiment": { + "target": "com.amazonaws.sagemaker#Experiment", + "traits": { + "smithy.api#documentation": "The properties of an experiment.
" + } + }, + "Trial": { + "target": "com.amazonaws.sagemaker#Trial", + "traits": { + "smithy.api#documentation": "The properties of a trial.
" + } + }, + "TrialComponent": { + "target": "com.amazonaws.sagemaker#TrialComponent", + "traits": { + "smithy.api#documentation": "The properties of a trial component.
" + } + }, + "Endpoint": { + "target": "com.amazonaws.sagemaker#Endpoint" + }, + "ModelPackage": { + "target": "com.amazonaws.sagemaker#ModelPackage" + }, + "ModelPackageGroup": { + "target": "com.amazonaws.sagemaker#ModelPackageGroup" + }, + "Pipeline": { + "target": "com.amazonaws.sagemaker#Pipeline" + }, + "PipelineExecution": { + "target": "com.amazonaws.sagemaker#PipelineExecution" + }, + "FeatureGroup": { + "target": "com.amazonaws.sagemaker#FeatureGroup" + }, + "FeatureMetadata": { + "target": "com.amazonaws.sagemaker#FeatureMetadata", + "traits": { + "smithy.api#documentation": "The feature metadata used to search through the features.
" + } + }, + "Project": { + "target": "com.amazonaws.sagemaker#Project", + "traits": { + "smithy.api#documentation": "The properties of a project.
" + } + }, + "HyperParameterTuningJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSearchEntity", + "traits": { + "smithy.api#documentation": "The properties of a hyperparameter tuning job.
" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelCard", + "traits": { + "smithy.api#documentation": "An Amazon SageMaker Model Card that documents details about a machine learning model.
" + } + }, + "Model": { + "target": "com.amazonaws.sagemaker#ModelDashboardModel" + } + }, + "traits": { + "smithy.api#documentation": "A single resource returned as part of the Search API response.
" + } + }, + "com.amazonaws.sagemaker#SearchRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.sagemaker#ResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the SageMaker resource to search for.
", + "smithy.api#required": {} + } + }, + "SearchExpression": { + "target": "com.amazonaws.sagemaker#SearchExpression", + "traits": { + "smithy.api#documentation": "A Boolean conditional statement. Resources must satisfy this condition to be\n included in search results. You must provide at least one subexpression, filter, or\n nested filter. The maximum number of recursive SubExpressions,\n NestedFilters, and Filters that can be included in a\n SearchExpression object is 50.
The name of the resource property used to sort the SearchResults. The\n default is LastModifiedTime.
How SearchResults are ordered. Valid values are Ascending or\n Descending. The default is Descending.
If more than MaxResults resources match the specified\n SearchExpression, the response includes a\n NextToken. The NextToken can be passed to the next\n SearchRequest to continue retrieving results.
The maximum number of results to return.
" + } + }, + "CrossAccountFilterOption": { + "target": "com.amazonaws.sagemaker#CrossAccountFilterOption", + "traits": { + "smithy.api#documentation": "\n A cross account filter option. When the value is \"CrossAccount\" the \n search results will only include resources made discoverable to you from other \n accounts. When the value is \"SameAccount\" or null the \n search results will only include resources from your account. Default is \n null. For more information on searching for resources made \n discoverable to your account, see \n Search discoverable resources in the SageMaker Developer Guide.\n The maximum number of ResourceCatalogs viewable is 1000.\n
\n Limits the results of your search request to the resources that you can access.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#SearchResponse": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.sagemaker#SearchResultsList", + "traits": { + "smithy.api#documentation": "A list of SearchRecord objects.
If the result of the previous Search request was truncated, the response\n includes a NextToken. To retrieve the next set of results, use the token in the next\n request.
Searches for available training plan offerings based on specified criteria.
\nUsers search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration).
\nAnd then, they create a plan that best matches their needs using the ID of the\n plan offering they want to use.
\nFor more information about how to reserve GPU capacity for your SageMaker training jobs or\n SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see \n CreateTrainingPlan\n .
The type of instance you want to search for in the available training plan offerings.\n This field allows you to filter the search results based on the specific compute resources\n you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training\n plan offerings, specifying the instance type helps you find Reserved Instances that match\n your computational needs.
", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of instances you want to reserve in the training plan offerings. This allows\n you to specify the quantity of compute resources needed for your SageMaker training jobs or\n SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your\n requirements.
", + "smithy.api#required": {} + } + }, + "StartTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter to search for training plan offerings with a start time after a specified\n date.
" + } + }, + "EndTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A filter to search for reserved capacity offerings with an end time before a specified\n date.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHoursInput", + "traits": { + "smithy.api#documentation": "The desired duration in hours for the training plan offerings.
" + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the\n offerings.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nA list of training plan offerings that match the search criteria.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#SecondaryStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "LAUNCHING_ML_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LaunchingMLInstances" + } + }, + "PREPARING_TRAINING_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PreparingTrainingStack" + } + }, + "DOWNLOADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Downloading" + } + }, + "DOWNLOADING_TRAINING_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DownloadingTrainingImage" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Training" + } + }, + "UPLOADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Uploading" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "MAX_RUNTIME_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxRuntimeExceeded" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "INTERRUPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Interrupted" + } + }, + "MAX_WAIT_TIME_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxWaitTimeExceeded" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "RESTARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Restarting" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + } + } + }, + "com.amazonaws.sagemaker#SecondaryStatusTransition": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#SecondaryStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Contains a secondary status information from a training\n job.
\nStatus might be one of the following secondary statuses:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTrainingStack\n
\n DownloadingTrainingImage\n
A timestamp that shows when the training job transitioned to the current secondary\n status state.
", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the training job transitioned out of this secondary status\n state into another secondary status state or when the training job has ended.
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.sagemaker#StatusMessage", + "traits": { + "smithy.api#documentation": "A detailed description of the progress within a secondary status.\n
\nSageMaker provides secondary statuses and status messages that apply to each of\n them:
\nStarting the training job.
\nLaunching requested ML\n instances.
\nInsufficient\n capacity error from EC2 while launching instances,\n retrying!
\nLaunched\n instance was unhealthy, replacing it!
\nPreparing the instances for training.
\nTraining\n image download completed. Training in\n progress.
\nStatus messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.
\nTo have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example,\n at the start of a training job, you might see the following:
\n TrainingJobStatus - InProgress
\n SecondaryStatus - Training
\n StatusMessage - Downloading the training image
An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the\n training job has transitioned through. A training job can be in one of several states,\n for example, starting, downloading, training, or uploading. Within each state, there are\n a number of intermediate states. For example, within the starting state, SageMaker could be\n starting the training job or launching the ML instances. These transitional states are\n referred to as the job's secondary\n status.\n
The name of the pipeline step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A step selected to run in selective execution mode.
" + } + }, + "com.amazonaws.sagemaker#SelectedStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SelectedStep" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#SelectiveExecutionConfig": { + "type": "structure", + "members": { + "SourcePipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either Failed\n or Success.
This field is required if the steps you specify for\n SelectedSteps depend on output collaterals from any non-specified pipeline\n steps. For more information, see Selective\n Execution for Pipeline Steps.
A list of pipeline steps to run. All step(s) in all path(s) between\n two selected steps should be included.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The selective execution configuration applied to the pipeline run.
" + } + }, + "com.amazonaws.sagemaker#SelectiveExecutionResult": { + "type": "structure", + "members": { + "SourcePipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The ARN from an execution of the current pipeline.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The ARN from an execution of the current pipeline.
" + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepFailure": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Notifies the pipeline that the execution of a callback step failed, along with a\n message describing why. When a callback step is run, the pipeline generates a callback\n token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureRequest": { + "type": "structure", + "members": { + "CallbackToken": { + "target": "com.amazonaws.sagemaker#CallbackToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The pipeline generated token from the Amazon SQS queue.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "A message describing why the step failed.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Notifies the pipeline that the execution of a callback step succeeded and provides a\n list of the step's output parameters. When a callback step is run, the pipeline generates\n a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessRequest": { + "type": "structure", + "members": { + "CallbackToken": { + "target": "com.amazonaws.sagemaker#CallbackToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The pipeline generated token from the Amazon SQS queue.
", + "smithy.api#required": {} + } + }, + "OutputParameters": { + "target": "com.amazonaws.sagemaker#OutputParameterList", + "traits": { + "smithy.api#documentation": "A list of the output parameters of the callback step.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ServerlessMaxConcurrency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.sagemaker#ServerlessMemorySizeInMB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1024, + "max": 6144 + } + } + }, + "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.sagemaker#ServiceCatalogEntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]*$" + } + }, + "com.amazonaws.sagemaker#ServiceCatalogProvisionedProductDetails": { + "type": "structure", + "members": { + "ProvisionedProductId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#documentation": "The ID of the provisioned product.
" + } + }, + "ProvisionedProductStatusMessage": { + "target": "com.amazonaws.sagemaker#ProvisionedProductStatusMessage", + "traits": { + "smithy.api#documentation": "The current status of the product.
\n\n AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
\n UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
\n TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
\n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
\n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
Details of a provisioned service catalog product. For information about service catalog,\n see What is Amazon Web Services Service\n Catalog.
" + } + }, + "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails": { + "type": "structure", + "members": { + "ProductId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the product to provision.
", + "smithy.api#required": {} + } + }, + "ProvisioningArtifactId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#documentation": "The ID of the provisioning artifact.
" + } + }, + "PathId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#documentation": "The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
" + } + }, + "ProvisioningParameters": { + "target": "com.amazonaws.sagemaker#ProvisioningParameters", + "traits": { + "smithy.api#documentation": "A list of key value pairs that you specify when you provision a product.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details that you specify to provision a service catalog product. For information about\n service catalog, see What is Amazon Web Services Service\n Catalog.
" + } + }, + "com.amazonaws.sagemaker#ServiceCatalogProvisioningUpdateDetails": { + "type": "structure", + "members": { + "ProvisioningArtifactId": { + "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", + "traits": { + "smithy.api#documentation": "The ID of the provisioning artifact.
" + } + }, + "ProvisioningParameters": { + "target": "com.amazonaws.sagemaker#ProvisioningParameters", + "traits": { + "smithy.api#documentation": "A list of key value pairs that you specify when you provision a product.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details that you specify to provision a service catalog product. \n For information about service catalog, see What is Amazon Web Services Service Catalog.\n
" + } + }, + "com.amazonaws.sagemaker#SessionChainingConfig": { + "type": "structure", + "members": { + "EnableSessionTagChaining": { + "target": "com.amazonaws.sagemaker#EnableSessionTagChaining", + "traits": { + "smithy.api#documentation": "Set to True to allow SageMaker to extract session tags from a training job\n creation role and reuse these tags when assuming the training job execution role.
Contains information about attribute-based access control (ABAC) for a training job.\n The session chaining configuration uses Amazon Security Token Service (STS) for your training job to\n request temporary, limited-privilege credentials to tenants. For more information, see\n Attribute-based access control (ABAC) for multi-tenancy training.
" + } + }, + "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1800, + "max": 43200 + } + } + }, + "com.amazonaws.sagemaker#ShadowModeConfig": { + "type": "structure", + "members": { + "SourceModelVariantName": { + "target": "com.amazonaws.sagemaker#ModelVariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The name of the production variant, which takes all the inference requests.\n
", + "smithy.api#required": {} + } + }, + "ShadowModelVariants": { + "target": "com.amazonaws.sagemaker#ShadowModelVariantConfigList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List of shadow variant configurations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type, which specifies a production variant\n to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.\n
The name of the shadow variant.
", + "smithy.api#required": {} + } + }, + "SamplingPercentage": { + "target": "com.amazonaws.sagemaker#Percentage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The name and sampling percentage of a shadow variant.
" + } + }, + "com.amazonaws.sagemaker#ShadowModelVariantConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ShadowModelVariantConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#SharingSettings": { + "type": "structure", + "members": { + "NotebookOutputOption": { + "target": "com.amazonaws.sagemaker#NotebookOutputOption", + "traits": { + "smithy.api#documentation": "Whether to include the notebook cell output when sharing the notebook. The default is\n Disabled.
When NotebookOutputOption is Allowed, the Amazon S3\n bucket used to store the shared notebook snapshots.
When NotebookOutputOption is Allowed, the Amazon Web Services Key\n Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the\n Amazon S3 bucket.
Specifies options for sharing Amazon SageMaker AI Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain API\n is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing isn't\n allowed.
Determines the shuffling order in ShuffleConfig value.
A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, the results of the S3 key prefix\n matches are shuffled. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.
For Pipe input mode, when ShuffleConfig is specified shuffling is done at\n the start of every epoch. With large datasets, this ensures that the order of the\n training data is different for each epoch, and it helps reduce bias and possible\n overfitting. In a multi-node training job when ShuffleConfig is combined\n with S3DataDistributionType of ShardedByS3Key, the data is\n shuffled across nodes so that the content sent to a particular node on the first epoch\n might be sent to a different node on the second epoch.
The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services\n region as the algorithm.
\nSpecifies the location of ML model data to deploy during endpoint creation.
" + } + }, + "ModelDataETag": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The ETag associated with Model Data URL.
" + } + }, + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
" + } + }, + "com.amazonaws.sagemaker#SourceAlgorithmList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SourceAlgorithm" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#SourceAlgorithmSpecification": { + "type": "structure", + "members": { + "SourceAlgorithms": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of the algorithms that were used to create a model package.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of algorithms that were used to create a model package.
" + } + }, + "com.amazonaws.sagemaker#SourceIpConfig": { + "type": "structure", + "members": { + "Cidrs": { + "target": "com.amazonaws.sagemaker#Cidrs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of one to ten Classless Inter-Domain Routing (CIDR) values.
\nMaximum: Ten CIDR values
\nThe following Length Constraints apply to individual CIDR values in\n the CIDR value list.
\nA list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an\n IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
" + } + }, + "com.amazonaws.sagemaker#SourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.sagemaker#SourceUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#SpaceAppLifecycleManagement": { + "type": "structure", + "members": { + "IdleSettings": { + "target": "com.amazonaws.sagemaker#SpaceIdleSettings", + "traits": { + "smithy.api#documentation": "Settings related to idle shutdown of Studio applications.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications in a space.
" + } + }, + "com.amazonaws.sagemaker#SpaceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/" + } + }, + "com.amazonaws.sagemaker#SpaceCodeEditorAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + }, + "AppLifecycleManagement": { + "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", + "traits": { + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of CodeEditor applications in\n a space.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The application settings for a Code Editor space.
" + } + }, + "com.amazonaws.sagemaker#SpaceDetails": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the associated domain.
" + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#documentation": "The name of the space.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#SpaceStatus", + "traits": { + "smithy.api#documentation": "The status.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "The creation time.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "The last modified time.
" + } + }, + "SpaceSettingsSummary": { + "target": "com.amazonaws.sagemaker#SpaceSettingsSummary", + "traits": { + "smithy.api#documentation": "Specifies summary information about the space settings.
" + } + }, + "SpaceSharingSettingsSummary": { + "target": "com.amazonaws.sagemaker#SpaceSharingSettingsSummary", + "traits": { + "smithy.api#documentation": "Specifies summary information about the space sharing settings.
" + } + }, + "OwnershipSettingsSummary": { + "target": "com.amazonaws.sagemaker#OwnershipSettingsSummary", + "traits": { + "smithy.api#documentation": "Specifies summary information about the ownership settings.
" + } + }, + "SpaceDisplayName": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The name of the space that appears in the Studio UI.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The space's details.
" + } + }, + "com.amazonaws.sagemaker#SpaceEbsVolumeSizeInGb": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 16384 + } + } + }, + "com.amazonaws.sagemaker#SpaceIdleSettings": { + "type": "structure", + "members": { + "IdleTimeoutInMinutes": { + "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The time that SageMaker waits after the application becomes idle before shutting it\n down.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings related to idle shutdown of Studio applications in a space.
" + } + }, + "com.amazonaws.sagemaker#SpaceJupyterLabAppSettings": { + "type": "structure", + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + }, + "CodeRepositories": { + "target": "com.amazonaws.sagemaker#CodeRepositories", + "traits": { + "smithy.api#documentation": "A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
" + } + }, + "AppLifecycleManagement": { + "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", + "traits": { + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of JupyterLab applications in\n a space.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for the JupyterLab application within a space.
" + } + }, + "com.amazonaws.sagemaker#SpaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SpaceDetails" + } + }, + "com.amazonaws.sagemaker#SpaceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#SpaceSettings": { + "type": "structure", + "members": { + "JupyterServerAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterServerAppSettings" + }, + "KernelGatewayAppSettings": { + "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings" + }, + "CodeEditorAppSettings": { + "target": "com.amazonaws.sagemaker#SpaceCodeEditorAppSettings", + "traits": { + "smithy.api#documentation": "The Code Editor application settings.
" + } + }, + "JupyterLabAppSettings": { + "target": "com.amazonaws.sagemaker#SpaceJupyterLabAppSettings", + "traits": { + "smithy.api#documentation": "The settings for the JupyterLab application.
" + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "The type of app created within the space.
\nIf using the \n UpdateSpace API, you can't change the app type of your\n space by specifying a different value for this field.
" + } + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#SpaceStorageSettings", + "traits": { + "smithy.api#documentation": "The storage settings for a space.
" + } + }, + "CustomFileSystems": { + "target": "com.amazonaws.sagemaker#CustomFileSystems", + "traits": { + "smithy.api#documentation": "A file system, created by you, that you assign to a space for an Amazon SageMaker AI\n Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of space settings.
" + } + }, + "com.amazonaws.sagemaker#SpaceSettingsSummary": { + "type": "structure", + "members": { + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "The type of app created within the space.
" + } + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#SpaceStorageSettings", + "traits": { + "smithy.api#documentation": "The storage settings for a space.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies summary information about the space settings.
" + } + }, + "com.amazonaws.sagemaker#SpaceSharingSettings": { + "type": "structure", + "members": { + "SharingType": { + "target": "com.amazonaws.sagemaker#SharingType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the sharing type of the space.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of space sharing settings.
" + } + }, + "com.amazonaws.sagemaker#SpaceSharingSettingsSummary": { + "type": "structure", + "members": { + "SharingType": { + "target": "com.amazonaws.sagemaker#SharingType", + "traits": { + "smithy.api#documentation": "Specifies the sharing type of the space.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies summary information about the space sharing settings.
" + } + }, + "com.amazonaws.sagemaker#SpaceSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + } + } + }, + "com.amazonaws.sagemaker#SpaceStatus": { + "type": "enum", + "members": { + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "Update_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Update_Failed" + } + }, + "Delete_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delete_Failed" + } + } + } + }, + "com.amazonaws.sagemaker#SpaceStorageSettings": { + "type": "structure", + "members": { + "EbsStorageSettings": { + "target": "com.amazonaws.sagemaker#EbsStorageSettings", + "traits": { + "smithy.api#documentation": "A collection of EBS storage settings for a space.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The storage settings for a space.
" + } + }, + "com.amazonaws.sagemaker#SpawnRate": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#SplitType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Line" + } + }, + "RECORDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecordIO" + } + }, + "TFRECORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TFRecord" + } + } + } + }, + "com.amazonaws.sagemaker#StageDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^.{0,1024}$" + } + }, + "com.amazonaws.sagemaker#StageStatus": { + "type": "enum", + "members": { + "Creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ReadyToDeploy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READYTODEPLOY" + } + }, + "Starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "Deployed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#Stairs": { + "type": "structure", + "members": { + "DurationInSeconds": { + "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", + "traits": { + "smithy.api#documentation": "Defines how long each traffic step should be.
" + } + }, + "NumberOfSteps": { + "target": "com.amazonaws.sagemaker#NumberOfSteps", + "traits": { + "smithy.api#documentation": "Specifies how many steps to perform during traffic.
" + } + }, + "UsersPerStep": { + "target": "com.amazonaws.sagemaker#UsersPerStep", + "traits": { + "smithy.api#documentation": "Specifies how many new users to spawn in each step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the stairs traffic pattern for an Inference Recommender load test. This pattern\n type consists of multiple steps where the number of users increases at each step.
\nSpecify either the stairs or phases traffic pattern.
" + } + }, + "com.amazonaws.sagemaker#StartEdgeDeploymentStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartEdgeDeploymentStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Starts a stage in an edge deployment plan.
" + } + }, + "com.amazonaws.sagemaker#StartEdgeDeploymentStageRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan to start.
", + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stage to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StartInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Starts an inference experiment.
" + } + }, + "com.amazonaws.sagemaker#StartInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference experiment to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartInferenceExperimentResponse": { + "type": "structure", + "members": { + "InferenceExperimentArn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the started inference experiment to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Programmatically start an MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tracking server to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the started tracking server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StartMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartMonitoringScheduleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Starts a previously stopped monitoring schedule.
\nBy default, when you successfully create a new schedule, the status of a monitoring\n schedule is scheduled.
The name of the schedule to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartNotebookInstanceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Launches an ML compute instance with the latest version of the libraries and\n attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to InService. A notebook\n instance's status must be InService before you can connect to your Jupyter\n notebook.
The name of the notebook instance to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartPipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartPipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StartPipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Starts a pipeline execution.
" + } + }, + "com.amazonaws.sagemaker#StartPipelineExecutionRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the pipeline.
", + "smithy.api#required": {} + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline execution.
" + } + }, + "PipelineParameters": { + "target": "com.amazonaws.sagemaker#ParameterList", + "traits": { + "smithy.api#documentation": "Contains a list of pipeline parameters. This list can be empty.
" + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "The description of the pipeline execution.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.
" + } + }, + "SelectiveExecutionConfig": { + "target": "com.amazonaws.sagemaker#SelectiveExecutionConfig", + "traits": { + "smithy.api#documentation": "The selective execution configuration applied to the pipeline run.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartPipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#Statistic": { + "type": "enum", + "members": { + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "MINIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "MAXIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "SAMPLE_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + } + } + }, + "com.amazonaws.sagemaker#StatusDetails": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#StatusMessage": { + "type": "string" + }, + "com.amazonaws.sagemaker#StepDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3072 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#StepDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#StepName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.sagemaker#StepStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "EXECUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Executing" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } + } + }, + "com.amazonaws.sagemaker#StopAutoMLJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopAutoMLJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "A method for forcing a running job to shut down.
" + } + }, + "com.amazonaws.sagemaker#StopAutoMLJobRequest": { + "type": "structure", + "members": { + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the object you are requesting.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopCompilationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopCompilationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops a model compilation job.
\nTo stop a job, Amazon SageMaker AI sends the algorithm the SIGTERM signal. This gracefully shuts the\n job down. If the job hasn't stopped, it sends the SIGKILL signal.
\nWhen it receives a StopCompilationJob request, Amazon SageMaker AI changes the\n CompilationJobStatus of the job to Stopping. After Amazon\n SageMaker stops the job, it sets the CompilationJobStatus to\n Stopped.
The name of the model compilation job to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopEdgeDeploymentStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopEdgeDeploymentStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Stops a stage in an edge deployment plan.
" + } + }, + "com.amazonaws.sagemaker#StopEdgeDeploymentStageRequest": { + "type": "structure", + "members": { + "EdgeDeploymentPlanName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge deployment plan to stop.
", + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stage to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopEdgePackagingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopEdgePackagingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Request to stop an edge packaging job.
" + } + }, + "com.amazonaws.sagemaker#StopEdgePackagingJobRequest": { + "type": "structure", + "members": { + "EdgePackagingJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the edge packaging job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopHyperParameterTuningJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopHyperParameterTuningJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops a running hyperparameter tuning job and all running training jobs that the\n tuning job launched.
\nAll model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All\n data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the\n tuning job moves to the Stopped state, it releases all\n reserved\n resources for the tuning job.
The name of the tuning job to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StopInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops an inference experiment.
" + } + }, + "com.amazonaws.sagemaker#StopInferenceExperimentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#InferenceExperimentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference experiment to stop.
", + "smithy.api#required": {} + } + }, + "ModelVariantActions": { + "target": "com.amazonaws.sagemaker#ModelVariantActionMap", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:\n
\n\n Promote - Promote the shadow variant to a production variant
\n Remove - Delete the variant
\n Retain - Keep the variant as it is
\n An array of ModelVariantConfig objects. There is one for each variant that you want to deploy\n after the inference experiment stops. Each ModelVariantConfig describes the infrastructure\n configuration for deploying the corresponding variant.\n
\n The desired state of the experiment after stopping. The possible states are the following:\n
\n\n Completed: The experiment completed successfully
\n Cancelled: The experiment was canceled
The reason for stopping the experiment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopInferenceExperimentResponse": { + "type": "structure", + "members": { + "InferenceExperimentArn": { + "target": "com.amazonaws.sagemaker#InferenceExperimentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the stopped inference experiment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StopInferenceRecommendationsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopInferenceRecommendationsJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops an Inference Recommender job.
" + } + }, + "com.amazonaws.sagemaker#StopInferenceRecommendationsJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the job you want to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopLabelingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopLabelingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops a running labeling job. A job that is stopped cannot be restarted. Any results\n obtained before the job is stopped are placed in the Amazon S3 output bucket.
" + } + }, + "com.amazonaws.sagemaker#StopLabelingJobRequest": { + "type": "structure", + "members": { + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the labeling job to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Programmatically stop an MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tracking server to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the stopped tracking server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StopMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopMonitoringScheduleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops a previously started monitoring schedule.
" + } + }, + "com.amazonaws.sagemaker#StopMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the schedule to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopNotebookInstanceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the\n ML storage volume. SageMaker AI stops charging you for the ML compute instance when\n you call StopNotebookInstance.
To access data on the ML storage volume for a notebook instance that has been\n terminated, call the StartNotebookInstance API.\n StartNotebookInstance launches another ML compute instance, configures\n it, and attaches the preserved ML storage volume so you can continue your work.\n
The name of the notebook instance to terminate.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopOptimizationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Ends a running inference optimization job.
" + } + }, + "com.amazonaws.sagemaker#StopOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopPipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopPipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StopPipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops a pipeline execution.
\n\n Callback Step\n
\nA pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".
You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.
Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
\n\n Lambda Step\n
\nA pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.
The Amazon Resource Name (ARN) of the pipeline execution.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.sagemaker#IdempotencyToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopPipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#StopProcessingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopProcessingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops a processing job.
" + } + }, + "com.amazonaws.sagemaker#StopProcessingJobRequest": { + "type": "structure", + "members": { + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the processing job to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopTrainingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops a training job. To stop a job, SageMaker sends the algorithm the\n SIGTERM signal, which delays job termination for 120 seconds.\n Algorithms might use this 120-second window to save the model artifacts, so the results\n of the training is not lost.
When it receives a StopTrainingJob request, SageMaker changes the status of\n the job to Stopping. After SageMaker stops the job, it sets the status to\n Stopped.
The name of the training job to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopTransformJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopTransformJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops a batch transform job.
\nWhen Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a batch transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
The name of the batch transform job to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StoppingCondition": { + "type": "structure", + "members": { + "MaxRuntimeInSeconds": { + "target": "com.amazonaws.sagemaker#MaxRuntimeInSeconds", + "traits": { + "smithy.api#documentation": "The maximum length of time, in seconds, that a training or compilation job can run\n before it is stopped.
\nFor compilation jobs, if the job does not complete during this time, a\n TimeOut error is generated. We recommend starting with 900 seconds and\n increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job.\n When RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is\n 28 days.
The maximum time that a TrainingJob can run in total, including any time\n spent publishing metrics or archiving and uploading models after it has been stopped, is\n 30 days.
The maximum length of time, in seconds, that a managed Spot training job has to\n complete. It is the amount of time spent waiting for Spot capacity plus the amount of\n time the job can run. It must be equal to or greater than\n MaxRuntimeInSeconds. If the job does not complete during this time,\n SageMaker ends the job.
When RetryStrategy is specified in the job request,\n MaxWaitTimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt.
The maximum length of time, in seconds, that a training or compilation job can be\n pending before it is stopped.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker\n ends the job. Use this API to cap costs.
\nTo stop a training job, SageMaker sends the algorithm the SIGTERM signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.
\nThe Amazon Resource Name (ARN) of the Lifecycle Configuration.
" + } + }, + "StudioLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", + "traits": { + "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle\n Configurations are immutable.
" + } + }, + "StudioLifecycleConfigAppType": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", + "traits": { + "smithy.api#documentation": "The App type to which the Lifecycle Configuration is attached.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the Amazon SageMaker AI Studio Lifecycle Configuration.
" + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + }, + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.sagemaker#StudioLifecycleConfigsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigDetails" + } + }, + "com.amazonaws.sagemaker#StudioWebPortal": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#StudioWebPortalSettings": { + "type": "structure", + "members": { + "HiddenMlTools": { + "target": "com.amazonaws.sagemaker#HiddenMlToolsList", + "traits": { + "smithy.api#documentation": "The machine learning tools that are hidden from the Studio left navigation pane.
" + } + }, + "HiddenAppTypes": { + "target": "com.amazonaws.sagemaker#HiddenAppTypesList", + "traits": { + "smithy.api#documentation": "The Applications supported in Studio that are hidden from the Studio left navigation\n pane.
" + } + }, + "HiddenInstanceTypes": { + "target": "com.amazonaws.sagemaker#HiddenInstanceTypesList", + "traits": { + "smithy.api#documentation": "The instance types you are hiding from the Studio user interface.
" + } + }, + "HiddenSageMakerImageVersionAliases": { + "target": "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList", + "traits": { + "smithy.api#documentation": "The version aliases you are hiding from the Studio user interface.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.
" + } + }, + "com.amazonaws.sagemaker#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#Subnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#SubscribedWorkteam": { + "type": "structure", + "members": { + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vendor that you have subscribed.
", + "smithy.api#required": {} + } + }, + "MarketplaceTitle": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#documentation": "The title of the service provided by the vendor in the Amazon Marketplace.
" + } + }, + "SellerName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The name of the vendor in the Amazon Marketplace.
" + } + }, + "MarketplaceDescription": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#documentation": "The description of the vendor from the Amazon Marketplace.
" + } + }, + "ListingId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "Marketplace product listing ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a work team of a vendor that does the labelling job.
" + } + }, + "com.amazonaws.sagemaker#SubscribedWorkteams": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SubscribedWorkteam" + } + }, + "com.amazonaws.sagemaker#Success": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#SuggestionQuery": { + "type": "structure", + "members": { + "PropertyNameQuery": { + "target": "com.amazonaws.sagemaker#PropertyNameQuery", + "traits": { + "smithy.api#documentation": "Defines a property name hint. Only property\n names that begin with the specified hint are included in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specified in the GetSearchSuggestions request.\n Limits the property names that are included in the response.
" + } + }, + "com.amazonaws.sagemaker#SynthesizedJsonHumanLoopActivationConditions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10240 + }, + "smithy.api#mediaType": "application/json" + } + }, + "com.amazonaws.sagemaker#TableFormat": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Default" + } + }, + "GLUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Glue" + } + }, + "ICEBERG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Iceberg" + } + } + } + }, + "com.amazonaws.sagemaker#TableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.sagemaker#TabularJobConfig": { + "type": "structure", + "members": { + "CandidateGenerationConfig": { + "target": "com.amazonaws.sagemaker#CandidateGenerationConfig", + "traits": { + "smithy.api#documentation": "The configuration information of how model candidates are generated.
" + } + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + }, + "FeatureSpecificationS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job V2. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
These column keys may not include the target column.
\nIn ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.
If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.
Generates possible candidates without training the models. A model candidate is a\n combination of data preprocessors, algorithms, and algorithm parameter settings.
" + } + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "The type of supervised learning problem available for the model candidates of the AutoML\n job V2. For more information, see \n SageMaker Autopilot problem types.
\nYou must either specify the type of supervised learning problem in\n ProblemType and provide the AutoMLJobObjective metric, or none at all.
The name of the target variable in supervised learning, usually represented by\n 'y'.
", + "smithy.api#required": {} + } + }, + "SampleWeightAttributeName": { + "target": "com.amazonaws.sagemaker#SampleWeightAttributeName", + "traits": { + "smithy.api#documentation": "If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.
\nSample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.
\nSupport for sample weights is available in Ensembling\n mode only.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the tabular problem type.
" + } + }, + "com.amazonaws.sagemaker#TabularResolvedAttributes": { + "type": "structure", + "members": { + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "The type of supervised learning problem available for the model candidates of the AutoML\n job V2 (Binary Classification, Multiclass Classification, Regression). For more\n information, see \n SageMaker Autopilot problem types.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resolved attributes specific to the tabular problem type.
" + } + }, + "com.amazonaws.sagemaker#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#TagKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The tag key. Tag keys must be unique per resource.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#TagValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The tag value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A tag object that consists of a key and an optional value, used to manage metadata\n for SageMaker Amazon Web Services resources.
\nYou can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to SageMaker resources, see AddTags.
\nFor more information on adding metadata to your Amazon Web Services resources with\n tagging, see Tagging Amazon Web Services resources. For advice on best practices for\n managing Amazon Web Services resources with tagging, see Tagging\n Best Practices: Implement an Effective Amazon Web Services Resource Tagging\n Strategy.
" + } + }, + "com.amazonaws.sagemaker#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.sagemaker#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#TagPropagation": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.sagemaker#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.sagemaker#TargetAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TargetDevice": { + "type": "enum", + "members": { + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lambda" + } + }, + "ML_M4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_m4" + } + }, + "ML_M5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_m5" + } + }, + "ML_M6G": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_m6g" + } + }, + "ML_C4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_c4" + } + }, + "ML_C5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_c5" + } + }, + "ML_C6G": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_c6g" + } + }, + "ML_P2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_p2" + } + }, + "ML_P3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_p3" + } + }, + "ML_G4DN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_g4dn" + } + }, + "ML_INF1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_inf1" + } + }, + "ML_INF2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_inf2" + } + }, + "ML_TRN1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_trn1" + } + }, + "ML_EIA2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml_eia2" + } + }, + "JETSON_TX1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_tx1" + } + }, + "JETSON_TX2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_tx2" + } + }, + "JETSON_NANO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_nano" + } + }, + "JETSON_XAVIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_xavier" + } + }, + "RASP3B": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rasp3b" + } + }, + "RASP4B": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rasp4b" + } + }, + "IMX8QM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "imx8qm" + } + }, + "DEEPLENS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deeplens" + } + }, + "RK3399": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rk3399" + } + }, + "RK3288": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rk3288" + } + }, + "AISAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aisage" + } + }, + "SBE_C": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sbe_c" + } + }, + "QCS605": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "qcs605" + } + }, + "QCS603": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "qcs603" + } + }, + "SITARA_AM57X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sitara_am57x" + } + }, + "AMBA_CV2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amba_cv2" + } + }, + "AMBA_CV22": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amba_cv22" + } + }, + "AMBA_CV25": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amba_cv25" + } + }, + "X86_WIN32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_win32" + } + }, + "X86_WIN64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_win64" + } + }, + "COREML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coreml" + } + }, + "JACINTO_TDA4VM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jacinto_tda4vm" + } + }, + "IMX8MPLUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "imx8mplus" + } + } + } + }, + "com.amazonaws.sagemaker#TargetLabelColumn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#TargetObjectiveMetricValue": { + "type": "float" + }, + "com.amazonaws.sagemaker#TargetPlatform": { + "type": "structure", + "members": { + "Os": { + "target": "com.amazonaws.sagemaker#TargetPlatformOs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies a target platform OS.
\n\n LINUX: Linux-based operating systems.
\n ANDROID: Android operating systems. Android API level can be\n specified using the ANDROID_PLATFORM compiler option. For example,\n \"CompilerOptions\": {'ANDROID_PLATFORM': 28}\n
Specifies a target platform architecture.
\n\n X86_64: 64-bit version of the x86 instruction set.
\n X86: 32-bit version of the x86 instruction set.
\n ARM64: ARMv8 64-bit CPU.
\n ARM_EABIHF: ARMv7 32-bit, Hard Float.
\n ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM\n platform.
Specifies a target platform accelerator (optional).
\n\n NVIDIA: Nvidia graphics processing unit. It also requires\n gpu-code, trt-ver, cuda-ver compiler\n options
\n MALI: ARM Mali graphics processor
\n INTEL_GRAPHICS: Integrated Intel graphics
Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.
An object containing information about a metric.
" + } + }, + "TargetValue": { + "target": "com.amazonaws.sagemaker#Double", + "traits": { + "smithy.api#documentation": "The recommended target value to specify for the metric when creating a scaling policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A target tracking scaling policy. Includes support for predefined or customized metrics.
\nWhen using the PutScalingPolicy API,\n this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker AI\n image created on the instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The TensorBoard app settings.
" + } + }, + "com.amazonaws.sagemaker#TensorBoardOutputConfig": { + "type": "structure", + "members": { + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "Path to local storage location for tensorBoard output. Defaults to\n /opt/ml/output/tensorboard.
Path to Amazon S3 storage location for TensorBoard output.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
" + } + }, + "com.amazonaws.sagemaker#TenthFractionsOfACent": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 9 + } + } + }, + "com.amazonaws.sagemaker#TerminationWaitInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#TextClassificationJobConfig": { + "type": "structure", + "members": { + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "How long a job is allowed to run, or how many candidates a job is allowed to\n generate.
" + } + }, + "ContentColumn": { + "target": "com.amazonaws.sagemaker#ContentColumn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the column used to provide the sentences to be classified. It should not be\n the same as the target column.
", + "smithy.api#required": {} + } + }, + "TargetLabelColumn": { + "target": "com.amazonaws.sagemaker#TargetLabelColumn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the column used to provide the class labels. It should not be same as the\n content column.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the text classification problem\n type.
" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.sagemaker#TextGenerationJobConfig": { + "type": "structure", + "members": { + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "How long a fine-tuning job is allowed to run. For TextGenerationJobConfig\n problem types, the MaxRuntimePerTrainingJobInSeconds attribute of\n AutoMLJobCompletionCriteria defaults to 72h (259200s).
The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon7BInstruct.
The hyperparameters used to configure and optimize the learning process of the base\n model. You can set any combination of the following hyperparameters for all base models.\n For more information on each supported hyperparameter, see Optimize\n the learning process of your text generation models with hyperparameters.
\n\n \"epochCount\": The number of times the model goes through the entire\n training dataset. Its value should be a string containing an integer value within the\n range of \"1\" to \"10\".
\n \"batchSize\": The number of data samples used in each iteration of\n training. Its value should be a string containing an integer value within the range\n of \"1\" to \"64\".
\n \"learningRate\": The step size at which a model's parameters are\n updated during training. Its value should be a string containing a floating-point\n value within the range of \"0\" to \"1\".
\n \"learningRateWarmupSteps\": The number of training steps during which\n the learning rate gradually increases before reaching its target or maximum value.\n Its value should be a string containing an integer value within the range of \"0\" to\n \"250\".
Here is an example where all four hyperparameters are configured.
\n\n { \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\",\n \"learningRateWarmupSteps\": \"10\" }\n
The collection of settings used by an AutoML job V2 for the text generation problem\n type.
\nThe text generation models that support fine-tuning in Autopilot are currently accessible\n exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported\n Regions.
\nThe name of the base model to fine-tune.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resolved attributes specific to the text generation problem type.
" + } + }, + "com.amazonaws.sagemaker#ThingName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" + } + }, + "com.amazonaws.sagemaker#ThroughputConfig": { + "type": "structure", + "members": { + "ThroughputMode": { + "target": "com.amazonaws.sagemaker#ThroughputMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The mode used for your feature group throughput: ON_DEMAND or\n PROVISIONED.
For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.sagemaker#CapacityUnit", + "traits": { + "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Used to set feature group throughput configuration. There are two modes:\n ON_DEMAND and PROVISIONED. With on-demand mode, you are\n charged for data reads and writes that your application performs on your feature group. You\n do not need to specify read and write throughput because Feature Store accommodates your\n workloads as they ramp up and down. You can switch a feature group to on-demand only once\n in a 24 hour period. With provisioned throughput mode, you specify the read and write\n capacity per second that you expect your application to require, and you are billed based\n on those limits. Exceeding provisioned throughput will result in your requests being\n throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that\n are offline-only, or use the \n Standard\n tier online store.
The mode used for your feature group throughput: ON_DEMAND or\n PROVISIONED.
For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.sagemaker#CapacityUnit", + "traits": { + "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Active throughput configuration of the feature group. There are two modes:\n ON_DEMAND and PROVISIONED. With on-demand mode, you are\n charged for data reads and writes that your application performs on your feature group. You\n do not need to specify read and write throughput because Feature Store accommodates your\n workloads as they ramp up and down. You can switch a feature group to on-demand only once\n in a 24 hour period. With provisioned throughput mode, you specify the read and write\n capacity per second that you expect your application to require, and you are billed based\n on those limits. Exceeding provisioned throughput will result in your requests being\n throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that\n are offline-only, or use the \n Standard\n tier online store.
Target throughput mode of the feature group. Throughput update is an asynchronous\n operation, and the outcome should be monitored by polling LastUpdateStatus\n field in DescribeFeatureGroup response. You cannot update a feature group's\n throughput while another update is in progress.
For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.
" + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.sagemaker#CapacityUnit", + "traits": { + "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The new throughput configuration for the feature group. You can switch between on-demand\n and provisioned modes or update the read / write capacity of provisioned feature groups.\n You can switch a feature group to on-demand only once in a 24 hour period.
" + } + }, + "com.amazonaws.sagemaker#ThroughputMode": { + "type": "enum", + "members": { + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnDemand" + } + }, + "PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Provisioned" + } + } + } + }, + "com.amazonaws.sagemaker#TimeSeriesConfig": { + "type": "structure", + "members": { + "TargetAttributeName": { + "target": "com.amazonaws.sagemaker#TargetAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the column representing the target variable that you want to predict for\n each item in your dataset. The data type of the target variable must be numerical.
", + "smithy.api#required": {} + } + }, + "TimestampAttributeName": { + "target": "com.amazonaws.sagemaker#TimestampAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the column indicating a point in time at which the target value of a given\n item is recorded.
", + "smithy.api#required": {} + } + }, + "ItemIdentifierAttributeName": { + "target": "com.amazonaws.sagemaker#ItemIdentifierAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the column that represents the set of item identifiers for which you want to\n predict the target value.
", + "smithy.api#required": {} + } + }, + "GroupingAttributeNames": { + "target": "com.amazonaws.sagemaker#GroupingAttributeNames", + "traits": { + "smithy.api#documentation": "A set of columns names that can be grouped with the item identifier column to create a\n composite key for which a target value is predicted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of components that defines the time-series.
" + } + }, + "com.amazonaws.sagemaker#TimeSeriesForecastingJobConfig": { + "type": "structure", + "members": { + "FeatureSpecificationS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "A URL to the Amazon S3 data source containing additional selected features that\n complement the target, itemID, timestamp, and grouped columns set in\n TimeSeriesConfig. When not provided, the AutoML job V2 includes all the\n columns from the original dataset that are not already declared in\n TimeSeriesConfig. If provided, the AutoML job V2 only considers these\n additional columns as a complement to the ones declared in\n TimeSeriesConfig.
You can input FeatureAttributeNames (optional) in JSON format as shown\n below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
Autopilot supports the following data types: numeric, categorical,\n text, and datetime.
These column keys must not include any column set in\n TimeSeriesConfig.
The frequency of predictions in a forecast.
\nValid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H\n (Hour), and min (Minute). For example, 1D indicates every day and\n 15min indicates every 15 minutes. The value of a frequency must not overlap\n with the next larger frequency. For example, you must use a frequency of 1H\n instead of 60min.
The valid values for each frequency are the following:
\nMinute - 1-59
\nHour - 1-23
\nDay - 1-6
\nWeek - 1-4
\nMonth - 1-11
\nYear - 1
\nThe number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4\n of the time-steps in the dataset.
", + "smithy.api#required": {} + } + }, + "ForecastQuantiles": { + "target": "com.amazonaws.sagemaker#ForecastQuantiles", + "traits": { + "smithy.api#documentation": "The quantiles used to train the model for forecasts at a specified quantile. You can\n specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of\n 0.01 or higher. Up to five forecast quantiles can be specified. When\n ForecastQuantiles is not provided, the AutoML job uses the quantiles p10,\n p50, and p90 as default.
The transformations modifying specific attributes of the time-series, such as filling\n strategies for missing values.
" + } + }, + "TimeSeriesConfig": { + "target": "com.amazonaws.sagemaker#TimeSeriesConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The collection of components that defines the time-series.
", + "smithy.api#required": {} + } + }, + "HolidayConfig": { + "target": "com.amazonaws.sagemaker#HolidayConfig", + "traits": { + "smithy.api#documentation": "The collection of holiday featurization attributes used to incorporate national holiday\n information into your forecasting model.
" + } + }, + "CandidateGenerationConfig": { + "target": "com.amazonaws.sagemaker#CandidateGenerationConfig" + } + }, + "traits": { + "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the time-series forecasting\n problem type.
" + } + }, + "com.amazonaws.sagemaker#TimeSeriesForecastingSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "Describes whether time series forecasting is enabled or disabled in the Canvas\n application.
" + } + }, + "AmazonForecastRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default,\n Canvas uses the execution role specified in the UserProfile that launches the\n Canvas application. If an execution role is not specified in the UserProfile,\n Canvas uses the execution role specified in the Domain that owns the\n UserProfile. To allow time series forecasting, this IAM role should have the\n AmazonSageMakerCanvasForecastAccess policy attached and\n forecast.amazonaws.com added in the trust relationship as a service\n principal.
Time series forecast settings for the SageMaker Canvas application.
" + } + }, + "com.amazonaws.sagemaker#TimeSeriesTransformations": { + "type": "structure", + "members": { + "Filling": { + "target": "com.amazonaws.sagemaker#FillingTransformations", + "traits": { + "smithy.api#documentation": "A key value pair defining the filling method for a column, where the key is the column\n name and the value is an object which defines the filling logic. You can specify multiple\n filling methods for a single column.
\nThe supported filling methods and their corresponding options are:
\n\n frontfill: none (Supported only for target\n column)
\n middlefill: zero, value,\n median, mean, min, max\n
\n backfill: zero, value, median,\n mean, min, max\n
\n futurefill: zero, value,\n median, mean, min, max\n
To set a filling method to a specific value, set the fill parameter to the chosen\n filling method value (for example \"backfill\" : \"value\"), and define the\n filling value in an additional parameter prefixed with \"_value\". For example, to set\n backfill to a value of 2, you must include two parameters:\n \"backfill\": \"value\" and \"backfill_value\":\"2\".
A key value pair defining the aggregation method for a column, where the key is the\n column name and the value is the aggregation method.
\nThe supported aggregation methods are sum (default), avg,\n first, min, max.
Aggregation is only supported for the target column.
\nTransformations allowed on the dataset. Supported transformations are\n Filling and Aggregation. Filling specifies how to\n add values to missing values in the dataset. Aggregation defines how to\n aggregate data that does not align with forecast frequency.
The ARN of a listed tracking server.
" + } + }, + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#documentation": "The name of a listed tracking server.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of a listed tracking server.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last modified time of a listed tracking server.
" + } + }, + "TrackingServerStatus": { + "target": "com.amazonaws.sagemaker#TrackingServerStatus", + "traits": { + "smithy.api#documentation": "The creation status of a listed tracking server.
" + } + }, + "IsActive": { + "target": "com.amazonaws.sagemaker#IsTrackingServerActive", + "traits": { + "smithy.api#documentation": "The activity status of a listed tracking server.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "The MLflow version used for a listed tracking server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the tracking server to list.
" + } + }, + "com.amazonaws.sagemaker#TrackingServerSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrackingServerSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrackingServerUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#TrafficDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TrafficPattern": { + "type": "structure", + "members": { + "TrafficType": { + "target": "com.amazonaws.sagemaker#TrafficType", + "traits": { + "smithy.api#documentation": "Defines the traffic patterns. Choose either PHASES or STAIRS.
Defines the phases traffic specification.
" + } + }, + "Stairs": { + "target": "com.amazonaws.sagemaker#Stairs", + "traits": { + "smithy.api#documentation": "Defines the stairs traffic pattern.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the traffic pattern of the load test.
" + } + }, + "com.amazonaws.sagemaker#TrafficRoutingConfig": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#TrafficRoutingConfigType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Traffic routing strategy type.
\n\n ALL_AT_ONCE: Endpoint traffic shifts to the new fleet\n in a single step.\n
\n CANARY: Endpoint traffic shifts to the new fleet\n in two steps. The first step is the canary, which is a small portion of the traffic. The\n second step is the remainder of the traffic.\n
\n LINEAR: Endpoint traffic shifts to the new fleet in\n n steps of a configurable size.\n
The waiting time (in seconds) between incremental steps to turn on traffic on the\n new endpoint fleet.
", + "smithy.api#required": {} + } + }, + "CanarySize": { + "target": "com.amazonaws.sagemaker#CapacitySize", + "traits": { + "smithy.api#documentation": "Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than\n or equal to 50% of the variant's total instance count.
Batch size for each step to turn on traffic on the new endpoint fleet. Value must be\n 10-50% of the variant's total instance count.
Defines the traffic routing strategy during an endpoint deployment to shift traffic from the\n old fleet to the new fleet.
" + } + }, + "com.amazonaws.sagemaker#TrafficRoutingConfigType": { + "type": "enum", + "members": { + "ALL_AT_ONCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_AT_ONCE" + } + }, + "CANARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANARY" + } + }, + "LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINEAR" + } + } + } + }, + "com.amazonaws.sagemaker#TrafficType": { + "type": "enum", + "members": { + "PHASES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHASES" + } + }, + "STAIRS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STAIRS" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingContainerArgument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrainingContainerArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingContainerArgument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrainingContainerEntrypoint": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingContainerEntrypointString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrainingContainerEntrypointString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrainingEnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.sagemaker#TrainingEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrainingEnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#TrainingImageConfig": { + "type": "structure", + "members": { + "TrainingRepositoryAccessMode": { + "target": "com.amazonaws.sagemaker#TrainingRepositoryAccessMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The method that your training job will use to gain access to the images in your\n private Docker registry. For access to an image in a private Docker registry, set to\n Vpc.
An object containing authentication information for a private Docker registry\n containing your training images.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration to use an image from a private Docker registry for a training\n job.
" + } + }, + "com.amazonaws.sagemaker#TrainingInputMode": { + "type": "enum", + "members": { + "PIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pipe" + } + }, + "FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "File" + } + }, + "FASTFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FastFile" + } + } + }, + "traits": { + "smithy.api#documentation": "The training input mode that the algorithm supports. For more information about input\n modes, see Algorithms.
\n\n Pipe mode\n
\nIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly from\n Amazon S3 to the container.
\n File mode\n
\nIf an algorithm supports File mode, SageMaker downloads the training data from\n S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume\n for the training container.
You must provision the ML storage volume with sufficient capacity to accommodate the\n data downloaded from S3. In addition to the training data, the ML storage volume also\n stores the output model. The algorithm container uses the ML storage volume to also\n store intermediate information, if any.
\nFor distributed algorithms, training data is distributed uniformly. Your training\n duration is predictable if the input data objects sizes are approximately the same. SageMaker\n does not split the files any further for model training. If the object sizes are skewed,\n training won't be optimal as the data distribution is also skewed when one host in a\n training cluster is overloaded, thus becoming a bottleneck in training.
\n\n FastFile mode\n
\nIf an algorithm supports FastFile mode, SageMaker streams data directly from\n S3 to the container with no code changes, and provides file system access to the data.\n Users can author their training script to interact with these files as if they were\n stored on disk.
\n FastFile mode works best when the data is read sequentially. Augmented\n manifest files aren't supported. The startup time is lower when there are fewer files in\n the S3 bucket provided.
The name of the training job.
" + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
" + } + }, + "TuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.
" + } + }, + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the labeling job.
" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
" + } + }, + "ModelArtifacts": { + "target": "com.amazonaws.sagemaker#ModelArtifacts", + "traits": { + "smithy.api#documentation": "Information about the Amazon S3 location that is configured for storing model\n artifacts.
" + } + }, + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#documentation": "The status of the\n training\n job.
\nTraining job statuses are:
\n\n InProgress - The training is in progress.
\n Completed - The training job has completed.
\n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.
\n Stopping - The training job is stopping.
\n Stopped - The training job has stopped.
For\n more detailed information, see SecondaryStatus.
Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of\n them:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTrainingStack\n
\n DownloadingTrainingImage\n
If the training job failed, the reason it failed.
" + } + }, + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "Algorithm-specific parameters.
" + } + }, + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmSpecification", + "traits": { + "smithy.api#documentation": "Information about the algorithm used for training, and algorithm metadata.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Identity and Access Management (IAM) role configured for the\n training job.
" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#documentation": "An array of Channel objects that describes each data input\n channel.
Your input must be in the same Amazon Web Services region as your training job.
" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", + "traits": { + "smithy.api#documentation": "The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.
" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#documentation": "Resources, including ML compute instances and ML storage volumes, that are configured\n for model training.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.
A timestamp that indicates when the training job was created.
" + } + }, + "TrainingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time when the training job starts on training instances. You are billed\n for the time interval between this time and the value of TrainingEndTime.\n The start time in CloudWatch Logs might be later than this time. The difference is due to the time\n it takes to download the training data and to the size of the training container.
Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
A timestamp that indicates when the status of the training job was last\n modified.
" + } + }, + "SecondaryStatusTransitions": { + "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", + "traits": { + "smithy.api#documentation": "A history of all of the secondary statuses that the training job has transitioned\n through.
" + } + }, + "FinalMetricDataList": { + "target": "com.amazonaws.sagemaker#FinalMetricDataList", + "traits": { + "smithy.api#documentation": "A list of final metric values that are set when the training job completes. Used only\n if the training job was configured to use metrics.
" + } + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "If the TrainingJob was created with network isolation, the value is set\n to true. If network isolation is enabled, nodes can't communicate beyond\n the VPC they run in.
To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.
When true, enables managed spot training using Amazon EC2 Spot instances to run\n training jobs instead of on-demand instances. For more information, see Managed Spot Training.
" + } + }, + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig" + }, + "TrainingTimeInSeconds": { + "target": "com.amazonaws.sagemaker#TrainingTimeInSeconds", + "traits": { + "smithy.api#documentation": "The training time in seconds.
" + } + }, + "BillableTimeInSeconds": { + "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", + "traits": { + "smithy.api#documentation": "The billable time in seconds.
" + } + }, + "DebugHookConfig": { + "target": "com.amazonaws.sagemaker#DebugHookConfig" + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "DebugRuleConfigurations": { + "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", + "traits": { + "smithy.api#documentation": "Information about the debug rule configuration.
" + } + }, + "TensorBoardOutputConfig": { + "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + }, + "DebugRuleEvaluationStatuses": { + "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", + "traits": { + "smithy.api#documentation": "Information about the evaluation status of the rules for the training job.
" + } + }, + "ProfilerConfig": { + "target": "com.amazonaws.sagemaker#ProfilerConfig" + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container.
" + } + }, + "RetryStrategy": { + "target": "com.amazonaws.sagemaker#RetryStrategy", + "traits": { + "smithy.api#documentation": "The number of times to retry the job when the job fails due to an\n InternalServerError.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a training job.
" + } + }, + "com.amazonaws.sagemaker#TrainingJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/" + } + }, + "com.amazonaws.sagemaker#TrainingJobDefinition": { + "type": "structure", + "members": { + "TrainingInputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", + "traits": { + "smithy.api#documentation": "The hyperparameters used for the training job.
" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An array of Channel objects, each of which specifies an input\n source.
the path to the S3 bucket where you want to store model artifacts. SageMaker creates\n subfolders for the artifacts.
", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The resources, including the ML compute instances and ML storage volumes, to use for\n model training.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job\n termination for 120 seconds. Algorithms can use this 120-second window to save the model\n artifacts.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the input needed to run a training job using the algorithm.
" + } + }, + "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType": { + "type": "enum", + "members": { + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Off" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auto" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#TrainingJobSortByOptions": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "FinalObjectiveMetricValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FinalObjectiveMetricValue" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#TrainingJobStatusCounter": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#TrainingJobStatusCounters": { + "type": "structure", + "members": { + "Completed": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "The number of completed training jobs launched by the hyperparameter tuning\n job.
" + } + }, + "InProgress": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "The number of in-progress training jobs launched by a hyperparameter tuning\n job.
" + } + }, + "RetryableError": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "The number of training jobs that failed, but can be retried. A failed training job can\n be retried only if it failed because an internal service error occurred.
" + } + }, + "NonRetryableError": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "The number of training jobs that failed and can't be retried. A failed training job\n can't be retried if it failed because a client error occurred.
" + } + }, + "Stopped": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", + "traits": { + "smithy.api#documentation": "The number of training jobs launched by a hyperparameter tuning job that were\n manually\n stopped.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The numbers of training jobs launched by a hyperparameter tuning job, categorized by\n status.
" + } + }, + "com.amazonaws.sagemaker#TrainingJobStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job that was run by this step execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for a training job step.
" + } + }, + "com.amazonaws.sagemaker#TrainingJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingJobSummary" + } + }, + "com.amazonaws.sagemaker#TrainingJobSummary": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the training job that you want a summary for.
", + "smithy.api#required": {} + } + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the training job was created.
", + "smithy.api#required": {} + } + }, + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the training job ended. This field is set only if the\n training job has one of the terminal statuses (Completed,\n Failed, or Stopped).
Timestamp when the training job was last modified.
" + } + }, + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the training job.
", + "smithy.api#required": {} + } + }, + "SecondaryStatus": { + "target": "com.amazonaws.sagemaker#SecondaryStatus", + "traits": { + "smithy.api#documentation": "The secondary status of the training job.
" + } + }, + "WarmPoolStatus": { + "target": "com.amazonaws.sagemaker#WarmPoolStatus", + "traits": { + "smithy.api#documentation": "The status of the warm pool associated with the training job.
" + } + }, + "TrainingPlanArn": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan associated with this training job.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Provides summary information about a training job.
" + } + }, + "com.amazonaws.sagemaker#TrainingPlanArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-plan/" + } + }, + "com.amazonaws.sagemaker#TrainingPlanArns": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrainingPlanArn" + } + }, + "com.amazonaws.sagemaker#TrainingPlanDurationHours": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 87600 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanDurationHoursInput": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 87600 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanDurationMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 59 + } + } + }, + "com.amazonaws.sagemaker#TrainingPlanFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#TrainingPlanFilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the filter field (e.g., Status, InstanceType).
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value to filter by for the specified field.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A filter to apply when listing or searching for training plans.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The unique identifier for this training plan offering.
", + "smithy.api#required": {} + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan\n offering.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe requested start time that the user specified when searching for the training plan\n offering.
" + } + }, + "RequestedEndTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The requested end time that the user specified when searching for the training plan\n offering.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this training plan offering.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training plan\n offering.
" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The upfront fee for this training plan offering.
" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.sagemaker#CurrencyCode", + "traits": { + "smithy.api#documentation": "The currency code for the upfront fee (e.g., USD).
" + } + }, + "ReservedCapacityOfferings": { + "target": "com.amazonaws.sagemaker#ReservedCapacityOfferings", + "traits": { + "smithy.api#documentation": "A list of reserved capacity offerings associated with this training plan\n offering.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a training plan offering.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the training plan.
", + "smithy.api#required": {} + } + }, + "TrainingPlanName": { + "target": "com.amazonaws.sagemaker#TrainingPlanName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the training plan.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrainingPlanStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.
A message providing additional information about the current status of the training\n plan.
" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationHours", + "traits": { + "smithy.api#documentation": "The number of whole hours in the total duration for this training plan.
" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", + "traits": { + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training\n plan.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the training plan.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the training plan.
" + } + }, + "UpfrontFee": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The upfront fee for the training plan.
" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.sagemaker#CurrencyCode", + "traits": { + "smithy.api#documentation": "The currency code for the upfront fee (e.g., USD).
" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#documentation": "The total number of instances reserved in this training plan.
" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances currently available for use in this training plan.
" + } + }, + "InUseInstanceCount": { + "target": "com.amazonaws.sagemaker#InUseInstanceCount", + "traits": { + "smithy.api#documentation": "The number of instances currently in use from this training plan.
" + } + }, + "TargetResources": { + "target": "com.amazonaws.sagemaker#SageMakerResourceNames", + "traits": { + "smithy.api#documentation": "The target resources (e.g., training jobs, HyperPod clusters) that can use this training\n plan.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nA list of reserved capacities associated with this training plan, including details such\n as instance types, counts, and availability zones.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the training plan.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access\n credentials to your private Docker registry.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing authentication information for a private Docker registry.
" + } + }, + "com.amazonaws.sagemaker#TrainingRepositoryCredentialsProviderArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:" + } + }, + "com.amazonaws.sagemaker#TrainingSpecification": { + "type": "structure", + "members": { + "TrainingImage": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon ECR registry path of the Docker image that contains the training\n algorithm.
", + "smithy.api#required": {} + } + }, + "TrainingImageDigest": { + "target": "com.amazonaws.sagemaker#ImageDigest", + "traits": { + "smithy.api#documentation": "An MD5 hash of the training algorithm that identifies the Docker image used for\n training.
" + } + }, + "SupportedHyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameterSpecifications", + "traits": { + "smithy.api#documentation": "A list of the HyperParameterSpecification objects, that define the\n supported hyperparameters. This is required if the algorithm supports automatic model\n tuning.>
A list of the instance types that this algorithm can use for training.
", + "smithy.api#required": {} + } + }, + "SupportsDistributedTraining": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the algorithm supports distributed training. If set to false, buyers\n can't request more than one instance during training.
" + } + }, + "MetricDefinitions": { + "target": "com.amazonaws.sagemaker#MetricDefinitionList", + "traits": { + "smithy.api#documentation": "A list of MetricDefinition objects, which are used for parsing metrics\n generated by the algorithm.
A list of ChannelSpecification objects, which specify the input sources\n to be used by the algorithm.
A list of the metrics that the algorithm emits that can be used as the objective\n metric in a hyperparameter tuning job.
" + } + }, + "AdditionalS3DataSource": { + "target": "com.amazonaws.sagemaker#AdditionalS3DataSource", + "traits": { + "smithy.api#documentation": "The additional data source used during the training job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines how the algorithm is used for a training job.
" + } + }, + "com.amazonaws.sagemaker#TrainingTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TransformDataSource": { + "type": "structure", + "members": { + "S3DataSource": { + "target": "com.amazonaws.sagemaker#TransformS3DataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The S3 location of the data source that is associated with a channel.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the location of the channel data.
" + } + }, + "com.amazonaws.sagemaker#TransformEnvironmentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]{0,1023}$" + } + }, + "com.amazonaws.sagemaker#TransformEnvironmentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#TransformEnvironmentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10240 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.sagemaker#TransformInput": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.sagemaker#TransformDataSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes the location of\n the\n channel data, which is, the S3 location of the input data that the\n model can consume.
", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "The multipurpose internet mail extension\n (MIME)\n type of the data. Amazon SageMaker uses the MIME type with each http call to\n transfer data to the transform job.
" + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "If your transform data\n is\n compressed, specify the compression type. Amazon SageMaker automatically\n decompresses the data for the transform job accordingly. The default value is\n None.
The method to use to split the transform job's data files into smaller batches.\n Splitting is necessary when the total size of each object is too large to fit in a\n single request. You can also use data splitting to improve performance by processing\n multiple concurrent mini-batches. The default value for SplitType is\n None, which indicates that input data files are not split, and request\n payloads contain the entire contents of an input object. Set the value of this parameter\n to Line to split records on a newline character boundary.\n SplitType also supports a number of record-oriented binary data\n formats. Currently, the supported record formats are:
RecordIO
\nTFRecord
\nWhen splitting is enabled, the size of a mini-batch depends on the values of the\n BatchStrategy and MaxPayloadInMB parameters. When the\n value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum\n number of records in each request, up to the MaxPayloadInMB limit. If the\n value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual\n records in each request.
Some data formats represent a record as a binary payload wrapped with extra\n padding bytes. When splitting is applied to a binary data format, padding is removed\n if the value of BatchStrategy is set to SingleRecord.\n Padding is not removed if the value of BatchStrategy is set to\n MultiRecord.
For more information about RecordIO, see Create a Dataset Using\n RecordIO in the MXNet documentation. For more information about\n TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
Describes the input source of a transform job and the way the transform job consumes\n it.
" + } + }, + "com.amazonaws.sagemaker#TransformInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TransformInstanceType": { + "type": "enum", + "members": { + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#TransformInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TransformInstanceType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TransformJob": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#documentation": "The name of the transform job.
" + } + }, + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job.
" + } + }, + "TransformJobStatus": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", + "traits": { + "smithy.api#documentation": "The status of the transform job.
\nTransform job statuses are:
\n\n InProgress - The job is in progress.
\n Completed - The job has completed.
\n Failed - The transform job has failed. To see the reason for the failure,\n see the FailureReason field in the response to a\n DescribeTransformJob call.
\n Stopping - The transform job is stopping.
\n Stopped - The transform job has stopped.
If the transform job failed, the reason it failed.
" + } + }, + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model associated with the transform job.
" + } + }, + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "traits": { + "smithy.api#documentation": "The maximum number of parallel requests that can be sent to each instance in a transform\n job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the\n optional execution-parameters to determine the settings for your chosen algorithm. If the\n execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms,\n you don't need to set a value for MaxConcurrentTransforms.
The maximum allowed size of the payload, in MB. A payload is the data portion of a record\n (without metadata). The value in MaxPayloadInMB must be greater than, or equal\n to, the size of a single record. To estimate the size of a record in MB, divide the size of\n your dataset by the number of records. To ensure that the records fit within the maximum\n payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases\n where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding,\n set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in\n algorithms do not support HTTP chunked encoding.
Specifies the number of records to include in a mini-batch for an HTTP inference request.\n A record is a single unit of input data that inference can be made on. For example, a single\n line in a CSV file is a record.
" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.
" + } + }, + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput" + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput" + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig" + }, + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the transform Job was created.
" + } + }, + "TransformStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates when the transform job starts on ML instances. You are billed for the time\n interval between this time and the value of TransformEndTime.
Indicates when the transform job has been completed, or has stopped or failed. You are\n billed for the time interval between this time and the value of\n TransformStartTime.
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
" + } + }, + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
" + } + }, + "DataProcessing": { + "target": "com.amazonaws.sagemaker#DataProcessing" + }, + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of tags associated with the transform job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A batch transform job. For information about SageMaker batch transform, see Use Batch\n Transform.
" + } + }, + "com.amazonaws.sagemaker#TransformJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/" + } + }, + "com.amazonaws.sagemaker#TransformJobDefinition": { + "type": "structure", + "members": { + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "traits": { + "smithy.api#documentation": "The maximum number of parallel requests that can be sent to each instance in a\n transform job. The default value is 1.
" + } + }, + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "traits": { + "smithy.api#documentation": "The maximum payload size allowed, in MB. A payload is the data portion of a record\n (without metadata).
" + } + }, + "BatchStrategy": { + "target": "com.amazonaws.sagemaker#BatchStrategy", + "traits": { + "smithy.api#documentation": "A string that determines the number of records included in a single mini-batch.
\n\n SingleRecord means only one record is used per mini-batch.\n MultiRecord means a mini-batch is set to contain as many records that\n can fit within the MaxPayloadInMB limit.
The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.
" + } + }, + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A description of the input source and the way the transform job consumes it.
", + "smithy.api#required": {} + } + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.
", + "smithy.api#required": {} + } + }, + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Identifies the ML compute instances for the transform job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the input needed to run a transform job using the inference specification\n specified in the algorithm.
" + } + }, + "com.amazonaws.sagemaker#TransformJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#TransformJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#TransformJobStepMetadata": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for a transform job step.
" + } + }, + "com.amazonaws.sagemaker#TransformJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TransformJobSummary" + } + }, + "com.amazonaws.sagemaker#TransformJobSummary": { + "type": "structure", + "members": { + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the transform job.
", + "smithy.api#required": {} + } + }, + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the transform job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A timestamp that shows when the transform Job was created.
", + "smithy.api#required": {} + } + }, + "TransformEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates when the transform\n job\n ends on compute instances. For successful jobs and stopped jobs, this\n is the exact time\n recorded\n after the results are uploaded. For failed jobs, this is when Amazon SageMaker\n detected that the job failed.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates when the transform job was last modified.
" + } + }, + "TransformJobStatus": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the transform job.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the transform job failed,\n the\n reason it failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a\n summary\n of a transform job. Multiple TransformJobSummary objects are returned as a\n list after in response to a ListTransformJobs call.
The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For\n example, s3://bucket-name/key-name-prefix.
For every S3 object used as input for the transform job, batch transform stores the\n transformed data with an .out suffix in a corresponding subfolder in the\n location in the output prefix. For example, for the input data stored at\n s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform\n stores the transformed data at\n s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out.\n Batch transform doesn't upload partially processed objects. For an input S3 object that\n contains multiple records, it creates an .out file only if the transform\n job succeeds on the entire file. When the input contains multiple S3 objects, the batch\n transform job processes the listed S3 objects and uploads only the output for\n successfully processed objects. If any object fails in the transform job batch transform\n marks the job as failed to prompt investigation.
The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http\n call to transfer data from the transform job.
" + } + }, + "AssembleWith": { + "target": "com.amazonaws.sagemaker#AssemblyType", + "traits": { + "smithy.api#documentation": "Defines how to assemble the results of the transform job as a single S3 object. Choose\n a format that is most convenient to you. To concatenate the results in binary format,\n specify None. To add a newline character at the end of every transformed\n record, specify\n Line.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n
\nThe KMS key policy must grant permission to the IAM role that you specify in your\n\tCreateModel\n\t\trequest. For more information, see Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the results of a transform job.
" + } + }, + "com.amazonaws.sagemaker#TransformResources": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TransformInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ML compute instance type for the transform job. If you are using built-in\n algorithms to\n transform\n moderately sized datasets, we recommend using ml.m4.xlarge or\n ml.m5.largeinstance types.
The number of\n ML\n compute instances to use in the transform job. The default value is\n 1, and the maximum is 100. For distributed transform jobs,\n specify a value greater than 1.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume\n attached to the ML compute instance(s) that run the batch transform job.
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\n\n The VolumeKmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
Describes the resources, including ML instance types and ML instance count, to use for\n transform job.
" + } + }, + "com.amazonaws.sagemaker#TransformS3DataSource": { + "type": "structure", + "members": { + "S3DataType": { + "target": "com.amazonaws.sagemaker#S3DataType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "If you choose S3Prefix, S3Uri identifies a key name prefix.\n Amazon SageMaker uses all objects with the specified key name prefix for batch transform.
If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch\n transform.
The following values are compatible: ManifestFile,\n S3Prefix\n
The following value is not compatible: AugmentedManifestFile\n
Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest. For example:
A key name prefix might look like this:\n\t\ts3://bucketname/exampleprefix/.
A manifest might look like this:\n s3://bucketname/example.manifest\n
The manifest is an S3 object which is a JSON file with the following format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
The preceding JSON matches the following S3Uris:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uris in this manifest constitutes the\n input data for the channel for this datasource. The object that each\n S3Uris points to must be readable by the IAM role that Amazon SageMaker\n uses to perform tasks on your behalf.
Describes the S3 data source.
" + } + }, + "com.amazonaws.sagemaker#TransformationAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.sagemaker#Trial": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial.
" + } + }, + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.
The name of the experiment the trial is part of.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#TrialSource" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the trial was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who created the trial.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Who last modified the trial.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "The list of tags that are associated with the trial. You can use Search\n API to search on the tags.
" + } + }, + "TrialComponentSummaries": { + "target": "com.amazonaws.sagemaker#TrialComponentSimpleSummaries", + "traits": { + "smithy.api#documentation": "A list of the components associated with the trial. For each component, a summary of the\n component's properties is included.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of a trial as returned by the Search API.
" + } + }, + "com.amazonaws.sagemaker#TrialArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/" + } + }, + "com.amazonaws.sagemaker#TrialComponent": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial component.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.
The Amazon Resource Name (ARN) of the trial component.
" + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#TrialComponentSource", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) and job type of the source of the component.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus" + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component started.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component ended.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who created the trial component.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "traits": { + "smithy.api#documentation": "The hyperparameters of the component.
" + } + }, + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "The input artifacts of the component.
" + } + }, + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "The output artifacts of the component.
" + } + }, + "Metrics": { + "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", + "traits": { + "smithy.api#documentation": "The metrics for the component.
" + } + }, + "MetadataProperties": { + "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "SourceDetail": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceDetail", + "traits": { + "smithy.api#documentation": "Details of the source of the component.
" + } + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group resource.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "The list of tags that are associated with the component. You can use Search API to search on the tags.
" + } + }, + "Parents": { + "target": "com.amazonaws.sagemaker#Parents", + "traits": { + "smithy.api#documentation": "An array of the parents of the component. A parent is a trial the component is associated\n with and the experiment the trial is part of. A component might not have any parents.
" + } + }, + "RunName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of a trial component as returned by the Search\n API.
" + } + }, + "com.amazonaws.sagemaker#TrialComponentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/" + } + }, + "com.amazonaws.sagemaker#TrialComponentArtifact": { + "type": "structure", + "members": { + "MediaType": { + "target": "com.amazonaws.sagemaker#MediaType", + "traits": { + "smithy.api#documentation": "The media type of the artifact, which indicates the type of data in the artifact file. The\n media type consists of a type and a subtype\n concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The\n type specifies the category of the media. The subtype specifies the kind of data.
" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifactValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location of the artifact.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an input or output artifact of a trial component. You specify\n TrialComponentArtifact as part of the InputArtifacts and\n OutputArtifacts parameters in the CreateTrialComponent\n request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and\n instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
" + } + }, + "com.amazonaws.sagemaker#TrialComponentArtifactValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentArtifacts": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TrialComponentKey128" + }, + "value": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifact" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.sagemaker#TrialComponentKey128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentKey256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentKey320": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 320 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentMetricSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialComponentMetricSummary" + } + }, + "com.amazonaws.sagemaker#TrialComponentMetricSummary": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#documentation": "The name of the metric.
" + } + }, + "SourceArn": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source.
" + } + }, + "TimeStamp": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the metric was last updated.
" + } + }, + "Max": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "The maximum value of the metric.
" + } + }, + "Min": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "The minimum value of the metric.
" + } + }, + "Last": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "The most recent value of the metric.
" + } + }, + "Count": { + "target": "com.amazonaws.sagemaker#OptionalInteger", + "traits": { + "smithy.api#documentation": "The number of samples used to generate the metric.
" + } + }, + "Avg": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "The average value of the metric.
" + } + }, + "StdDev": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "The standard deviation of the metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the metrics of a trial component.
" + } + }, + "com.amazonaws.sagemaker#TrialComponentParameterValue": { + "type": "union", + "members": { + "StringValue": { + "target": "com.amazonaws.sagemaker#StringParameterValue", + "traits": { + "smithy.api#documentation": "The string value of a categorical hyperparameter. If you specify a value for this\n parameter, you can't specify the NumberValue parameter.
The numeric value of a numeric hyperparameter. If you specify a value for this parameter,\n you can't specify the StringValue parameter.
The value of a hyperparameter. Only one of NumberValue or\n StringValue can be specified.
This object is specified in the CreateTrialComponent request.
" + } + }, + "com.amazonaws.sagemaker#TrialComponentParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TrialComponentKey320" + }, + "value": { + "target": "com.amazonaws.sagemaker#TrialComponentParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 300 + } + } + }, + "com.amazonaws.sagemaker#TrialComponentPrimaryStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.sagemaker#TrialComponentSimpleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialComponentSimpleSummary" + } + }, + "com.amazonaws.sagemaker#TrialComponentSimpleSummary": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial component.
" + } + }, + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" + } + }, + "TrialComponentSource": { + "target": "com.amazonaws.sagemaker#TrialComponentSource" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#documentation": "A short summary of a trial component.
" + } + }, + "com.amazonaws.sagemaker#TrialComponentSource": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The source Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#SourceType", + "traits": { + "smithy.api#documentation": "The source job type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) and job type of the source of a trial component.
" + } + }, + "com.amazonaws.sagemaker#TrialComponentSourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:" + } + }, + "com.amazonaws.sagemaker#TrialComponentSourceDetail": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source.
" + } + }, + "TrainingJob": { + "target": "com.amazonaws.sagemaker#TrainingJob", + "traits": { + "smithy.api#documentation": "Information about a training job that's the source of a trial component.
" + } + }, + "ProcessingJob": { + "target": "com.amazonaws.sagemaker#ProcessingJob", + "traits": { + "smithy.api#documentation": "Information about a processing job that's the source of a trial component.
" + } + }, + "TransformJob": { + "target": "com.amazonaws.sagemaker#TransformJob", + "traits": { + "smithy.api#documentation": "Information about a transform job that's the source of a trial component.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about the source of a trial component. Either\n ProcessingJob or TrainingJob is returned.
The status of the trial component.
" + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#TrialComponentStatusMessage", + "traits": { + "smithy.api#documentation": "If the component failed, a message describing why.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of the trial component.
" + } + }, + "com.amazonaws.sagemaker#TrialComponentStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#TrialComponentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialComponentSummary" + } + }, + "com.amazonaws.sagemaker#TrialComponentSummary": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial component.
" + } + }, + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.
The status of the component. States include:
\nInProgress
\nCompleted
\nFailed
\nWhen the component started.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component ended.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who created the trial component.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "Who last modified the component.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the properties of a trial component. To get all the properties, call the\n DescribeTrialComponent API and provide the\n TrialComponentName.
The Amazon Resource Name (ARN) of the source.
", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.sagemaker#SourceType", + "traits": { + "smithy.api#documentation": "The source job type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The source of the trial.
" + } + }, + "com.amazonaws.sagemaker#TrialSourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:" + } + }, + "com.amazonaws.sagemaker#TrialSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrialSummary" + } + }, + "com.amazonaws.sagemaker#TrialSummary": { + "type": "structure", + "members": { + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial.
" + } + }, + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.
When the trial was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the trial was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the properties of a trial. To get the complete set of properties, call the\n DescribeTrial API and provide the TrialName.
\n TtlDuration time unit.
\n TtlDuration time value.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
The value of the objective metric.
" + } + }, + "BestObjectiveNotImproving": { + "target": "com.amazonaws.sagemaker#BestObjectiveNotImproving", + "traits": { + "smithy.api#documentation": "A flag to stop your hyperparameter tuning job if model performance fails to improve as\n evaluated against an objective function.
" + } + }, + "ConvergenceDetected": { + "target": "com.amazonaws.sagemaker#ConvergenceDetected", + "traits": { + "smithy.api#documentation": "A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has\n detected that your model has converged as evaluated against your objective\n function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The job completion criteria.
" + } + }, + "com.amazonaws.sagemaker#TuningJobStepMetaData": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for a tuning step.
" + } + }, + "com.amazonaws.sagemaker#USD": { + "type": "structure", + "members": { + "Dollars": { + "target": "com.amazonaws.sagemaker#Dollars", + "traits": { + "smithy.api#documentation": "The whole number of dollars in the amount.
" + } + }, + "Cents": { + "target": "com.amazonaws.sagemaker#Cents", + "traits": { + "smithy.api#documentation": "The fractional portion, in cents, of the amount.
" + } + }, + "TenthFractionsOfACent": { + "target": "com.amazonaws.sagemaker#TenthFractionsOfACent", + "traits": { + "smithy.api#documentation": "Fractions of a cent, in tenths.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an amount of money in United States dollars.
" + } + }, + "com.amazonaws.sagemaker#UiConfig": { + "type": "structure", + "members": { + "UiTemplateS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket location of the UI template, or worker task template. This is the\n template used to render the worker UI and tools for labeling job tasks. For more\n information about the contents of a UI template, see Creating Your Custom\n Labeling Task Template.
" + } + }, + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#documentation": "The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.
\nUse this parameter when you are creating a labeling job for named entity recognition,\n 3D point cloud and video frame labeling jobs. Use your labeling job task type to select\n one of the following ARNs and use it with this parameter when you create a labeling job.\n Replace aws-region with the Amazon Web Services Region you are creating your labeling job\n in. For example, replace aws-region with us-west-1 if you\n create a labeling job in US West (N. California).
\n Named Entity Recognition\n
\nUse the following HumanTaskUiArn for named entity recognition labeling\n jobs:
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition\n
\n 3D Point Cloud HumanTaskUiArns\n
\nUse this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n
Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n
Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n
\n Video Frame HumanTaskUiArns\n
\nUse this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.
\n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n
Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n
Provided configuration information for the worker UI for a labeling job. Provide\n either HumanTaskUiArn or UiTemplateS3Uri.
For named entity recognition, 3D point cloud and video frame labeling jobs, use\n HumanTaskUiArn.
For all other Ground Truth built-in task types and custom task types, use\n UiTemplateS3Uri to specify the location of a worker task template in\n Amazon S3.
The content of the Liquid template for the worker user interface.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Liquid template for the worker user interface.
" + } + }, + "com.amazonaws.sagemaker#UiTemplateInfo": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.sagemaker#TemplateUrl", + "traits": { + "smithy.api#documentation": "The URL for the user interface template.
" + } + }, + "ContentSha256": { + "target": "com.amazonaws.sagemaker#TemplateContentSha256", + "traits": { + "smithy.api#documentation": "The SHA-256 digest of the contents of the template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container for user interface template information.
" + } + }, + "com.amazonaws.sagemaker#Uid": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 10000, + "max": 4000000 + } + } + }, + "com.amazonaws.sagemaker#UpdateAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateActionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates an action.
" + } + }, + "com.amazonaws.sagemaker#UpdateActionRequest": { + "type": "structure", + "members": { + "ActionName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the action to update.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "The new description for the action.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ActionStatus", + "traits": { + "smithy.api#documentation": "The new status for the action.
" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "The new list of properties. Overwrites the current property list.
" + } + }, + "PropertiesToRemove": { + "target": "com.amazonaws.sagemaker#ListLineageEntityParameterKey", + "traits": { + "smithy.api#documentation": "A list of properties to remove.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateActionResponse": { + "type": "structure", + "members": { + "ActionArn": { + "target": "com.amazonaws.sagemaker#ActionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateAppImageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateAppImageConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateAppImageConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the properties of an AppImageConfig.
" + } + }, + "com.amazonaws.sagemaker#UpdateAppImageConfigRequest": { + "type": "structure", + "members": { + "AppImageConfigName": { + "target": "com.amazonaws.sagemaker#AppImageConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the AppImageConfig to update.
", + "smithy.api#required": {} + } + }, + "KernelGatewayImageConfig": { + "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", + "traits": { + "smithy.api#documentation": "The new KernelGateway app to run on the image.
" + } + }, + "JupyterLabAppImageConfig": { + "target": "com.amazonaws.sagemaker#JupyterLabAppImageConfig", + "traits": { + "smithy.api#documentation": "The JupyterLab app running on the image.
" + } + }, + "CodeEditorAppImageConfig": { + "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", + "traits": { + "smithy.api#documentation": "The Code Editor app running on the image.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateAppImageConfigResponse": { + "type": "structure", + "members": { + "AppImageConfigArn": { + "target": "com.amazonaws.sagemaker#AppImageConfigArn", + "traits": { + "smithy.api#documentation": "The ARN for the AppImageConfig.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateArtifact": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateArtifactRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateArtifactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates an artifact.
" + } + }, + "com.amazonaws.sagemaker#UpdateArtifactRequest": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact to update.
", + "smithy.api#required": {} + } + }, + "ArtifactName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The new name for the artifact.
" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#ArtifactProperties", + "traits": { + "smithy.api#documentation": "The new list of properties. Overwrites the current property list.
" + } + }, + "PropertiesToRemove": { + "target": "com.amazonaws.sagemaker#ListLineageEntityParameterKey", + "traits": { + "smithy.api#documentation": "A list of properties to remove.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateArtifactResponse": { + "type": "structure", + "members": { + "ArtifactArn": { + "target": "com.amazonaws.sagemaker#ArtifactArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the artifact.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates a SageMaker HyperPod cluster.
" + } + }, + "com.amazonaws.sagemaker#UpdateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specify the name of the SageMaker HyperPod cluster you want to update.
", + "smithy.api#required": {} + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specify the instance groups to update.
", + "smithy.api#required": {} + } + }, + "NodeRecovery": { + "target": "com.amazonaws.sagemaker#ClusterNodeRecovery", + "traits": { + "smithy.api#documentation": "The node recovery mode to be applied to the SageMaker HyperPod cluster.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSchedulerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Update the cluster policy configuration.
" + } + }, + "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigRequest": { + "type": "structure", + "members": { + "ClusterSchedulerConfigId": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the cluster policy.
", + "smithy.api#required": {} + } + }, + "TargetVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Target version.
", + "smithy.api#required": {} + } + }, + "SchedulerConfig": { + "target": "com.amazonaws.sagemaker#SchedulerConfig", + "traits": { + "smithy.api#documentation": "Cluster policy configuration.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "Description of the cluster policy.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSchedulerConfigResponse": { + "type": "structure", + "members": { + "ClusterSchedulerConfigArn": { + "target": "com.amazonaws.sagemaker#ClusterSchedulerConfigArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the cluster policy.
", + "smithy.api#required": {} + } + }, + "ClusterSchedulerConfigVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Version of the cluster policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSoftware": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to\n use this API, see Update the SageMaker HyperPod platform software of a cluster.
\nThe UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster\n uptime and availability. Plan accordingly to mitigate potential disruptions to your\n workloads.
Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security\n patching.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSoftwareResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateCodeRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateCodeRepositoryInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateCodeRepositoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified Git repository with the specified values.
" + } + }, + "com.amazonaws.sagemaker#UpdateCodeRepositoryInput": { + "type": "structure", + "members": { + "CodeRepositoryName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Git repository to update.
", + "smithy.api#required": {} + } + }, + "GitConfig": { + "target": "com.amazonaws.sagemaker#GitConfigForUpdate", + "traits": { + "smithy.api#documentation": "The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:
\n {\"username\": UserName, \"password\":\n Password}\n
The ARN of the Git repository.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateComputeQuota": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateComputeQuotaRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateComputeQuotaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Update the compute allocation definition.
" + } + }, + "com.amazonaws.sagemaker#UpdateComputeQuotaRequest": { + "type": "structure", + "members": { + "ComputeQuotaId": { + "target": "com.amazonaws.sagemaker#ComputeQuotaId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "TargetVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Target version.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaConfig": { + "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", + "traits": { + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" + } + }, + "ComputeQuotaTarget": { + "target": "com.amazonaws.sagemaker#ComputeQuotaTarget", + "traits": { + "smithy.api#documentation": "The target entity to allocate compute resources to.
" + } + }, + "ActivationState": { + "target": "com.amazonaws.sagemaker#ActivationState", + "traits": { + "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
Description of the compute allocation definition.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateComputeQuotaResponse": { + "type": "structure", + "members": { + "ComputeQuotaArn": { + "target": "com.amazonaws.sagemaker#ComputeQuotaArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ARN of the compute allocation definition.
", + "smithy.api#required": {} + } + }, + "ComputeQuotaVersion": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Version of the compute allocation definition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateContext": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateContextRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateContextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates a context.
" + } + }, + "com.amazonaws.sagemaker#UpdateContextRequest": { + "type": "structure", + "members": { + "ContextName": { + "target": "com.amazonaws.sagemaker#ContextName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the context to update.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "The new description for the context.
" + } + }, + "Properties": { + "target": "com.amazonaws.sagemaker#LineageEntityParameters", + "traits": { + "smithy.api#documentation": "The new list of properties. Overwrites the current property list.
" + } + }, + "PropertiesToRemove": { + "target": "com.amazonaws.sagemaker#ListLineageEntityParameterKey", + "traits": { + "smithy.api#documentation": "A list of properties to remove.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateContextResponse": { + "type": "structure", + "members": { + "ContextArn": { + "target": "com.amazonaws.sagemaker#ContextArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the context.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateDeviceFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateDeviceFleetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "Updates a fleet of devices.
" + } + }, + "com.amazonaws.sagemaker#UpdateDeviceFleetRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the device.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#DeviceFleetDescription", + "traits": { + "smithy.api#documentation": "Description of the fleet.
" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#EdgeOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Output configuration for storing sample data collected by the fleet.
", + "smithy.api#required": {} + } + }, + "EnableIotRoleAlias": { + "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", + "traits": { + "smithy.api#documentation": "Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".
\nFor example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateDevicesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Updates one or more devices in a fleet.
" + } + }, + "com.amazonaws.sagemaker#UpdateDevicesRequest": { + "type": "structure", + "members": { + "DeviceFleetName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet the devices belong to.
", + "smithy.api#required": {} + } + }, + "Devices": { + "target": "com.amazonaws.sagemaker#Devices", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "List of devices to register with Edge Manager agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateDomainRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the default settings for new user profiles in the domain.
" + } + }, + "com.amazonaws.sagemaker#UpdateDomainRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the domain to be updated.
", + "smithy.api#required": {} + } + }, + "DefaultUserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "A collection of settings.
" + } + }, + "DomainSettingsForUpdate": { + "target": "com.amazonaws.sagemaker#DomainSettingsForUpdate", + "traits": { + "smithy.api#documentation": "A collection of DomainSettings configuration values to update.
The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.
The default settings for shared spaces that users create in the domain.
" + } + }, + "SubnetIds": { + "target": "com.amazonaws.sagemaker#Subnets", + "traits": { + "smithy.api#documentation": "The VPC subnets that Studio uses for communication.
\nIf removing subnets, ensure there are no apps in the InService,\n Pending, or Deleting state.
Specifies the VPC used for non-EFS traffic.
\n\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.
\n VpcOnly - All Studio traffic is through the specified VPC and\n subnets.
This configuration can only be modified if there are no apps in the\n InService, Pending, or Deleting state. The\n configuration cannot be updated if\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already\n set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided as part of the same request.
Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.
The Amazon Resource Name (ARN) of the domain.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateEndpointInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateEndpointOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Deploys the EndpointConfig specified in the request to a new fleet of\n instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint\n configuration and then deletes the old instances using the previous\n EndpointConfig (there is no availability loss). For more information\n about how to control the update and traffic shifting process, see Update\n models in production.
When SageMaker receives the request, it sets the endpoint status to Updating.\n After updating the endpoint, it sets the status to InService. To check the\n status of an endpoint, use the DescribeEndpoint API.\n \n
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.
The name of the endpoint whose configuration you want to update.
", + "smithy.api#required": {} + } + }, + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the new endpoint configuration.
", + "smithy.api#required": {} + } + }, + "RetainAllVariantProperties": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To\n retain the variant properties of an endpoint when updating it, set\n RetainAllVariantProperties to true. To use the variant\n properties specified in a new EndpointConfig call when updating an\n endpoint, set RetainAllVariantProperties to false. The default\n is false.
When you are updating endpoint resources with RetainAllVariantProperties,\n whose value is set to true, ExcludeRetainedVariantProperties\n specifies the list of type VariantProperty\n to override with the values provided by EndpointConfig. If you don't\n specify a value for ExcludeRetainedVariantProperties, no variant properties\n are overridden.
The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.
" + } + }, + "RetainDeploymentConfig": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to reuse the last deployment configuration. The default value is\n false (the configuration is not reused).
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateEndpointOutput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacities": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Updates variant weight of one or more variants associated with an existing\n endpoint, or capacity of one variant associated with an existing endpoint. When it\n receives the request, SageMaker sets the endpoint status to Updating. After\n updating the endpoint, it sets the status to InService. To check the status\n of an endpoint, use the DescribeEndpoint API.
The name of an existing SageMaker endpoint.
", + "smithy.api#required": {} + } + }, + "DesiredWeightsAndCapacities": { + "target": "com.amazonaws.sagemaker#DesiredWeightAndCapacityList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that provides new capacity and weight values for a variant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesOutput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Adds, updates, or removes the description of an experiment. Updates the display name of an\n experiment.
" + } + }, + "com.amazonaws.sagemaker#UpdateExperimentRequest": { + "type": "structure", + "members": { + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the experiment to update.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the experiment as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, ExperimentName is displayed.
The description of the experiment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateExperimentResponse": { + "type": "structure", + "members": { + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateFeatureGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateFeatureGroupRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateFeatureGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the feature group by either adding features or updating the online store\n configuration. Use one of the following request parameters at a time while using the\n UpdateFeatureGroup API.
You can add features for your feature group using the FeatureAdditions\n request parameter. Features cannot be removed from a feature group.
You can update the online store configuration by using the\n OnlineStoreConfig request parameter. If a TtlDuration is\n specified, the default TtlDuration applies for all records added to the\n feature group after the feature group is updated. If a record level\n TtlDuration exists from using the PutRecord API, the record\n level TtlDuration applies to that record instead of the default\n TtlDuration. To remove the default TtlDuration from an\n existing feature group, use the UpdateFeatureGroup API and set the\n TtlDuration\n Unit and Value to null.
The name or Amazon Resource Name (ARN) of the feature group that you're updating.
", + "smithy.api#required": {} + } + }, + "FeatureAdditions": { + "target": "com.amazonaws.sagemaker#FeatureAdditions", + "traits": { + "smithy.api#documentation": "Updates the feature group. Updating a feature group is an asynchronous operation. When\n you get an HTTP 200 response, you've made a valid request. It takes some time after you've\n made a valid request for Feature Store to update the feature group.
" + } + }, + "OnlineStoreConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreConfigUpdate", + "traits": { + "smithy.api#documentation": "Updates the feature group online store configuration.
" + } + }, + "ThroughputConfig": { + "target": "com.amazonaws.sagemaker#ThroughputConfigUpdate" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateFeatureGroupResponse": { + "type": "structure", + "members": { + "FeatureGroupArn": { + "target": "com.amazonaws.sagemaker#FeatureGroupArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the feature group that you're updating.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateFeatureMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateFeatureMetadataRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the description and parameters of the feature group.
" + } + }, + "com.amazonaws.sagemaker#UpdateFeatureMetadataRequest": { + "type": "structure", + "members": { + "FeatureGroupName": { + "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the feature group containing the feature that\n you're updating.
", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.sagemaker#FeatureName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the feature that you're updating.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#FeatureDescription", + "traits": { + "smithy.api#documentation": "A description that you can write to better describe the feature.
" + } + }, + "ParameterAdditions": { + "target": "com.amazonaws.sagemaker#FeatureParameterAdditions", + "traits": { + "smithy.api#documentation": "A list of key-value pairs that you can add to better describe the feature.
" + } + }, + "ParameterRemovals": { + "target": "com.amazonaws.sagemaker#FeatureParameterRemovals", + "traits": { + "smithy.api#documentation": "A list of parameter keys that you can specify to remove parameters that describe your\n feature.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateHubRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateHubResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Update a hub.
" + } + }, + "com.amazonaws.sagemaker#UpdateHubRequest": { + "type": "structure", + "members": { + "HubName": { + "target": "com.amazonaws.sagemaker#HubNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the hub to update.
", + "smithy.api#required": {} + } + }, + "HubDescription": { + "target": "com.amazonaws.sagemaker#HubDescription", + "traits": { + "smithy.api#documentation": "A description of the updated hub.
" + } + }, + "HubDisplayName": { + "target": "com.amazonaws.sagemaker#HubDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the hub.
" + } + }, + "HubSearchKeywords": { + "target": "com.amazonaws.sagemaker#HubSearchKeywordList", + "traits": { + "smithy.api#documentation": "The searchable keywords for the hub.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateHubResponse": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.sagemaker#HubArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated hub.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateImageRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the properties of a SageMaker AI image. To change the image's tags, use the\n AddTags and DeleteTags APIs.
" + } + }, + "com.amazonaws.sagemaker#UpdateImageRequest": { + "type": "structure", + "members": { + "DeleteProperties": { + "target": "com.amazonaws.sagemaker#ImageDeletePropertyList", + "traits": { + "smithy.api#documentation": "A list of properties to delete. Only the Description and\n DisplayName properties can be deleted.
The new description for the image.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ImageDisplayName", + "traits": { + "smithy.api#documentation": "The new display name for the image.
" + } + }, + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image to update.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateImageResponse": { + "type": "structure", + "members": { + "ImageArn": { + "target": "com.amazonaws.sagemaker#ImageArn", + "traits": { + "smithy.api#documentation": "The ARN of the image.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateImageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateImageVersionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateImageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the properties of a SageMaker AI image version.
" + } + }, + "com.amazonaws.sagemaker#UpdateImageVersionRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image.
", + "smithy.api#required": {} + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "The alias of the image version.
" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "The version of the image.
" + } + }, + "AliasesToAdd": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "A list of aliases to add.
" + } + }, + "AliasesToDelete": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "A list of aliases to delete.
" + } + }, + "VendorGuidance": { + "target": "com.amazonaws.sagemaker#VendorGuidance", + "traits": { + "smithy.api#documentation": "The availability of the image version specified by the maintainer.
\n\n NOT_PROVIDED: The maintainers did not provide a status for image version stability.
\n STABLE: The image version is stable.
\n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
\n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
\n\n TRAINING: The image version is compatible with SageMaker AI training jobs.
\n INFERENCE: The image version is compatible with SageMaker AI inference jobs.
\n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
The machine learning framework vended in the image version.
" + } + }, + "ProgrammingLang": { + "target": "com.amazonaws.sagemaker#ProgrammingLang", + "traits": { + "smithy.api#documentation": "The supported programming language and its version.
" + } + }, + "Processor": { + "target": "com.amazonaws.sagemaker#Processor", + "traits": { + "smithy.api#documentation": "Indicates CPU or GPU compatibility.
\n\n CPU: The image version is compatible with CPU.
\n GPU: The image version is compatible with GPU.
Indicates Horovod compatibility.
" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.sagemaker#ReleaseNotes", + "traits": { + "smithy.api#documentation": "The maintainer description of the image version.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateImageVersionResponse": { + "type": "structure", + "members": { + "ImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the image version.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Updates an inference component.
" + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference component.
", + "smithy.api#required": {} + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", + "traits": { + "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.
" + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
" + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the inference component to update.
", + "smithy.api#required": {} + } + }, + "DesiredRuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference component.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceExperimentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "\n Updates an inference experiment that you created. The status of the inference experiment has to be either\n Created, Running. For more information on the status of an inference experiment,\n see DescribeInferenceExperiment.\n
The name of the inference experiment to be updated.
", + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", + "traits": { + "smithy.api#documentation": "\n The duration for which the inference experiment will run. If the status of the inference experiment is\n Created, then you can update both the start and end dates. If the status of the inference\n experiment is Running, then you can update only the end date.\n
The description of the inference experiment.
" + } + }, + "ModelVariants": { + "target": "com.amazonaws.sagemaker#ModelVariantConfigList", + "traits": { + "smithy.api#documentation": "\n An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure\n configuration you want to update.\n
The Amazon S3 location and configuration for storing inference request and response data.
" + } + }, + "ShadowModeConfig": { + "target": "com.amazonaws.sagemaker#ShadowModeConfig", + "traits": { + "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n
The ARN of the updated inference experiment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates properties of an existing MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the MLflow Tracking Server to update.
", + "smithy.api#required": {} + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow\n Tracking Server.
" + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "The new size for the MLflow Tracking Server.
" + } + }, + "AutomaticModelRegistration": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. \n To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. \n If not specified, AutomaticModelRegistration defaults to False\n
The new weekly maintenance window start day and time to update. The maintenance window day and time should be \n in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the updated MLflow Tracking Server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateModelCard": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateModelCardRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateModelCardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Update an Amazon SageMaker Model Card.
\nYou cannot update both model card content and model card status in a single call.
\nThe name or Amazon Resource Name (ARN) of the model card to update.
", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#documentation": "The updated model card content. Content must be in model card JSON schema and provided as a string.
\nWhen updating model card content, be sure to include the full content and not just updated content.
" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The Amazon Resource Name (ARN) of the updated model card.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateModelPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateModelPackageInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateModelPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a versioned model.
" + } + }, + "com.amazonaws.sagemaker#UpdateModelPackageInput": { + "type": "structure", + "members": { + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model package.
", + "smithy.api#required": {} + } + }, + "ModelApprovalStatus": { + "target": "com.amazonaws.sagemaker#ModelApprovalStatus", + "traits": { + "smithy.api#documentation": "The approval status of the model.
" + } + }, + "ApprovalDescription": { + "target": "com.amazonaws.sagemaker#ApprovalDescription", + "traits": { + "smithy.api#documentation": "A description for the approval status of the model.
" + } + }, + "CustomerMetadataProperties": { + "target": "com.amazonaws.sagemaker#CustomerMetadataMap", + "traits": { + "smithy.api#documentation": "The metadata properties associated with the model package versions.
" + } + }, + "CustomerMetadataPropertiesToRemove": { + "target": "com.amazonaws.sagemaker#CustomerMetadataKeyList", + "traits": { + "smithy.api#documentation": "The metadata properties associated with the model package versions to remove.
" + } + }, + "AdditionalInferenceSpecificationsToAdd": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "An array of additional Inference Specification objects to be added to the \n existing array additional Inference Specification. Total number of additional \n Inference Specifications can not exceed 15. Each additional Inference Specification \n specifies artifacts based on this model package that can be used on inference endpoints. \n Generally used with SageMaker Neo to store the compiled artifacts.
" + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "Specifies details about inference jobs that you can run with models based on this model\n package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nThe URI of the source for the model package.
" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard", + "traits": { + "smithy.api#documentation": "The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
\n A structure describing the current state of the model in its life cycle.\n
" + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "\n A unique token that guarantees that the call to this API is idempotent.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateModelPackageOutput": { + "type": "structure", + "members": { + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringAlert": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateMonitoringAlertRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateMonitoringAlertResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Update the parameters of a model monitor alert.
" + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringAlertRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of a monitoring schedule.
", + "smithy.api#required": {} + } + }, + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of a monitoring alert.
", + "smithy.api#required": {} + } + }, + "DatapointsToAlert": { + "target": "com.amazonaws.sagemaker#MonitoringDatapointsToAlert", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Within EvaluationPeriod, how many execution failures will raise an\n alert.
The number of most recent monitoring executions to consider when evaluating alert\n status.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringAlertResponse": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", + "smithy.api#required": {} + } + }, + "MonitoringAlertName": { + "target": "com.amazonaws.sagemaker#MonitoringAlertName", + "traits": { + "smithy.api#documentation": "The name of a monitoring alert.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateMonitoringScheduleRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateMonitoringScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates a previously created schedule.
" + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringScheduleRequest": { + "type": "structure", + "members": { + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateMonitoringScheduleResponse": { + "type": "structure", + "members": { + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitoring schedule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Updates a notebook instance. NotebookInstance updates include upgrading or\n downgrading the ML compute instance used for your notebook instance to accommodate\n changes in your workload requirements.
" + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceInput": { + "type": "structure", + "members": { + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the notebook instance to update.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", + "traits": { + "smithy.api#documentation": "The Amazon ML compute instance type.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to\n access the notebook instance. For more information, see SageMaker AI Roles.
\nTo be able to pass this role to SageMaker AI, the caller of this API must\n have the iam:PassRole permission.
The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.
" + } + }, + "DisassociateLifecycleConfig": { + "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceLifecycleConfig", + "traits": { + "smithy.api#documentation": "Set to true to remove the notebook instance lifecycle configuration\n currently associated with the notebook instance. This operation is idempotent. If you\n specify a lifecycle configuration that is not associated with the notebook instance when\n you call this method, it does not throw an error.
The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't\n determine the amount of available free space on the volume. Because of this, you can\n increase the volume size when you update a notebook instance, but you can't decrease the\n volume size. If you want to decrease the size of the ML storage volume in use, create a\n new notebook instance with the desired size.
" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "traits": { + "smithy.api#documentation": "An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", + "traits": { + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of the EI instance types to associate with\n this notebook instance.
" + } + }, + "DisassociateAcceleratorTypes": { + "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes", + "traits": { + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of the EI instance types to remove from this notebook\n instance.
" + } + }, + "DisassociateDefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository", + "traits": { + "smithy.api#documentation": "The name or URL of the default Git repository to remove from this notebook instance.\n This operation is idempotent. If you specify a Git repository that is not associated\n with the notebook instance when you call this method, it does not throw an error.
" + } + }, + "DisassociateAdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories", + "traits": { + "smithy.api#documentation": "A list of names or URLs of the default Git repositories to remove from this notebook\n instance. This operation is idempotent. If you specify a Git repository that is not\n associated with the notebook instance when you call this method, it does not throw an\n error.
" + } + }, + "RootAccess": { + "target": "com.amazonaws.sagemaker#RootAccess", + "traits": { + "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.
If you set this to Disabled, users don't have root access on the\n notebook instance, but lifecycle configuration scripts still run with root\n permissions.
Information on the IMDS configuration of the notebook instance
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
" + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigInput": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the lifecycle configuration.
", + "smithy.api#required": {} + } + }, + "OnCreate": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "The shell script that runs only once, when you create a notebook instance. The shell\n script must be a base64-encoded string.
" + } + }, + "OnStart": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance. The shell script must be a base64-encoded\n string.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceLifecycleConfigOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateNotebookInstanceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdatePartnerApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdatePartnerAppRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdatePartnerAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates all of the SageMaker Partner AI Apps in an account.
" + } + }, + "com.amazonaws.sagemaker#UpdatePartnerAppRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App to update.
", + "smithy.api#required": {} + } + }, + "MaintenanceConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppMaintenanceConfig", + "traits": { + "smithy.api#documentation": "Maintenance configuration settings for the SageMaker Partner AI App.
" + } + }, + "Tier": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
" + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.sagemaker#PartnerAppConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for the SageMaker Partner AI App.
" + } + }, + "EnableIamSessionBasedIdentity": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
A unique token that guarantees that the call to this API is idempotent.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdatePartnerAppResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.sagemaker#PartnerAppArn", + "traits": { + "smithy.api#documentation": "The ARN of the SageMaker Partner AI App that was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdatePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdatePipelineRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdatePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates a pipeline.
" + } + }, + "com.amazonaws.sagemaker#UpdatePipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdatePipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdatePipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates a pipeline execution.
" + } + }, + "com.amazonaws.sagemaker#UpdatePipelineExecutionRequest": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline execution.
", + "smithy.api#required": {} + } + }, + "PipelineExecutionDescription": { + "target": "com.amazonaws.sagemaker#PipelineExecutionDescription", + "traits": { + "smithy.api#documentation": "The description of the pipeline execution.
" + } + }, + "PipelineExecutionDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineExecutionName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline execution.
" + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdatePipelineExecutionResponse": { + "type": "structure", + "members": { + "PipelineExecutionArn": { + "target": "com.amazonaws.sagemaker#PipelineExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated pipeline execution.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdatePipelineRequest": { + "type": "structure", + "members": { + "PipelineName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the pipeline to update.
", + "smithy.api#required": {} + } + }, + "PipelineDisplayName": { + "target": "com.amazonaws.sagemaker#PipelineName", + "traits": { + "smithy.api#documentation": "The display name of the pipeline.
" + } + }, + "PipelineDefinition": { + "target": "com.amazonaws.sagemaker#PipelineDefinition", + "traits": { + "smithy.api#documentation": "The JSON pipeline definition.
" + } + }, + "PipelineDefinitionS3Location": { + "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", + "traits": { + "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.
" + } + }, + "PipelineDescription": { + "target": "com.amazonaws.sagemaker#PipelineDescription", + "traits": { + "smithy.api#documentation": "The description of the pipeline.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that the pipeline uses to execute.
" + } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "If specified, it applies to all executions of this pipeline by default.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdatePipelineResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.sagemaker#PipelineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated pipeline.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateProjectInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateProjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a machine learning (ML) project that is created from a template that \n sets up an ML pipeline from training to deploying an approved model.
\nYou must not update a project that is in use. If you update the\n ServiceCatalogProvisioningUpdateDetails of a project that is active\n or being created, or updated, you may lose resources already created by the\n project.
The name of the project.
", + "smithy.api#required": {} + } + }, + "ProjectDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "The description for the project.
" + } + }, + "ServiceCatalogProvisioningUpdateDetails": { + "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningUpdateDetails", + "traits": { + "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. \n The provisioning artifact ID will default to the latest provisioning artifact \n ID of the product, if you don't provide the provisioning artifact ID. For more \n information, see What is Amazon Web Services Service Catalog.\n
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your \n Amazon Web Services resources in different ways, for example, by purpose, owner, or \n environment. For more information, see Tagging Amazon Web Services Resources.\n In addition, the project must have tag update constraints set in order to include this \n parameter in the request. For more information, see Amazon Web Services Service \n Catalog Tag Update Constraints.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateProjectOutput": { + "type": "structure", + "members": { + "ProjectArn": { + "target": "com.amazonaws.sagemaker#ProjectArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateSpace": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateSpaceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateSpaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the settings of a space.
\nYou can't edit the app type of a space in the SpaceSettings.
The ID of the associated domain.
", + "smithy.api#required": {} + } + }, + "SpaceName": { + "target": "com.amazonaws.sagemaker#SpaceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the space.
", + "smithy.api#required": {} + } + }, + "SpaceSettings": { + "target": "com.amazonaws.sagemaker#SpaceSettings", + "traits": { + "smithy.api#documentation": "A collection of space settings.
" + } + }, + "SpaceDisplayName": { + "target": "com.amazonaws.sagemaker#NonEmptyString64", + "traits": { + "smithy.api#documentation": "The name of the space that appears in the Amazon SageMaker Studio UI.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateSpaceResponse": { + "type": "structure", + "members": { + "SpaceArn": { + "target": "com.amazonaws.sagemaker#SpaceArn", + "traits": { + "smithy.api#documentation": "The space's Amazon Resource Name (ARN).
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateTrainingJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateTrainingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Update a model training job to request a new Debugger profiling configuration or to\n change warm pool retention length.
" + } + }, + "com.amazonaws.sagemaker#UpdateTrainingJobRequest": { + "type": "structure", + "members": { + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of a training job to update the Debugger profiling configuration.
", + "smithy.api#required": {} + } + }, + "ProfilerConfig": { + "target": "com.amazonaws.sagemaker#ProfilerConfigForUpdate", + "traits": { + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and\n storage paths.
" + } + }, + "ProfilerRuleConfigurations": { + "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", + "traits": { + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.
" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfigForUpdate", + "traits": { + "smithy.api#documentation": "The training job ResourceConfig to update warm pool retention\n length.
Configuration for remote debugging while the training job is running. You can update\n the remote debugging configuration when the SecondaryStatus of the job is\n Downloading or Training.To learn more about the remote\n debugging functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
The Amazon Resource Name (ARN) of the training job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrial": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateTrialRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateTrialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the display name of a trial.
" + } + }, + "com.amazonaws.sagemaker#UpdateTrialComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateTrialComponentRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateTrialComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates one or more properties of a trial component.
" + } + }, + "com.amazonaws.sagemaker#UpdateTrialComponentRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the component to update.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.
The new status of the component.
" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component started.
" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "When the component ended.
" + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "traits": { + "smithy.api#documentation": "Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
" + } + }, + "ParametersToRemove": { + "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", + "traits": { + "smithy.api#documentation": "The hyperparameters to remove from the component.
" + } + }, + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
" + } + }, + "InputArtifactsToRemove": { + "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", + "traits": { + "smithy.api#documentation": "The input artifacts to remove from the component.
" + } + }, + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
" + } + }, + "OutputArtifactsToRemove": { + "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", + "traits": { + "smithy.api#documentation": "The output artifacts to remove from the component.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrialComponentResponse": { + "type": "structure", + "members": { + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trial component.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateTrialRequest": { + "type": "structure", + "members": { + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the trial to update.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.
The Amazon Resource Name (ARN) of the trial.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateUserProfileRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateUserProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates a user profile.
" + } + }, + "com.amazonaws.sagemaker#UpdateUserProfileRequest": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The domain ID.
", + "smithy.api#required": {} + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The user profile name.
", + "smithy.api#required": {} + } + }, + "UserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "A collection of settings.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateUserProfileResponse": { + "type": "structure", + "members": { + "UserProfileArn": { + "target": "com.amazonaws.sagemaker#UserProfileArn", + "traits": { + "smithy.api#documentation": "The user profile Amazon Resource Name (ARN).
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateWorkforce": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateWorkforceRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateWorkforceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], + "traits": { + "smithy.api#documentation": "Use this operation to update your workforce. You can use this operation to \n require that workers use specific IP addresses to work on tasks\n and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.
\nThe worker portal is now supported in VPC and public internet.
\n Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. \n You specify allowed IP addresses by creating a list of up to ten CIDRs.\n By default, a workforce isn't restricted to specific IP addresses. If you specify a\n range of IP addresses, workers who attempt to access tasks using any IP address outside\n the specified range are denied and get a Not Found error message on\n the worker portal.
To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"10.0.0.0/16\".
Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.
\nUse OidcConfig to update the configuration of a workforce created using\n your own OIDC IdP.
You can only update your OIDC IdP configuration when there are no work teams\n associated with your workforce. You can delete work teams using the DeleteWorkteam operation.
\nAfter restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you\n can view details about your update workforce using the DescribeWorkforce\n operation.
\nThis operation only applies to private workforces.
\nThe name of the private workforce that you want to update. You can find your workforce\n name by using the ListWorkforces operation.
", + "smithy.api#required": {} + } + }, + "SourceIpConfig": { + "target": "com.amazonaws.sagemaker#SourceIpConfig", + "traits": { + "smithy.api#documentation": "A list of one to ten worker IP address ranges (CIDRs) that can be used to\n access tasks assigned to this workforce.
\nMaximum: Ten CIDR values
" + } + }, + "OidcConfig": { + "target": "com.amazonaws.sagemaker#OidcConfig", + "traits": { + "smithy.api#documentation": "Use this parameter to update your OIDC Identity Provider (IdP) \n configuration for a workforce made using your own IdP.
" + } + }, + "WorkforceVpcConfig": { + "target": "com.amazonaws.sagemaker#WorkforceVpcConfigRequest", + "traits": { + "smithy.api#documentation": "Use this parameter to update your VPC configuration for a workforce.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateWorkforceResponse": { + "type": "structure", + "members": { + "Workforce": { + "target": "com.amazonaws.sagemaker#Workforce", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A single private workforce. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateWorkteam": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateWorkteamRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateWorkteamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing work team with new member definitions or description.
" + } + }, + "com.amazonaws.sagemaker#UpdateWorkteamRequest": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the work team to update.
", + "smithy.api#required": {} + } + }, + "MemberDefinitions": { + "target": "com.amazonaws.sagemaker#MemberDefinitions", + "traits": { + "smithy.api#documentation": "A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition. You should not provide input\n for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want\n to include in your private work team in OidcMemberDefinition by listing\n those groups in Groups. Be aware that user groups that are already in the\n work team must also be listed in Groups when you make this request to\n remain on the work team. If you do not include these user groups, they will no longer be\n associated with the work team you update.
An updated description for the work team.
" + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.sagemaker#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "Configures SNS topic notifications for available or expiring work items
" + } + }, + "WorkerAccessConfiguration": { + "target": "com.amazonaws.sagemaker#WorkerAccessConfiguration", + "traits": { + "smithy.api#documentation": "Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateWorkteamResponse": { + "type": "structure", + "members": { + "Workteam": { + "target": "com.amazonaws.sagemaker#Workteam", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Workteam object that describes the updated work team.
The Amazon Resource Name (ARN) of the user's profile.
" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The name of the user's profile.
" + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The domain associated with the user.
" + } + }, + "IamIdentity": { + "target": "com.amazonaws.sagemaker#IamIdentity", + "traits": { + "smithy.api#documentation": "The IAM Identity details associated with the user. These details are\n associated with model package groups, model packages, and project entities only.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial\n component, lineage group, project, or model card.
" + } + }, + "com.amazonaws.sagemaker#UserProfileArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/" + } + }, + "com.amazonaws.sagemaker#UserProfileDetails": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "The domain ID.
" + } + }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "The user profile name.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#UserProfileStatus", + "traits": { + "smithy.api#documentation": "The status.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "The creation time.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "The last modified time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The user profile details.
" + } + }, + "com.amazonaws.sagemaker#UserProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#UserProfileDetails" + } + }, + "com.amazonaws.sagemaker#UserProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#UserProfileSortKey": { + "type": "enum", + "members": { + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "LastModifiedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTime" + } + } + } + }, + "com.amazonaws.sagemaker#UserProfileStatus": { + "type": "enum", + "members": { + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "InService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "Update_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Update_Failed" + } + }, + "Delete_Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delete_Failed" + } + } + } + }, + "com.amazonaws.sagemaker#UserSettings": { + "type": "structure", + "members": { + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The execution role for the user.
\nSageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for\n communication.
\nOptional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.
Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for\n the domain.
Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the\n maximum number shown.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + } + }, + "SharingSettings": { + "target": "com.amazonaws.sagemaker#SharingSettings", + "traits": { + "smithy.api#documentation": "Specifies options for sharing Amazon SageMaker AI Studio notebooks.
" + } + }, + "JupyterServerAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterServerAppSettings", + "traits": { + "smithy.api#documentation": "The Jupyter server's app settings.
" + } + }, + "KernelGatewayAppSettings": { + "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings", + "traits": { + "smithy.api#documentation": "The kernel gateway app settings.
" + } + }, + "TensorBoardAppSettings": { + "target": "com.amazonaws.sagemaker#TensorBoardAppSettings", + "traits": { + "smithy.api#documentation": "The TensorBoard app settings.
" + } + }, + "RStudioServerProAppSettings": { + "target": "com.amazonaws.sagemaker#RStudioServerProAppSettings", + "traits": { + "smithy.api#documentation": "A collection of settings that configure user interaction with the\n RStudioServerPro app.
A collection of settings that configure the RSessionGateway app.
The Canvas app settings.
\nSageMaker applies these settings only to private spaces that SageMaker creates for the Canvas\n app.
" + } + }, + "CodeEditorAppSettings": { + "target": "com.amazonaws.sagemaker#CodeEditorAppSettings", + "traits": { + "smithy.api#documentation": "The Code Editor application settings.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + } + }, + "JupyterLabAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterLabAppSettings", + "traits": { + "smithy.api#documentation": "The settings for the JupyterLab application.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + } + }, + "SpaceStorageSettings": { + "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings", + "traits": { + "smithy.api#documentation": "The storage settings for a space.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + } + }, + "DefaultLandingUri": { + "target": "com.amazonaws.sagemaker#LandingUri", + "traits": { + "smithy.api#documentation": "The default experience that the user is directed to when accessing the domain. The\n supported values are:
\n\n studio::: Indicates that Studio is the default experience. This value can\n only be passed if StudioWebPortal is set to ENABLED.
\n app:JupyterServer:: Indicates that Studio Classic is the default\n experience.
Whether the user can access Studio. If this value is set to DISABLED, the\n user cannot access Studio, even if that is the default experience for the domain.
Details about the POSIX identity that is used for file system operations.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + } + }, + "CustomFileSystemConfigs": { + "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", + "traits": { + "smithy.api#documentation": "The settings for assigning a custom file system to a user profile. Permitted users can\n access this file system in Amazon SageMaker AI Studio.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + } + }, + "StudioWebPortalSettings": { + "target": "com.amazonaws.sagemaker#StudioWebPortalSettings", + "traits": { + "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.
" + } + }, + "AutoMountHomeEFS": { + "target": "com.amazonaws.sagemaker#AutoMountHomeEFS", + "traits": { + "smithy.api#documentation": "Indicates whether auto-mounting of an EFS volume is supported for the user profile. The\n DefaultAsDomain value is only supported for user profiles. Do not use the\n DefaultAsDomain value when setting this parameter for a domain.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of settings that apply to users in a domain. These settings are specified\n when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.
\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.
The type of variant property. The supported values are:
\n\n DesiredInstanceCount: Overrides the existing variant instance\n counts using the InitialInstanceCount values in the\n ProductionVariants of CreateEndpointConfig.
\n DesiredWeight: Overrides the existing variant weights using the\n InitialVariantWeight values in the\n ProductionVariants of CreateEndpointConfig.
\n DataCaptureConfig: (Not currently supported.)
Specifies a production variant property type for an Endpoint.
\nIf you are updating an endpoint with the RetainAllVariantProperties\n option of UpdateEndpointInput set to true, the\n VariantProperty objects listed in the\n ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the\n endpoint.
The number of elements in your vector.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for your vector collection type.
" + } + }, + "com.amazonaws.sagemaker#VendorGuidance": { + "type": "enum", + "members": { + "NOT_PROVIDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_PROVIDED" + } + }, + "STABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STABLE" + } + }, + "TO_BE_ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO_BE_ARCHIVED" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + } + } + }, + "com.amazonaws.sagemaker#VersionAliasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ImageVersionAliasPattern" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#VersionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#VersionedArnOrName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 176 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The Amazon Resource Name (ARN) of the lineage entity resource." + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#String40", + "traits": { + "smithy.api#documentation": "The type of the lineage entity resource. For example: DataSet, Model, Endpoint, \n etc...
The type of resource of the lineage entity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A lineage entity connected to the starting entity(ies).
" + } + }, + "com.amazonaws.sagemaker#Vertices": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Vertex" + } + }, + "com.amazonaws.sagemaker#VisibilityConditions": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#VisibilityConditionsKey", + "traits": { + "smithy.api#documentation": "The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags..
The value for the tag that you're using to filter the search results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. \n If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.
" + } + }, + "com.amazonaws.sagemaker#VisibilityConditionsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.sagemaker#VisibilityConditionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#VisibilityConditions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#VisibilityConditionsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.sagemaker#VolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#VpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#VpcSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your training job or\n model. For information about the availability of specific instance types, see Supported\n Instance Types and Availability Zones.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources\n have access to. You can control access to and from your resources by configuring a VPC.\n For more information, see Give SageMaker Access to\n Resources in your Amazon VPC.
" + } + }, + "com.amazonaws.sagemaker#VpcId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#VpcOnlyTrustedAccounts": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.sagemaker#VpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#WaitIntervalInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.sagemaker#WarmPoolResourceStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminated" + } + }, + "REUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Reused" + } + }, + "INUSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InUse" + } + } + } + }, + "com.amazonaws.sagemaker#WarmPoolStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#WarmPoolResourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the warm pool.
\n\n InUse: The warm pool is in use for the training job.
\n Available: The warm pool is available to reuse for a matching\n training job.
\n Reused: The warm pool moved to a matching training job for\n reuse.
\n Terminated: The warm pool is no longer available. Warm pools are\n unavailable if they are terminated by a user, terminated for a patch update, or\n terminated for exceeding the specified\n KeepAlivePeriodInSeconds.
The billable time in seconds used by the warm pool. Billable time refers to the\n absolute wall-clock time.
\nMultiply ResourceRetainedBillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run warm pool training. The formula is as follows:\n ResourceRetainedBillableTimeInSeconds * InstanceCount.
The name of the matching training job that reused the warm pool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Status and billing information about the warm pool.
" + } + }, + "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + }, + "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$" + } + }, + "com.amazonaws.sagemaker#WeeklyScheduleTimeFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + }, + "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$" + } + }, + "com.amazonaws.sagemaker#WorkerAccessConfiguration": { + "type": "structure", + "members": { + "S3Presign": { + "target": "com.amazonaws.sagemaker#S3Presign", + "traits": { + "smithy.api#documentation": "Defines any Amazon S3 resource constraints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
" + } + }, + "com.amazonaws.sagemaker#Workforce": { + "type": "structure", + "members": { + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the private workforce.
", + "smithy.api#required": {} + } + }, + "WorkforceArn": { + "target": "com.amazonaws.sagemaker#WorkforceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the private workforce.
", + "smithy.api#required": {} + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent date that UpdateWorkforce was used to\n successfully add one or more IP address ranges (CIDRs) to a private workforce's\n allow list.
" + } + }, + "SourceIpConfig": { + "target": "com.amazonaws.sagemaker#SourceIpConfig", + "traits": { + "smithy.api#documentation": "A list of one to ten IP address ranges (CIDRs) to be added to the\n workforce allow list. By default, a workforce isn't restricted to specific IP addresses.
" + } + }, + "SubDomain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The subdomain for your OIDC Identity Provider.
" + } + }, + "CognitoConfig": { + "target": "com.amazonaws.sagemaker#CognitoConfig", + "traits": { + "smithy.api#documentation": "The configuration of an Amazon Cognito workforce. \n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.
" + } + }, + "OidcConfig": { + "target": "com.amazonaws.sagemaker#OidcConfigForResponse", + "traits": { + "smithy.api#documentation": "The configuration of an OIDC Identity Provider (IdP) private workforce.
" + } + }, + "CreateDate": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the workforce is created.
" + } + }, + "WorkforceVpcConfig": { + "target": "com.amazonaws.sagemaker#WorkforceVpcConfigResponse", + "traits": { + "smithy.api#documentation": "The configuration of a VPC workforce.
" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#WorkforceStatus", + "traits": { + "smithy.api#documentation": "The status of your workforce.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#WorkforceFailureReason", + "traits": { + "smithy.api#documentation": "The reason your workforce failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
" + } + }, + "com.amazonaws.sagemaker#WorkforceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/" + } + }, + "com.amazonaws.sagemaker#WorkforceFailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#WorkforceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$" + } + }, + "com.amazonaws.sagemaker#WorkforceSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^sg-[0-9a-z]*$" + } + }, + "com.amazonaws.sagemaker#WorkforceSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#WorkforceStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + } + } + }, + "com.amazonaws.sagemaker#WorkforceSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^subnet-[0-9a-z]*$" + } + }, + "com.amazonaws.sagemaker#WorkforceSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#WorkforceSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.sagemaker#WorkforceVpcConfigRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.sagemaker#WorkforceVpcId", + "traits": { + "smithy.api#documentation": "The ID of the VPC that the workforce uses for communication.
" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupIds", + "traits": { + "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
The ID of the subnets in the VPC that you want to connect.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The VPC object you use to create or update a workforce.
" + } + }, + "com.amazonaws.sagemaker#WorkforceVpcConfigResponse": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.sagemaker#WorkforceVpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the VPC that the workforce uses for communication.
", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.sagemaker#WorkforceSubnets", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the subnets in the VPC that you want to connect.
", + "smithy.api#required": {} + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.sagemaker#WorkforceVpcEndpointId", + "traits": { + "smithy.api#documentation": "The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your workforce to connect to.
" + } + }, + "com.amazonaws.sagemaker#WorkforceVpcEndpointId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^vpce-[0-9a-z]*$" + } + }, + "com.amazonaws.sagemaker#WorkforceVpcId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^vpc-[0-9a-z]*$" + } + }, + "com.amazonaws.sagemaker#Workforces": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Workforce" + } + }, + "com.amazonaws.sagemaker#WorkspaceSettings": { + "type": "structure", + "members": { + "S3ArtifactPath": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts\n existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users\n must log out and log back in to apply the new location.
" + } + }, + "S3KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The workspace settings for the SageMaker Canvas application.
" + } + }, + "com.amazonaws.sagemaker#Workteam": { + "type": "structure", + "members": { + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the work team.
", + "smithy.api#required": {} + } + }, + "MemberDefinitions": { + "target": "com.amazonaws.sagemaker#MemberDefinitions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition.
The Amazon Resource Name (ARN) that identifies the work team.
", + "smithy.api#required": {} + } + }, + "WorkforceArn": { + "target": "com.amazonaws.sagemaker#WorkforceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workforce.
" + } + }, + "ProductListingIds": { + "target": "com.amazonaws.sagemaker#ProductListings", + "traits": { + "smithy.api#documentation": "The Amazon Marketplace identifier for a vendor's work team.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A description of the work team.
", + "smithy.api#required": {} + } + }, + "SubDomain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The URI of the labeling job's user interface. Workers open this URI to start labeling\n your data objects.
" + } + }, + "CreateDate": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the work team was created (timestamp).
" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the work team was last updated (timestamp).
" + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.sagemaker#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "Configures SNS notifications of available or expiring work items for work\n teams.
" + } + }, + "WorkerAccessConfiguration": { + "target": "com.amazonaws.sagemaker#WorkerAccessConfiguration", + "traits": { + "smithy.api#documentation": "Describes any access constraints that have been defined for Amazon S3 resources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details about a labeling work team.
" + } + }, + "com.amazonaws.sagemaker#WorkteamArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/" + } + }, + "com.amazonaws.sagemaker#WorkteamName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#Workteams": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Workteam" + } } - }, - "traits": { - "smithy.api#documentation": "Provides details about a labeling work team.
" - } - }, - "com.amazonaws.sagemaker#WorkteamArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/" - } - }, - "com.amazonaws.sagemaker#WorkteamName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" - } - }, - "com.amazonaws.sagemaker#Workteams": { - "type": "list", - "member": { - "target": "com.amazonaws.sagemaker#Workteam" - } } - } }