{
"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.batch#AWSBatchV20160810": {
"type": "service",
"version": "2016-08-10",
"operations": [
{
"target": "com.amazonaws.batch#CancelJob"
},
{
"target": "com.amazonaws.batch#CancelJobs"
},
{
"target": "com.amazonaws.batch#CreateComputeEnvironment"
},
{
"target": "com.amazonaws.batch#CreateConsumableResource"
},
{
"target": "com.amazonaws.batch#CreateJobQueue"
},
{
"target": "com.amazonaws.batch#CreateQuotaShare"
},
{
"target": "com.amazonaws.batch#CreateSchedulingPolicy"
},
{
"target": "com.amazonaws.batch#CreateServiceEnvironment"
},
{
"target": "com.amazonaws.batch#DeleteComputeEnvironment"
},
{
"target": "com.amazonaws.batch#DeleteConsumableResource"
},
{
"target": "com.amazonaws.batch#DeleteJobQueue"
},
{
"target": "com.amazonaws.batch#DeleteQuotaShare"
},
{
"target": "com.amazonaws.batch#DeleteSchedulingPolicy"
},
{
"target": "com.amazonaws.batch#DeleteServiceEnvironment"
},
{
"target": "com.amazonaws.batch#DeregisterJobDefinition"
},
{
"target": "com.amazonaws.batch#DescribeComputeEnvironments"
},
{
"target": "com.amazonaws.batch#DescribeConsumableResource"
},
{
"target": "com.amazonaws.batch#DescribeJobDefinitions"
},
{
"target": "com.amazonaws.batch#DescribeJobQueues"
},
{
"target": "com.amazonaws.batch#DescribeJobs"
},
{
"target": "com.amazonaws.batch#DescribeQuotaShare"
},
{
"target": "com.amazonaws.batch#DescribeSchedulingPolicies"
},
{
"target": "com.amazonaws.batch#DescribeServiceEnvironments"
},
{
"target": "com.amazonaws.batch#DescribeServiceJob"
},
{
"target": "com.amazonaws.batch#GetJobQueueSnapshot"
},
{
"target": "com.amazonaws.batch#ListConsumableResources"
},
{
"target": "com.amazonaws.batch#ListJobs"
},
{
"target": "com.amazonaws.batch#ListJobsByConsumableResource"
},
{
"target": "com.amazonaws.batch#ListQuotaShares"
},
{
"target": "com.amazonaws.batch#ListSchedulingPolicies"
},
{
"target": "com.amazonaws.batch#ListServiceJobs"
},
{
"target": "com.amazonaws.batch#ListTagsForResource"
},
{
"target": "com.amazonaws.batch#RegisterJobDefinition"
},
{
"target": "com.amazonaws.batch#SubmitJob"
},
{
"target": "com.amazonaws.batch#SubmitServiceJob"
},
{
"target": "com.amazonaws.batch#TagResource"
},
{
"target": "com.amazonaws.batch#TerminateJob"
},
{
"target": "com.amazonaws.batch#TerminateJobs"
},
{
"target": "com.amazonaws.batch#TerminateServiceJob"
},
{
"target": "com.amazonaws.batch#TerminateServiceJobs"
},
{
"target": "com.amazonaws.batch#UntagResource"
},
{
"target": "com.amazonaws.batch#UpdateComputeEnvironment"
},
{
"target": "com.amazonaws.batch#UpdateConsumableResource"
},
{
"target": "com.amazonaws.batch#UpdateJobQueue"
},
{
"target": "com.amazonaws.batch#UpdateQuotaShare"
},
{
"target": "com.amazonaws.batch#UpdateSchedulingPolicy"
},
{
"target": "com.amazonaws.batch#UpdateServiceEnvironment"
},
{
"target": "com.amazonaws.batch#UpdateServiceJob"
}
],
"traits": {
"aws.api#service": {
"sdkId": "Batch",
"arnNamespace": "batch",
"cloudFormationName": "Batch",
"cloudTrailEventSource": "batch.amazonaws.com",
"endpointPrefix": "batch"
},
"aws.auth#sigv4": {
"name": "batch"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "
Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for\n developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of\n the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure.\n At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently\n provision resources, and work toward eliminating capacity constraints, reducing your overall compute costs, and\n delivering results more quickly.
\nAs a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically\n provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific\n workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus\n on analyzing results and solving your specific problems instead.
", "smithy.api#title": "AWS Batch", "smithy.api#xmlNamespace": { "uri": "http://batch.amazonaws.com/doc/2016-08-10/" }, "smithy.rules#endpointBdd": { "version": "1.1", "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" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://batch-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://fips.batch.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://batch.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://batch-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://batch.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://batch.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 15, "nodes": "/////wAAAAH/////AAAAAAAAAA4AAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEMAAAABQX14QoF9eELAAAABAAAAAwAAAAJAAAABgAAAAoF9eEJAAAABwX14QYAAAALAAAACAX14QcF9eEIAAAABQAAAA0F9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAPAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "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://batch-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": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] } ], "endpoint": { "url": "https://fips.batch.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://batch.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://batch-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://batch.{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://batch.{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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://batch.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://fips.batch.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://batch.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://fips.batch.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://batch.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://fips.batch.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://batch.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://fips.batch.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://batch-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://batch.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://batch.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://batch.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://batch-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://batch-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://batch.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://batch.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://batch.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://batch.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://batch.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://batch-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://batch.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 enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://batch-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 disabled", "expect": { "endpoint": { "url": "https://batch.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://batch-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 disabled", "expect": { "endpoint": { "url": "https://batch.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.batch#ArrayJobDependency": { "type": "enum", "members": { "N_TO_N": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "N_TO_N" } }, "SEQUENTIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEQUENTIAL" } } } }, "com.amazonaws.batch#ArrayJobStatusSummary": { "type": "map", "key": { "target": "com.amazonaws.batch#String" }, "value": { "target": "com.amazonaws.batch#Integer" } }, "com.amazonaws.batch#ArrayProperties": { "type": "structure", "members": { "size": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The size of the array job.
" } } }, "traits": { "smithy.api#documentation": "An object that represents an Batch array job.
" } }, "com.amazonaws.batch#ArrayPropertiesDetail": { "type": "structure", "members": { "statusSummary": { "target": "com.amazonaws.batch#ArrayJobStatusSummary", "traits": { "smithy.api#documentation": "A summary of the number of array job children in each available job status. This parameter\n is returned for parent array jobs.
" } }, "statusSummaryLastUpdatedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the statusSummary was last updated.
The size of the array job. This parameter is returned for parent array jobs.
" } }, "index": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The job index within the array that's associated with this job. This parameter is returned\n for array job children.
" } } }, "traits": { "smithy.api#documentation": "An object that represents the array properties of a job.
" } }, "com.amazonaws.batch#ArrayPropertiesSummary": { "type": "structure", "members": { "size": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The size of the array job. This parameter is returned for parent array jobs.
" } }, "index": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The job index within the array that's associated with this job. This parameter is returned\n for children of array jobs.
" } }, "statusSummary": { "target": "com.amazonaws.batch#ArrayJobStatusSummary", "traits": { "smithy.api#documentation": "A summary of the number of array job children in each available job status. This parameter\n is returned for parent array jobs.
" } }, "statusSummaryLastUpdatedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the statusSummary was last updated.
An object that represents the array properties of a job.
" } }, "com.amazonaws.batch#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.batch#AttemptContainerDetail": { "type": "structure", "members": { "containerInstanceArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
" } }, "taskArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container\n attempt receives a task ARN when they reach the STARTING status.
The exit code for the job attempt. A non-zero exit code is considered failed.
" } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a\n running or stopped container.
" } }, "logStreamName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the CloudWatch Logs log stream that's associated with the container. The log\n group for Batch jobs is /aws/batch/job. Each container attempt receives a log\n stream name when they reach the RUNNING status.
The network interfaces that are associated with the job attempt.
" } } }, "traits": { "smithy.api#documentation": "An object that represents the details of a container that's part of a job attempt.
" } }, "com.amazonaws.batch#AttemptDetail": { "type": "structure", "members": { "container": { "target": "com.amazonaws.batch#AttemptContainerDetail", "traits": { "smithy.api#documentation": "The details for the container in this job attempt.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt\n transitioned from the STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt\n transitioned from the RUNNING state to a terminal state, such as\n SUCCEEDED or FAILED).
A short, human-readable string to provide additional details for the current status of the\n job attempt.
" } }, "taskProperties": { "target": "com.amazonaws.batch#ListAttemptEcsTaskDetails", "traits": { "smithy.api#documentation": "The properties for a task definition that describes the container and volume definitions of\n an Amazon ECS task.
" } } }, "traits": { "smithy.api#documentation": "An object that represents a job attempt.
" } }, "com.amazonaws.batch#AttemptDetails": { "type": "list", "member": { "target": "com.amazonaws.batch#AttemptDetail" } }, "com.amazonaws.batch#AttemptEcsTaskDetails": { "type": "structure", "members": { "containerInstanceArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container instance that hosts the task.
" } }, "taskArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The ARN of the Amazon ECS task.
" } }, "containers": { "target": "com.amazonaws.batch#ListAttemptTaskContainerDetails", "traits": { "smithy.api#documentation": "A list of containers that are included in the taskProperties list.
An object that represents the details of a task.
" } }, "com.amazonaws.batch#AttemptTaskContainerDetails": { "type": "structure", "members": { "exitCode": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The exit code for the container\u2019s attempt. A non-zero exit code is considered failed.
" } }, "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of a container.
" } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short (255 max characters) string that's easy to understand and provides additional details for a\n running or stopped container.
" } }, "logStreamName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log\n group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name\n when they reach the RUNNING status.
The network interfaces that are associated with the job attempt.
" } } }, "traits": { "smithy.api#documentation": "An object that represents the details of a container that's part of a job attempt.
" } }, "com.amazonaws.batch#Boolean": { "type": "boolean" }, "com.amazonaws.batch#CEState": { "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.batch#CEStatus": { "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" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "VALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALID" } }, "INVALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID" } } } }, "com.amazonaws.batch#CEType": { "type": "enum", "members": { "MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGED" } }, "UNMANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNMANAGED" } } } }, "com.amazonaws.batch#CRAllocationStrategy": { "type": "enum", "members": { "BEST_FIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEST_FIT" } }, "BEST_FIT_PROGRESSIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEST_FIT_PROGRESSIVE" } }, "BEST_FIT_PROGRESSIVE_ORDERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEST_FIT_PROGRESSIVE_ORDERED" } }, "SPOT_CAPACITY_OPTIMIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPOT_CAPACITY_OPTIMIZED" } }, "SPOT_PRICE_CAPACITY_OPTIMIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPOT_PRICE_CAPACITY_OPTIMIZED" } }, "SPOT_CAPACITY_OPTIMIZED_PRIORITIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPOT_CAPACITY_OPTIMIZED_PRIORITIZED" } } } }, "com.amazonaws.batch#CRType": { "type": "enum", "members": { "EC2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EC2" } }, "SPOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPOT" } }, "FARGATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FARGATE" } }, "FARGATE_SPOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FARGATE_SPOT" } }, "ECS_MANAGED_INSTANCES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ECS_MANAGED_INSTANCES" } } } }, "com.amazonaws.batch#CRUpdateAllocationStrategy": { "type": "enum", "members": { "BEST_FIT_PROGRESSIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEST_FIT_PROGRESSIVE" } }, "BEST_FIT_PROGRESSIVE_ORDERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEST_FIT_PROGRESSIVE_ORDERED" } }, "SPOT_CAPACITY_OPTIMIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPOT_CAPACITY_OPTIMIZED" } }, "SPOT_PRICE_CAPACITY_OPTIMIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPOT_PRICE_CAPACITY_OPTIMIZED" } }, "SPOT_CAPACITY_OPTIMIZED_PRIORITIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPOT_CAPACITY_OPTIMIZED_PRIORITIZED" } } } }, "com.amazonaws.batch#CancelJob": { "type": "operation", "input": { "target": "com.amazonaws.batch#CancelJobRequest" }, "output": { "target": "com.amazonaws.batch#CancelJobResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Cancels a job in an Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE state are cancelled and the job status is updated to FAILED.
A PENDING job is cancelled after all dependency jobs are completed.\n Therefore, it might take longer than expected to cancel a job in PENDING\n status.
When you try to cancel an array parent job in PENDING, Batch attempts to\n cancel all child jobs. The array parent job is cancelled when all child jobs are\n completed.
Jobs that progressed to the STARTING or\n RUNNING state aren't cancelled. However, the API operation still succeeds, even\n if no job is cancelled. These jobs must be terminated with the TerminateJob or\n TerminateJobs operation.
The Batch job ID of the job to cancel.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A message to attach to the job that explains the reason for cancelling it. This message is\n returned by future DescribeJobs operations on the job. It is also\n recorded in the Batch activity logs.
\nThis parameter has a limit of 1024 characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for CancelJob.
Cancels up to 50 jobs in an Batch job queue. This is a bulk version of CancelJob. Jobs that are in a\n SUBMITTED, PENDING, or RUNNABLE state are cancelled\n and the job status is updated to FAILED.
A PENDING job is cancelled after all dependency jobs are completed.\n Therefore, it might take longer than expected to cancel a job in PENDING\n status.
When you try to cancel an array parent job in PENDING, Batch attempts to\n cancel all child jobs. The array parent job is cancelled when all child jobs are\n completed.
Jobs that progressed to the STARTING or RUNNING state aren't\n cancelled. These jobs must be terminated with the TerminateJob or\n TerminateJobs operation.
Batch reports the result for each job individually in the response. Jobs that\n were processed successfully are reported in the successful list. Jobs that\n encountered errors are reported in the errors list. The response returns an\n HTTP status code of 200 even when some jobs encountered errors, so check the\n errors list. Jobs that can't be found are treated as successfully\n processed.
This operation requires batch:CancelJob permission for each job in the\n request. There is no separate batch:CancelJobs IAM action. If a caller's IAM\n policy grants batch:CancelJob, they can use both the singular\n CancelJob and bulk CancelJobs operations.
The Batch job ID of the job that couldn't be cancelled.
", "smithy.api#required": {} } }, "code": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "An error code that identifies the reason the job couldn't be cancelled. Valid values are:
\n\n ValidationException \u2013 A job identifier in the request is malformed or isn't valid.
\n ClientException \u2013 The request failed because of a client error.
\n ThrottlingException \u2013 The request was throttled. Retry the request.
\n ServerException \u2013 An internal error occurred. Retry the request.
\n AccessDenied \u2013 The caller isn't authorized to perform the action on the specified job.
A message that describes the reason the job couldn't be cancelled.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that contains the details of a job that couldn't be cancelled by a\n CancelJobs operation.
An array of up to 50 Batch job IDs of the jobs to cancel.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A message to attach to the job that explains the reason for cancelling it. This message is\n returned by future DescribeJobs operations on the job. It is also\n recorded in the Batch activity logs.
\nThis parameter has a limit of 1024 characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the jobs to cancel and the reason for the cancellation.
", "smithy.api#input": {} } }, "com.amazonaws.batch#CancelJobsResponse": { "type": "structure", "members": { "successful": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of the job IDs whose cancellation request was accepted.
", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.batch#CancelJobsErrorDetailList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of CancelJobsErrorDetail items, one for each job that couldn't be\n cancelled. Each item includes the job ID along with a code and message that describe why the\n job wasn't cancelled.
The result of a CancelJobs request, including the jobs whose cancellation\n request was accepted and the errors for jobs that couldn't be cancelled.
The maximum capacity available for the service environment. For a quota management enabled service environment, this value represents\n the maximum quantity of a particular resource type (specified by capacityUnit) that can be allocated to service jobs.\n For other service environments, this value represents the maximum quantity of all resources that can be allocated to service jobs.
For example, if maxCapacity=50 and capacityUnit=NUM_INSTANCES, you can run up to 50 instances concurrently.\n If you run 5 SageMaker Training jobs that each use 10 instances, a subsequent job requiring 10 instances waits in the queue until\n capacity is available. In a quota management enabled service environment with capacityUnit=ml.m5.large, only\n ml.m5.large instances count against this limit, and jobs requiring other instance types wait until a matching capacity limit is configured.
The unit of measure for the capacity limit, which defines how maxCapacity is interpreted. For SAGEMAKER_TRAINING jobs in a quota management\n enabled service environment, specify the instance type\n (for example, ml.m5.large). Otherwise, use NUM_INSTANCES.
Defines the type and maximum quantity of resources that can be allocated to service jobs in a service environment.
" } }, "com.amazonaws.batch#CapacityLimits": { "type": "list", "member": { "target": "com.amazonaws.batch#CapacityLimit" } }, "com.amazonaws.batch#CapacityReservationRequest": { "type": "structure", "members": { "reservationGroupArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the capacity reservation group to target.
" } }, "reservationPreference": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The capacity reservation preference. Valid values:
\n\n RESERVATIONS_ONLY \u2014 Use only capacity reservations.
\n RESERVATIONS_FIRST \u2014 Prefer capacity reservations but fall back to\n On-Demand if unavailable.
\n RESERVATIONS_EXCLUDED \u2014 Do not use capacity reservations.
The capacity reservation configuration for Amazon ECS Managed Instances. Use this to target\n On-Demand Capacity Reservations or Reserved Instances.
" } }, "com.amazonaws.batch#ClientException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.batch#String" } }, "traits": { "smithy.api#documentation": "These errors are usually caused by a client action. One example cause is using an action or resource on behalf\n of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier\n that's not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.batch#ClientRequestToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.batch#ComputeEnvironmentDetail": { "type": "structure", "members": { "computeEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "computeEnvironmentArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the compute environment.
", "smithy.api#required": {} } }, "unmanagedvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The maximum number of VCPUs expected to be used for an unmanaged compute environment.
" } }, "ecsClusterArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags applied to the compute environment.
" } }, "type": { "target": "com.amazonaws.batch#CEType", "traits": { "smithy.api#documentation": "The type of the compute environment: MANAGED or UNMANAGED. For\n more information, see Compute environments in the Batch User Guide.
The state of the compute environment. The valid values are ENABLED or\n DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs\n from an associated job queue on the compute resources within the environment. If the compute\n environment is managed, then it can scale its instances out or in automatically based on the job\n queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place\n jobs within the environment. Jobs in a STARTING or RUNNING state\n continue to progress normally. Managed compute environments in the DISABLED state\n don't scale out.
Compute environments in a DISABLED state may continue to incur billing\n charges, for example, if they have running instances due to jobs that are still executing or a non-zero minvCpus setting. To prevent additional charges, disable and delete the compute environment.
When an instance is idle, the instance scales down to the minvCpus value.\n However, the instance size doesn't change. For example, consider a c5.8xlarge\n instance with a minvCpus value of 4 and a desiredvCpus\n value of 36. This instance doesn't scale down to a c5.large\n instance.
The current status of the compute environment (for example, CREATING or\n VALID).
A short, human-readable string to provide additional details for the current status of the\n compute environment.
" } }, "computeResources": { "target": "com.amazonaws.batch#ComputeResource", "traits": { "smithy.api#documentation": "The compute resources defined for the compute environment. For more information, see Compute environments in\n the Batch User Guide.
" } }, "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The service role that's associated with the compute environment that allows Batch to make\n calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the\n Batch User Guide.
" } }, "updatePolicy": { "target": "com.amazonaws.batch#UpdatePolicy", "traits": { "smithy.api#documentation": "Specifies the infrastructure update policy for the compute environment. For more information\n about infrastructure updates, see Updating compute environments in the\n Batch User Guide.
" } }, "eksConfiguration": { "target": "com.amazonaws.batch#EksConfiguration", "traits": { "smithy.api#documentation": "The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only\n specify this parameter if the containerOrchestrationType is EKS.
The orchestration type of the compute environment. The valid values are ECS\n (default) or EKS.
Unique identifier for the compute environment.
" } }, "context": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Reserved.
" } }, "ecsSettings": { "target": "com.amazonaws.batch#EcsSettings", "traits": { "smithy.api#documentation": "The Amazon ECS settings for the compute environment. These settings control CloudWatch\n Container Insights collection.
" } } }, "traits": { "smithy.api#documentation": "An object that represents an Batch compute environment.
" } }, "com.amazonaws.batch#ComputeEnvironmentDetailList": { "type": "list", "member": { "target": "com.amazonaws.batch#ComputeEnvironmentDetail" } }, "com.amazonaws.batch#ComputeEnvironmentOrder": { "type": "structure", "members": { "order": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The order of the compute environment. Compute environments are tried in ascending order. For\n example, if two compute environments are associated with a job queue, the compute environment\n with a lower order integer value is tried for job placement first.
The Amazon Resource Name (ARN) of the compute environment.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The order that compute environments are tried in for job placement within a queue. Compute\n environments are tried in ascending order. For example, if two compute environments are\n associated with a job queue, the compute environment with a lower order integer value is tried\n for job placement first. Compute environments must be in the VALID state before you\n can associate them with a job queue. All of the compute environments must be either EC2\n (EC2 or SPOT) or Fargate (FARGATE or\n FARGATE_SPOT); Amazon EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same\n architecture. Batch doesn't support mixing compute environment architecture types in a single\n job queue.
\nThe type of compute environment: EC2, SPOT, FARGATE,\n FARGATE_SPOT, or ECS_MANAGED_INSTANCES. For more information, see\n Compute\n environments in the Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.
If you choose ECS_MANAGED_INSTANCES, you must also specify a\n managedInstancesProvider configuration. To use Spot capacity, set\n capacityOptionType to SPOT in the\n managedInstancesProvider.instanceLaunchTemplate configuration. For more\n information, see Amazon ECS Managed Instances compute\n environments in the Batch User Guide.
Multi-node parallel jobs aren't supported on Spot Instances or Amazon ECS Managed\n Instances.
\nThe allocation strategy to use for the compute resource if not enough instances of the best\n fitting instance type can be allocated. This might be because of availability of the instance\n type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThis parameter is required for Amazon EKS compute environments. For Amazon ECS compute environments,\n if this parameter isn't specified, the BEST_FIT allocation strategy is used by\n default.
Batch selects an instance type that best fits the needs of the jobs with a preference\n for the lowest-cost instance type. If additional instances of the selected instance type\n aren't available, Batch waits for the additional instances to be available. If there aren't\n enough instances available or the user is reaching Amazon EC2 service limits,\n additional jobs aren't run until the currently running jobs are completed. This allocation\n strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with\n BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use\n a BEST_FIT allocation strategy don't support infrastructure updates and can't\n update some parameters. For more information, see Updating compute environments in\n the Batch User Guide.
Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.
\nThis is an advanced allocation strategy only for customers who want to control which\n instance types are preferred during scaling.
\nPlacing large instance types at the top of the list may result in over-provisioning for\n small jobs. Placing small instance types at the top may cause the compute environment to\n reach Amazon EC2 instance count limits before reaching maxvCpus.
Batch selects instance types in the order they appear in the\n instanceTypes list. When an instance family is specified, sizes within that\n family are expanded using BEST_FIT_PROGRESSIVE logic\u2014preferring sizes that\n best fit the jobs, with larger sizes as fallback. Instance types that cannot meet the resource\n requirements of the jobs are skipped. This strategy is only available for On-Demand Instance\n (EC2) compute resources.
If an instance family and an explicit instance type from that family both appear in\n instanceTypes, the explicit type takes its listed position and is excluded from\n the family expansion. For example, in [\"m7a.4xlarge\", \"m7a\", \"m6a\"],\n m7a.4xlarge is always placed first and is excluded from the m7a\n family expansion.
Batch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.
\nThe price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.
\nThis is an advanced allocation strategy for customers who want to influence instance\n type selection during scaling. This strategy optimizes for capacity\n first, and honors instance type priorities on a best-effort basis (priorities are\n honored when they do not significantly reduce available Spot capacity).
\nPlacing large instance types at the top of the list may result in over-provisioning for\n small jobs. Placing small instance types at the top may cause the compute environment to\n reach Amazon EC2 instance count limits before reaching maxvCpus.
Batch selects instance types in the order they appear in the\n instanceTypes list, but optimizes for capacity\n first. The customer-defined priority is honored on a best-effort basis. When Spot\n Instance capacity pools are similarly available, priority order is respected. When capacity is\n constrained, Batch selects from the most available pools regardless of priority to minimize\n the likelihood of Spot Instance interruptions. This strategy is only available for Spot\n Instance compute resources.
With any allocation strategy except BEST_FIT using On-Demand\n (EC2) compute resources, Batch might need to exceed maxvCpus to meet your\n capacity requirements. In this event, Batch never exceeds maxvCpus by more than\n a single instance.
The minimum number of vCPUs that a compute environment should maintain (even if the compute \n environment is DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum number of vCPUs that a compute environment can support.
\nWith any allocation strategy except BEST_FIT using On-Demand\n (EC2) compute resources, Batch might need to exceed maxvCpus to meet your\n capacity requirements. In this event, Batch never exceeds maxvCpus by more than\n a single instance.
The desired number of vCPUS in the compute environment. Batch modifies this value between \n the minimum and maximum values based on job queue demand.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe instances types that can be launched. You can specify instance families to launch any\n instance type within those families (for example, c5 or p3), or you can\n specify specific sizes within a family (such as c5.8xlarge).
Batch can select the instance type for you if you choose one of the following:
\n\n default_x86_64 to choose x86 based instance types (from the m6i,\n c6i, r6i, and c7i instance families) that matches the resource demands of the job queue.
\n default_arm64 to choose ARM based instance types (from the m6g,\n c6g, r6g, and c7g instance families) that matches the resource demands of the job queue.
\n optimal Semantically equivalent to default_x86_64, see Optimal instance type configuration to receive automatic instance family\n updates for details.
Instance family availability varies by Amazon Web Services Region. For example, some Amazon Web Services Regions may not have any fourth generation instance families but have fifth and\n sixth generation instance families.
\nWhen using default_x86_64 or default_arm64 instance bundles,\n Batch selects instance families based on a balance of cost-effectiveness and performance.\n While newer generation instances often provide better price-performance, Batch may choose an\n earlier generation instance family if it provides the optimal combination of availability, cost,\n and performance for your workload. For example, in an Amazon Web Services Region where both c6i\n and c7i instances are available, Batch might select c6i instances if they offer better\n cost-effectiveness for your specific job requirements. For more information on Batch instance\n types and Amazon Web Services Region availability, see Instance\n type compute table in the Batch User Guide.
Batch periodically updates your instances in default bundles to newer,\n more cost-effective options. Updates happen automatically without requiring any\n action from you. Your workloads continue running during updates with no interruption\n
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nWhen you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.
\nThe Amazon Machine Image (AMI) ID used for instances launched in the compute environment.\n This parameter is overridden by the imageIdOverride member of the\n Ec2Configuration structure.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2023 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2023 AMI\n in the Amazon Elastic Container Service Developer Guide.
\nThe VPC subnets where the compute resources are launched. These subnets must be within the\n same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see\n VPCs and subnets\n in the Amazon VPC User Guide. This parameter is required for compute\n environments using EC2, SPOT, FARGATE, or\n FARGATE_SPOT compute resources.
Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local\n Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and Amazon ECS\n clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS\n Developer Guide.
\nBatch on Fargate doesn't currently support Local Zones.
\nThe Amazon EC2 security groups that are associated with instances launched in the compute\n environment. One or more security groups must be specified, either in\n securityGroupIds or using a launch template referenced in\n launchTemplate. This parameter is required for jobs that are running on Fargate\n resources and must contain at least one security group. Fargate doesn't support launch\n templates. If security groups are specified using both securityGroupIds and\n launchTemplate, the values in securityGroupIds are used.
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can\n use this key pair to log in to your instances with SSH.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This\n parameter is required for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN)\n of an instance profile. For example, \n ecsInstanceRole\n or\n arn:aws:iam::.\n For more information, see Amazon ECS instance role in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nKey-value pair tags to be applied to Amazon EC2 resources that are launched in the compute\n environment. For Batch, these take the form of \"String1\": \"String2\", where\n String1 is the tag key and String2 is the tag value (for example,\n { \"Name\": \"Batch Instance - C4OnDemand\" }). This is helpful for recognizing your\n Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to\n the compute environment. For more information, see Updating compute environments in the\n Batch User Guide. These tags aren't seen when using the Batch\n ListTagsForResource API operation.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon EC2 placement group to associate with your compute resources. If you intend to submit\n multi-node parallel jobs to your compute environment, you should consider creating a cluster\n placement group and associate it with your compute resources. This keeps your multi-node parallel\n job on a logical grouping of instances within a single Availability Zone with high network flow\n potential. For more information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand\n price for that instance type before instances are launched. For example, if your maximum\n percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for\n that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum\n percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price. For most use cases, we recommend leaving this field empty.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute\n environment. This role is required if the allocation strategy set to BEST_FIT or if\n the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nTo tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use\n the newer AmazonEC2SpotFleetTaggingRole managed policy. The\n previously recommended AmazonEC2SpotFleetRole managed policy\n doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances\n not tagged on creation in the Batch User Guide.
\nThe launch template to use for your compute resources. Any other compute resource parameters\n that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch\n template. You must specify either the launch template ID or launch template name in the request,\n but not both. For more information, see Launch template support in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nProvides information that's used to select Amazon Machine Images (AMIs) for Amazon EC2 instances\n in the compute environment. If Ec2Configuration isn't specified, the default is\n ECS_AL2023 for EC2 (ECS) compute environments and EKS_AL2023 for EKS compute environments.
One or two values can be provided.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe scaling policy configuration for the compute environment.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe configuration for the Amazon ECS Managed Instances capacity provider. This parameter is\n required when computeResources.type is ECS_MANAGED_INSTANCES and must\n not be specified for other compute environment types.
For more information, see Amazon ECS\n Managed Instances compute environments in the\n Batch User Guide.
" } }, "capacityTags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags to apply to the Amazon ECS capacity provider and Amazon EC2 instances launched by the\n compute environment. These tags are separate from the compute environment resource tags (the\n top-level tags parameter). Use capacityTags for cost allocation and\n organization of the underlying infrastructure resources.
This parameter is only valid for ECS_MANAGED_INSTANCES compute environments.\n You must have the batch:SetCapacityTags permission on the\n compute environment resource to use this parameter.
An object that represents an Batch compute resource. For more information, see Compute environments in\n the Batch User Guide.
" } }, "com.amazonaws.batch#ComputeResourceUpdate": { "type": "structure", "members": { "minvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The minimum number of vCPUs that an environment should maintain (even if the compute environment \n is DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum number of Amazon EC2 vCPUs that an environment can reach.
\nWith any allocation strategy except BEST_FIT using On-Demand\n (EC2) compute resources, Batch might need to exceed maxvCpus to meet your\n capacity requirements. In this event, Batch never exceeds maxvCpus by more than\n a single instance.
The desired number of vCPUS in the compute environment. Batch modifies this value between \n the minimum and maximum values based on job queue demand.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch doesn't support changing the desired number of vCPUs of an existing compute\n environment. Don't specify this parameter for compute environments using Amazon EKS clusters.
\nWhen you update the desiredvCpus setting, the value must be between the\n minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to\n the current desiredvCpus value. For more information, see Troubleshooting\n Batch in the Batch User Guide.
The VPC subnets where the compute resources are launched. Fargate compute resources can\n contain up to 16 subnets. For Fargate compute resources, providing an empty list will be\n handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources,\n providing an empty list removes the VPC subnets from the compute resource. For more information,\n see VPCs and\n subnets in the Amazon VPC User Guide.
\nWhen updating a compute environment, changing the VPC subnets requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nBatch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local\n Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and Amazon ECS\n clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS\n Developer Guide.
\nBatch on Fargate doesn't currently support Local Zones.
\nThe Amazon EC2 security groups that are associated with instances launched in the compute\n environment. This parameter is required for Fargate compute resources, where it can contain up\n to 5 security groups. For Fargate compute resources, providing an empty list is handled as if\n this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an\n empty list removes the security groups from the compute resource.
\nWhen updating a compute environment, changing the Amazon EC2 security groups requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide.
" } }, "allocationStrategy": { "target": "com.amazonaws.batch#CRUpdateAllocationStrategy", "traits": { "smithy.api#documentation": "The allocation strategy to use for the compute resource if there's not enough instances of\n the best fitting instance type that can be allocated. This might be because of availability of\n the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.
\nWhen updating a compute environment, changing the allocation strategy requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide. BEST_FIT isn't\n supported when updating a compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.
\nThis is an advanced allocation strategy only for customers who want to control which\n instance types are preferred during scaling.
\nPlacing large instance types at the top of the list may result in over-provisioning for\n small jobs. Placing small instance types at the top may cause the compute environment to\n reach Amazon EC2 instance count limits before reaching maxvCpus.
Batch selects instance types in the order they appear in the\n instanceTypes list. When an instance family is specified, sizes within that\n family are expanded using BEST_FIT_PROGRESSIVE logic\u2014preferring sizes that\n best fit the jobs, with larger sizes as fallback. Instance types that cannot meet the resource\n requirements of the jobs are skipped. This strategy is only available for On-Demand Instance\n (EC2) compute resources.
If an instance family and an explicit instance type from that family both appear in\n instanceTypes, the explicit type takes its listed position and is excluded from\n the family expansion. For example, in [\"m7a.4xlarge\", \"m7a\", \"m6a\"],\n m7a.4xlarge is always placed first and is excluded from the m7a\n family expansion.
Batch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.
\nThe price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.
\nThis is an advanced allocation strategy for customers who want to influence instance\n type selection during scaling. This strategy optimizes for capacity\n first, and honors instance type priorities on a best-effort basis (priorities are\n honored when they do not significantly reduce available Spot capacity).
\nPlacing large instance types at the top of the list may result in over-provisioning for\n small jobs. Placing small instance types at the top may cause the compute environment to\n reach Amazon EC2 instance count limits before reaching maxvCpus.
Batch selects instance types in the order they appear in the\n instanceTypes list, but optimizes for capacity\n first. The customer-defined priority is honored on a best-effort basis. When Spot\n Instance capacity pools are similarly available, priority order is respected. When capacity is\n constrained, Batch selects from the most available pools regardless of priority to minimize\n the likelihood of Spot Instance interruptions. This strategy is only available for Spot\n Instance compute resources.
With any allocation strategy except BEST_FIT using On-Demand\n (EC2) compute resources, Batch might need to exceed maxvCpus to meet your\n capacity requirements. In this event, Batch never exceeds maxvCpus by more than\n a single instance.
The instances types that can be launched. You can specify instance families to launch any\n instance type within those families (for example, c5 or p3), or you can\n specify specific sizes within a family (such as c5.8xlarge).
Batch can select the instance type for you if you choose one of the following:
\n\n optimal to select instance types (from the c4, m4,\n r4, c5, m5, and r5\n instance families) that match the demand of your job queues.
\n default_x86_64 to choose x86 based instance types (from the m6i,\n c6i, r6i, and c7i instance families) that matches the resource demands of the job queue.
\n default_arm64 to choose x86 based instance types (from the m6g,\n c6g, r6g, and c7g instance families) that matches the resource demands of the job queue.
Starting on 11/01/2025 the behavior of optimal is going to be changed to match\n default_x86_64. During the change your instance families could be updated to a\n newer generation. You do not need to perform any actions for the upgrade to happen. For more\n information about change, see Optimal instance type configuration to receive automatic instance family\n updates.
Instance family availability varies by Amazon Web Services Region. For example, some Amazon Web Services Regions may not have any fourth generation instance families but have fifth and\n sixth generation instance families.
\nWhen using default_x86_64 or default_arm64 instance bundles,\n Batch selects instance families based on a balance of cost-effectiveness and performance.\n While newer generation instances often provide better price-performance, Batch may choose an\n earlier generation instance family if it provides the optimal combination of availability, cost,\n and performance for your workload. For example, in an Amazon Web Services Region where both c6i\n and c7i instances are available, Batch might select c6i instances if they offer better\n cost-effectiveness for your specific job requirements. For more information on Batch instance\n types and Amazon Web Services Region availability, see Instance\n type compute table in the Batch User Guide.
Batch periodically updates your instances in default bundles to newer,\n more cost-effective options. Updates happen automatically without requiring any\n action from you. Your workloads continue running during updates with no interruption\n
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nWhen you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.
\nThe Amazon EC2 key pair that's used for instances launched in the compute environment. You can\n use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this\n value to an empty string.
\nWhen updating a compute environment, changing the Amazon EC2 key pair requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.\n Required for Amazon EC2 instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance\n profile. For example, \n ecsInstanceRole\n or\n arn:aws:iam::.\n For more information, see Amazon ECS instance role in the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nKey-value pair tags to be applied to Amazon EC2 resources that are launched in the compute\n environment. For Batch, these take the form of \"String1\": \"String2\", where\n String1 is the tag key and String2 is the tag value (for example,\n { \"Name\": \"Batch Instance - C4OnDemand\" }). This is helpful for recognizing your\n Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch\n ListTagsForResource API operation.
When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon EC2 placement group to associate with your compute resources. If you intend to submit\n multi-node parallel jobs to your compute environment, you should consider creating a cluster\n placement group and associate it with your compute resources. This keeps your multi-node parallel\n job on a logical grouping of instances within a single Availability Zone with high network flow\n potential. For more information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.
\nWhen updating a compute environment, changing the placement group requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand\n price for that instance type before instances are launched. For example, if your maximum\n percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that\n Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum\n percentage. For most use cases, we recommend leaving this field empty.
\nWhen updating a compute environment, changing the bid percentage requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe updated launch template to use for your compute resources. You must specify either the\n launch template ID or launch template name in the request, but not both. For more information,\n see Launch template\n support in the Batch User Guide. To remove the custom launch\n template and use the default launch template, set launchTemplateId or\n launchTemplateName member of the launch template specification to an empty string.\n Removing the launch template from a compute environment will not remove the AMI specified in the\n launch template. In order to update the AMI specified in a launch template, the\n updateToLatestImageVersion parameter must be set to true.
When updating a compute environment, changing the launch template requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nProvides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the\n compute environment. If Ec2Configuration isn't specified, the default is\n ECS_AL2023 for EC2 (ECS) compute environments and EKS_AL2023 for EKS compute environments.
When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide. To remove the Amazon EC2 configuration and any custom AMI ID\n specified in imageIdOverride, set this value to an empty string.
One or two values can be provided.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nSpecifies whether the AMI ID is updated to the latest one that's supported by Batch when\n the compute environment has an infrastructure update. The default value is\n false.
An AMI ID can either be specified in the imageId or\n imageIdOverride parameters or be determined by the launch template that's\n specified in the launchTemplate parameter. If an AMI ID is specified any of these\n ways, this parameter is ignored. For more information about to update AMI IDs during an\n infrastructure update, see Updating\n the AMI ID in the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
" } }, "type": { "target": "com.amazonaws.batch#CRType", "traits": { "smithy.api#documentation": "The type of compute environment: EC2, SPOT, FARGATE,\n FARGATE_SPOT, or ECS_MANAGED_INSTANCES. For more information, see\n Compute\n environments in the Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.
When updating a compute environment, changing the type of a compute environment requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide.
\nYou cannot change the type to or from ECS_MANAGED_INSTANCES.
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.\n This parameter is overridden by the imageIdOverride member of the\n Ec2Configuration structure. To remove the custom AMI ID and use the default AMI ID,\n set this value to an empty string.
When updating a compute environment, changing the AMI ID requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2023 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2023 AMI\n in the Amazon Elastic Container Service Developer Guide.
\nThe scaling policy configuration for the compute environment.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe updated configuration for the Amazon ECS Managed Instances capacity provider. This parameter\n is only valid when the compute environment type is ECS_MANAGED_INSTANCES. You\n cannot change capacityOptionType or fipsEnabled on update.
The updated tags to apply to the Amazon ECS capacity provider and Amazon EC2 instances. This\n parameter is only valid for ECS_MANAGED_INSTANCES compute environments. You must\n have the batch:SetCapacityTags permission on the compute environment resource to\n use this parameter.
An object that represents the attributes of a compute environment that can be updated. For\n more information, see Updating compute environments in the\n Batch User Guide.
" } }, "com.amazonaws.batch#ComputeScalingPolicy": { "type": "structure", "members": { "minScaleDownDelayMinutes": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The minimum time (in minutes) that Batch keeps instances running in the compute environment \n after their jobs complete. For each instance, the delay period begins when the last job finishes. \n If no new jobs are placed on the instance during this delay, Batch terminates the instance once \n the delay expires.
\nValid Range: Minimum value of 20. Maximum value of 10080. Use 0 to unset and disable the scale down delay.
\nIdle instances retained during the scale-down delay period are billable at standard EC2 pricing.
\nThe scale down delay does not apply to:
\nInstances being replaced during infrastructure updates
\nNewly launched instances that have not yet run any jobs
\nSpot instances reclaimed due to interruption
\nAn object that represents a scaling policy for a compute environment.
" } }, "com.amazonaws.batch#ConsumableResourceList": { "type": "list", "member": { "target": "com.amazonaws.batch#ConsumableResourceRequirement" } }, "com.amazonaws.batch#ConsumableResourceProperties": { "type": "structure", "members": { "consumableResourceList": { "target": "com.amazonaws.batch#ConsumableResourceList", "traits": { "smithy.api#documentation": "The list of consumable resources required by a job.
" } } }, "traits": { "smithy.api#documentation": "Contains a list of consumable resources required by a job.
" } }, "com.amazonaws.batch#ConsumableResourceRequirement": { "type": "structure", "members": { "consumableResource": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name or ARN of the consumable resource.
" } }, "quantity": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The quantity of the consumable resource that is needed.
" } } }, "traits": { "smithy.api#documentation": "Information about a consumable resource required to run a job.
" } }, "com.amazonaws.batch#ConsumableResourceSummary": { "type": "structure", "members": { "consumableResourceArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumable resource.
", "smithy.api#required": {} } }, "consumableResourceName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the consumable resource.
", "smithy.api#required": {} } }, "totalQuantity": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The total amount of the consumable resource that is available.
" } }, "inUseQuantity": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The amount of the consumable resource that is currently in use.
" } }, "resourceType": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Indicates whether the resource is available to be re-used after a job completes. Can be \n one of:
\n\n REPLENISHABLE\n
\n NON_REPLENISHABLE\n
Current information about a consumable resource.
" } }, "com.amazonaws.batch#ConsumableResourceSummaryList": { "type": "list", "member": { "target": "com.amazonaws.batch#ConsumableResourceSummary" } }, "com.amazonaws.batch#ContainerDetail": { "type": "structure", "members": { "image": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The image used to start the container.
" } }, "vcpus": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you\n can specify the vCPU requirement for the job using resourceRequirements, but you\n can't specify the vCPU requirements in both the vcpus and\n resourceRequirements object. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the\n --cpu-shares option to docker run. Each\n vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but\n can be specified in several places. It must be specified for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run\n on Fargate resources, you must specify the vCPU requirement for the job using\n resourceRequirements.
For jobs running on Amazon EC2 resources that didn't specify memory requirements using\n resourceRequirements, the number of MiB of memory reserved for the job. For other\n jobs, including all run on Fargate resources, see resourceRequirements.
The command that's passed to the container.
" } }, "jobRoleArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that's associated with the job when run.
" } }, "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information,\n see Batch execution IAM\n role in the Batch User Guide.
" } }, "volumes": { "target": "com.amazonaws.batch#Volumes", "traits": { "smithy.api#documentation": "A list of volumes that are associated with the job.
" } }, "environment": { "target": "com.amazonaws.batch#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables to pass to a container.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The mount points for data volumes in your container.
" } }, "readonlyRootFilesystem": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "When this parameter is true, the container is given read-only access to its root file\n system. This parameter maps to ReadonlyRootfs in the\n Create a container section of the Docker Remote API and the\n --read-only option to \n docker\n run\n .
A list of ulimit values to set in the container. This parameter maps to\n Ulimits in the Create a container section of the Docker Remote API\n and the --ulimit option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources.
\nWhen this parameter is true, the container is given elevated permissions on the host\n container instance (similar to the root user). The default value is\n false.
This parameter isn't applicable to jobs that are running on Fargate resources and\n shouldn't be provided, or specified as false.
The user name to use inside the container. This parameter maps to User in the\n Create a container section of the Docker Remote API and the --user\n option to docker run.
The exit code returned upon completion.
" } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a\n running or stopped container.
" } }, "containerInstanceArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container instance that the container is running on.
" } }, "taskArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container\n attempt receives a task ARN when they reach the STARTING status.
The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for\n Batch jobs is /aws/batch/job. Each container attempt receives a log stream name\n when they reach the RUNNING status.
The instance type of the underlying host infrastructure of a multi-node parallel job.
\nThis parameter isn't applicable to jobs that are running on Fargate resources.
\nThe network interfaces that are associated with the job.
" } }, "resourceRequirements": { "target": "com.amazonaws.batch#ResourceRequirements", "traits": { "smithy.api#documentation": "The type and amount of resources to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.
Linux-specific modifications that are applied to the container, such as details for device\n mappings.
" } }, "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { "smithy.api#documentation": "The log configuration specification for the container.
\nThis parameter maps to LogConfig in the Create a container\n section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging\n driver that the Docker daemon uses. However, the container might use a different logging driver\n than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured\n properly on the container instance. Or, alternatively, it must be configured on a different log\n server for remote logging options. For more information on the options for different supported\n log drivers, see Configure\n logging drivers in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon\n (shown in the LogConfiguration data type). Additional log drivers might be available in future\n releases of the Amazon ECS container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The Amazon ECS container agent running on a container instance must register the logging drivers\n available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment\n variable before containers placed on that instance can use these log configuration options. For\n more information, see Amazon ECS container agent\n configuration in the Amazon Elastic Container Service Developer Guide.
The secrets to pass to the container. For more information, see Specifying sensitive data in the\n Batch User Guide.
" } }, "networkConfiguration": { "target": "com.amazonaws.batch#NetworkConfiguration", "traits": { "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on Amazon EC2 resources must not specify this parameter.
" } }, "fargatePlatformConfiguration": { "target": "com.amazonaws.batch#FargatePlatformConfiguration", "traits": { "smithy.api#documentation": "The platform configuration for jobs that are running on Fargate resources. Jobs that are\n running on Amazon EC2 resources must not specify this parameter.
" } }, "ephemeralStorage": { "target": "com.amazonaws.batch#EphemeralStorage", "traits": { "smithy.api#documentation": "The amount of ephemeral storage allocated for the task. This parameter is used to expand the\n total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\n Fargate.
" } }, "runtimePlatform": { "target": "com.amazonaws.batch#RuntimePlatform", "traits": { "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on\n Fargate.
" } }, "repositoryCredentials": { "target": "com.amazonaws.batch#RepositoryCredentials", "traits": { "smithy.api#documentation": "The private repository authentication credentials to use.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Determines whether execute command functionality is turned on for this task. If true, execute\n command functionality is turned on all the containers in the task.
An object that represents the details of a container that's part of a job.
" } }, "com.amazonaws.batch#ContainerInsights": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "ENHANCED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENHANCED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } }, "traits": { "smithy.api#documentation": "Specifies the CloudWatch Container Insights mode for the compute environment.
" } }, "com.amazonaws.batch#ContainerOverrides": { "type": "structure", "members": { "vcpus": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, "smithy.api#documentation": "This parameter is deprecated, use resourceRequirements to override the\n vcpus parameter that's set in the job definition. It's not supported for jobs\n running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the\n vcpus parameter set in the job definition, but doesn't override any vCPU\n requirement specified in the resourceRequirements structure in the job definition.\n To override vCPU requirements that are specified in the resourceRequirements\n structure in the job definition, resourceRequirements must be specified in the\n SubmitJob request, with type set to VCPU and\n value set to the new value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the memory\n requirements specified in the job definition. It's not supported for jobs running on Fargate\n resources. For jobs that run on Amazon EC2 resources, it overrides the memory parameter\n set in the job definition, but doesn't override any memory requirement that's specified in the\n resourceRequirements structure in the job definition. To override memory\n requirements that are specified in the resourceRequirements structure in the job\n definition, resourceRequirements must be specified in the SubmitJob\n request, with type set to MEMORY and value set to the new\n value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.
The command to send to the container that overrides the default command from the Docker\n image or the job definition.
\nThis parameter can't contain an empty string.
\nThe instance type to use for a multi-node parallel job.
\nThis parameter isn't applicable to single-node container jobs or jobs that run on Fargate\n resources, and shouldn't be provided.
\nThe environment variables to send to the container. You can add new environment variables,\n which are added to the container at launch, or you can override the existing environment\n variables from the Docker image or the job definition.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The type and amount of resources to assign to a container. This overrides the settings in\n the job definition. The supported resources include GPU, MEMORY, and\n VCPU.
The overrides that should be sent to a container.
\nFor information about using Batch overrides when you connect event sources to targets, see\n BatchContainerOverrides.
" } }, "com.amazonaws.batch#ContainerProperties": { "type": "structure", "members": { "image": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Required. The image used to start a container. This string is passed directly to the\n Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are\n specified with\n \n repository-url/image:tag\n .\n It can be 255 characters long. It can contain uppercase and lowercase letters, numbers,\n hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the\n Create a container section of the Docker Remote API and the IMAGE\n parameter of docker run.
Docker image architecture must match the processor architecture of the compute resources\n that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based\n compute resources.
\nImages in Amazon ECR Public repositories use the full registry/repository[:tag] or\n registry/repository[@digest] naming conventions. For example,\n public.ecr.aws/registry_alias/my-web-app:latest\n .
Images in Amazon ECR repositories use the full registry and repository URI (for example,\n 123456789012.dkr.ecr.).
Images in official repositories on Docker Hub use a single name (for example,\n ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for\n example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example,\n quay.io/assemblyline/ubuntu).
This parameter is deprecated, use resourceRequirements to specify the vCPU\n requirements for the job definition. It's not supported for jobs running on Fargate resources.\n For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the\n job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares\n in the Create a container section of the Docker Remote API and the\n --cpu-shares option to docker run. The\n number of vCPUs must be specified but can be specified in several places. You must specify it at\n least once for each node.
This parameter is deprecated, use resourceRequirements to specify the memory\n requirements for the job definition. It's not supported for jobs running on Fargate resources.\n For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a\n container. If your container attempts to exceed the specified number, it's terminated. You must\n specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be\n specified in several places. It must be specified for each node at least once.
The command that's passed to the container. This parameter maps to Cmd in the\n Create a container section of the Docker Remote API and the COMMAND\n parameter to docker run. For more information, see\n https://docs.docker.com/engine/reference/builder/#cmd.
The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more\n information, see IAM roles for tasks in the\n Amazon Elastic Container Service Developer Guide.
" } }, "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate\n resources, you must provide an execution role. For more information, see Batch execution IAM role\n in the Batch User Guide.
" } }, "volumes": { "target": "com.amazonaws.batch#Volumes", "traits": { "smithy.api#documentation": "A list of data volumes used in a job.
" } }, "environment": { "target": "com.amazonaws.batch#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables to pass to a container. This parameter maps to Env in\n the Create a container section of the Docker Remote API and the\n --env option to docker run.
We don't recommend using plaintext environment variables for sensitive information, such as\n credential data.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The mount points for data volumes in your container. This parameter maps to\n Volumes in the Create a container section of the Docker Remote API\n and the --volume option to docker\n run.
When this parameter is true, the container is given read-only access to its root file\n system. This parameter maps to ReadonlyRootfs in the\n Create a container section of the Docker Remote API and the\n --read-only option to docker run.
When this parameter is true, the container is given elevated permissions on the host\n container instance (similar to the root user). This parameter maps to\n Privileged in the Create a container section of the\n Docker Remote API and the --privileged option to docker run. The default value is false.
This parameter isn't applicable to jobs that are running on Fargate resources and\n shouldn't be provided, or specified as false.
\nA list of ulimits to set in the container. This parameter maps to\n Ulimits in the Create a container section of the Docker Remote API\n and the --ulimit option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources and\n shouldn't be provided.
\nThe user name to use inside the container. This parameter maps to User in the\n Create a container section of the Docker Remote API and the --user\n option to docker run.
The instance type to use for a multi-node parallel job. All node groups in a multi-node\n parallel job must use the same instance type.
\nThis parameter isn't applicable to single-node container jobs or jobs that run on Fargate\n resources, and shouldn't be provided.
\nThe type and amount of resources to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.
Linux-specific modifications that are applied to the container, such as details for device\n mappings.
" } }, "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { "smithy.api#documentation": "The log configuration specification for the container.
\nThis parameter maps to LogConfig in the Create a container\n section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging\n driver that the Docker daemon uses. However the container might use a different logging driver\n than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured\n properly on the container instance (or on a different log server for remote logging options). For\n more information on the options for different supported log drivers, see Configure logging drivers\n in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon\n (shown in the LogConfiguration data type).
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The Amazon ECS container agent running on a container instance must register the logging drivers\n available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment\n variable before containers placed on that instance can use these log configuration options. For\n more information, see Amazon ECS container agent\n configuration in the Amazon Elastic Container Service Developer Guide.
The secrets for the container. For more information, see Specifying sensitive data in the\n Batch User Guide.
" } }, "networkConfiguration": { "target": "com.amazonaws.batch#NetworkConfiguration", "traits": { "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on Amazon EC2 resources must not specify this parameter.
" } }, "fargatePlatformConfiguration": { "target": "com.amazonaws.batch#FargatePlatformConfiguration", "traits": { "smithy.api#documentation": "The platform configuration for jobs that are running on Fargate resources. Jobs that are\n running on Amazon EC2 resources must not specify this parameter.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Determines whether execute command functionality is turned on for this task. If true, execute\n command functionality is turned on all the containers in the task.
The amount of ephemeral storage to allocate for the task. This parameter is used to expand\n the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\n Fargate.
" } }, "runtimePlatform": { "target": "com.amazonaws.batch#RuntimePlatform", "traits": { "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on\n Fargate.
" } }, "repositoryCredentials": { "target": "com.amazonaws.batch#RepositoryCredentials", "traits": { "smithy.api#documentation": "The private repository authentication credentials to use.
" } } }, "traits": { "smithy.api#documentation": "Container properties are used for Amazon ECS based job definitions. These properties to describe the \n container that's launched as part of a job.
" } }, "com.amazonaws.batch#ContainerSummary": { "type": "structure", "members": { "exitCode": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The exit code to return upon completion.
" } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a\n running or stopped container.
" } } }, "traits": { "smithy.api#documentation": "An object that represents summary details of a container within a job.
" } }, "com.amazonaws.batch#CreateComputeEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.batch#CreateComputeEnvironmentRequest" }, "output": { "target": "com.amazonaws.batch#CreateComputeEnvironmentResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Creates an Batch compute environment. You can create MANAGED or\n UNMANAGED compute environments. MANAGED compute environments can\n use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use\n EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the\n compute resources within the environment. This is based on the compute resource specification\n that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand\n Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in\n your managed compute environment. You can optionally set a maximum price so that Spot\n Instances only launch when the Spot Instance price is less than a specified percentage of the\n On-Demand price.
\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and\n have flexibility with how you configure your compute resources. For example, you can use\n custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance\n AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment,\n you can use the DescribeComputeEnvironments operation to find the Amazon ECS\n cluster that's associated with it. Then, launch your container instances into that Amazon ECS\n cluster. For more information, see Launching an Amazon ECS container\n instance in the Amazon Elastic Container Service Developer Guide.
\nBatch doesn't automatically upgrade the AMIs in a compute environment after it's\n created. For more information on how to update a compute environment's AMI, see Updating compute environments in the Batch User Guide.
\nThe name for your compute environment. It can be up to 128 characters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.batch#CEType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of the compute environment: MANAGED or UNMANAGED. For\n more information, see Compute Environments in the Batch User Guide.
The state of the compute environment. A compute environment must be created in the\n ENABLED state.
If the state is ENABLED, then the\n compute environment accepts jobs from a queue and can scale out automatically based on\n queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs\n from an associated job queue on the compute resources within the environment. If the compute\n environment is managed, then it can scale its instances out or in automatically, based on the\n job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place\n jobs within the environment. Jobs in a STARTING or RUNNING state\n continue to progress normally. Managed compute environments in the DISABLED state\n don't scale out.
Compute environments in a DISABLED state may continue to incur billing\n charges, for example, if they have running instances due to jobs that are still executing or a non-zero minvCpus setting. To prevent additional charges, disable and delete the compute environment.
When an instance is idle, the instance scales down to the minvCpus value.\n However, the instance size doesn't change. For example, consider a c5.8xlarge\n instance with a minvCpus value of 4 and a desiredvCpus\n value of 36. This instance doesn't scale down to a c5.large\n instance.
The maximum number of vCPUs for an unmanaged compute environment. This parameter is only\n used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this\n parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.
\nThis parameter is only supported when the type parameter is set to\n UNMANAGED.
Details about the compute resources managed by the compute environment. This parameter is\n required for managed compute environments. For more information, see Compute Environments\n in the Batch User Guide.
" } }, "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services\n services on your behalf. For more information, see Batch service IAM role in the\n Batch User Guide.
\nIf your account already created the Batch service-linked role, that role is used by\n default for your compute environment unless you specify a different role here. If the\n Batch service-linked role doesn't exist in your account, and no role is specified here,\n the service attempts to create the Batch service-linked role in your account.
\nThis automatic service-linked role creation only applies to MANAGED compute\n environments. For UNMANAGED compute environments, you must explicitly specify a\n serviceRole.
If your specified role has a path other than /, then you must specify either\n the full role ARN (recommended) or prefix the role name with the path. For example, if a\n role with the name bar has a path of /foo/, specify\n /foo/bar as the role name. For more information, see Friendly\n names and paths in the IAM User Guide.
Depending on how you created your Batch service role, its ARN might contain the\n service-role path prefix. When you only specify the name of the service role,\n Batch assumes that your ARN doesn't use the service-role path prefix. Because\n of this, we recommend that you specify the full ARN of your service role when you create\n compute environments.
The tags that you apply to the compute environment to help you categorize and organize\n your resources. Each tag consists of a key and an optional value. For more information, see\n Tagging Amazon Web Services\n Resources in Amazon Web Services General Reference.
\nThese tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute\n resources.
" } }, "eksConfiguration": { "target": "com.amazonaws.batch#EksConfiguration", "traits": { "smithy.api#documentation": "The details for the Amazon EKS cluster that supports the compute environment.
\nTo create a compute environment that uses EKS resources, the caller must have\n permissions to call eks:DescribeCluster. Additional Amazon EKS permissions are\n required for Batch to manage an access entry on the cluster; see Amazon EKS access entry\n authentication in the Batch User Guide.
Reserved.
" } }, "ecsSettings": { "target": "com.amazonaws.batch#EcsSettings", "traits": { "smithy.api#documentation": "The Amazon ECS settings for the compute environment. These settings control CloudWatch\n Container Insights collection for the compute environment.
" } } }, "traits": { "smithy.api#documentation": "Contains the parameters for CreateComputeEnvironment.
The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
" } }, "computeEnvironmentArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the compute environment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#CreateConsumableResource": { "type": "operation", "input": { "target": "com.amazonaws.batch#CreateConsumableResourceRequest" }, "output": { "target": "com.amazonaws.batch#CreateConsumableResourceResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Creates an Batch consumable resource.
", "smithy.api#examples": [ { "title": "To create a consumable resource", "documentation": "Creates a Batch consumable resource.", "input": { "consumableResourceName": "myConsumableResource", "totalQuantity": 123, "resourceType": "REPLENISHABLE", "tags": { "Department": "Engineering", "User": "JaneDoe" } }, "output": { "consumableResourceName": "myConsumableResource", "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource" } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/createconsumableresource", "code": 200 } } }, "com.amazonaws.batch#CreateConsumableResourceRequest": { "type": "structure", "members": { "consumableResourceName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the consumable resource. Must be unique.
", "smithy.api#required": {} } }, "totalQuantity": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The total amount of the consumable resource that is available. Must be non-negative.
" } }, "resourceType": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Indicates whether the resource is available to be re-used after a job completes. Can be \n one of:
\n\n REPLENISHABLE (default)
\n NON_REPLENISHABLE\n
The tags that you apply to the consumable resource to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#CreateConsumableResourceResponse": { "type": "structure", "members": { "consumableResourceName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the consumable resource.
", "smithy.api#required": {} } }, "consumableResourceArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumable resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#CreateJobQueue": { "type": "operation", "input": { "target": "com.amazonaws.batch#CreateJobQueueRequest" }, "output": { "target": "com.amazonaws.batch#CreateJobQueueResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Creates an Batch job queue. When you create a job queue, you associate one or more\n compute environments to the queue and assign an order of preference for the compute\n environments.
\nYou also set a priority to the job queue that determines the order that the Batch\n scheduler places jobs onto its associated compute environments. For example, if a compute\n environment is associated with more than one job queue, the job queue with a higher priority\n is given preference for scheduling jobs to that compute environment.
", "smithy.api#examples": [ { "title": "To create a job queue with a single compute environment", "documentation": "This example creates a job queue called LowPriority that uses the M4Spot compute environment.", "input": { "priority": 1, "state": "ENABLED", "computeEnvironmentOrder": [ { "computeEnvironment": "M4Spot", "order": 1 } ], "jobQueueName": "LowPriority" }, "output": { "jobQueueName": "LowPriority", "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority" } }, { "title": "To create a job queue with an ECS Managed Instances compute environment", "documentation": "This example creates a job queue called ManagedInstancesQueue that uses an ECS Managed Instances compute environment.", "input": { "priority": 10, "state": "ENABLED", "computeEnvironmentOrder": [ { "computeEnvironment": "my-managed-instances-ce", "order": 1 } ], "jobQueueName": "ManagedInstancesQueue" }, "output": { "jobQueueName": "ManagedInstancesQueue", "jobQueueArn": "arn:aws:batch:us-east-1:123456789012:job-queue/ManagedInstancesQueue" } }, { "title": "To create a job queue with multiple compute environments", "documentation": "This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.", "input": { "priority": 10, "state": "ENABLED", "computeEnvironmentOrder": [ { "computeEnvironment": "C4OnDemand", "order": 1 }, { "computeEnvironment": "M4Spot", "order": 2 } ], "jobQueueName": "HighPriority" }, "output": { "jobQueueName": "HighPriority", "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority" } }, { "title": "To create a job queue with On-Demand and Spot ECS Managed Instances compute environments", "documentation": "This example creates a job queue that uses both On-Demand and Spot ECS Managed Instances compute environments. On-Demand environments must be ordered before Spot environments.", "input": { "priority": 5, "state": "ENABLED", "computeEnvironmentOrder": [ { "computeEnvironment": "my-managed-instances-ce", "order": 1 }, { "computeEnvironment": "my-spot-managed-instances-ce", "order": 2 } ], "jobQueueName": "ManagedInstancesMixedQueue" }, "output": { "jobQueueName": "ManagedInstancesMixedQueue", "jobQueueArn": "arn:aws:batch:us-east-1:123456789012:job-queue/ManagedInstancesMixedQueue" } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/createjobqueue", "code": 200 } } }, "com.amazonaws.batch#CreateJobQueueRequest": { "type": "structure", "members": { "jobQueueName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the job queue. It can be up to 128 letters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.batch#JQState", "traits": { "smithy.api#documentation": "The state of the job queue. If the job queue state is ENABLED, it is able to\n accept jobs. If the job queue state is DISABLED, new jobs can't be added to the\n queue, but jobs already in the queue can finish.
The Amazon Resource Name (ARN) of the fair-share scheduling policy. Job queues that don't have a fair-share scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a fair-share scheduling policy, it can be replaced but can't be removed.
\nThe format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .
An example is\n aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
A job queue without a fair-share scheduling policy is scheduled as a FIFO job queue and can't have a fair-share scheduling policy added. Jobs queues with a fair-share scheduling policy can have a maximum of 500 active share identifiers. When the limit has been reached, submissions of any jobs that add a new share identifier fail.
" } }, "priority": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The priority of the job queue. Job queues with a higher priority (or a higher integer\n value for the priority parameter) are evaluated first when associated with the\n same compute environment. Priority is determined in descending order. For example, a job queue\n with a priority value of 10 is given scheduling preference over a job queue with\n a priority value of 1. All of the compute environments must be either EC2\n (EC2 or SPOT) or Fargate (FARGATE or\n FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
The set of compute environments mapped to a job queue and their order relative to each\n other. The job scheduler uses this parameter to determine which compute environment runs a\n specific job. Compute environments must be in the VALID state before you can\n associate them with a job queue. You can associate up to three compute environments with a job\n queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and\n Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same\n architecture. Batch doesn't support mixing compute environment architecture types in a\n single job queue.
\nA list of service environments that this job queue can use to allocate jobs. All serviceEnvironments must have the same type. A job queue can't have both a serviceEnvironmentOrder and a computeEnvironmentOrder field.
" } }, "jobQueueType": { "target": "com.amazonaws.batch#JobQueueType", "traits": { "smithy.api#documentation": "The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.
The tags that you apply to the job queue to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources\n in Batch User Guide.
" } }, "jobStateTimeLimitActions": { "target": "com.amazonaws.batch#JobStateTimeLimitActions", "traits": { "smithy.api#documentation": "The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)
Contains the parameters for CreateJobQueue.
The name of the job queue.
", "smithy.api#required": {} } }, "jobQueueArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job queue.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#CreateQuotaShare": { "type": "operation", "input": { "target": "com.amazonaws.batch#CreateQuotaShareRequest" }, "output": { "target": "com.amazonaws.batch#CreateQuotaShareResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Creates an Batch quota share. Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.
", "smithy.api#http": { "method": "POST", "uri": "/v1/createquotashare", "code": 200 } } }, "com.amazonaws.batch#CreateQuotaShareRequest": { "type": "structure", "members": { "quotaShareName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the quota share. It can be up to 128 characters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Batch job queue associated with the quota share. This can be the job queue name or ARN.\n A job queue must be in the VALID state before you can associate it with a quota share.
A list that specifies the quantity and type of compute capacity allocated to the quota share.
", "smithy.api#required": {} } }, "resourceSharingConfiguration": { "target": "com.amazonaws.batch#QuotaShareResourceSharingConfiguration", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
", "smithy.api#required": {} } }, "preemptionConfiguration": { "target": "com.amazonaws.batch#QuotaSharePreemptionConfiguration", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Specifies the preemption behavior for jobs in a quota share.
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.batch#QuotaShareState", "traits": { "smithy.api#documentation": "The state of the quota share. If the quota share is ENABLED, it is able to accept jobs.\n If the quota share is DISABLED, new jobs won't be accepted but jobs already submitted can finish.\n The default state is ENABLED.
The tags that you apply to the quota share to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources\n in Batch User Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#CreateQuotaShareResponse": { "type": "structure", "members": { "quotaShareName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the quota share.
" } }, "quotaShareArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the quota share.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#CreateSchedulingPolicy": { "type": "operation", "input": { "target": "com.amazonaws.batch#CreateSchedulingPolicyRequest" }, "output": { "target": "com.amazonaws.batch#CreateSchedulingPolicyResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Creates an Batch scheduling policy.
", "smithy.api#http": { "method": "POST", "uri": "/v1/createschedulingpolicy", "code": 200 } } }, "com.amazonaws.batch#CreateSchedulingPolicyRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain\n uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "quotaSharePolicy": { "target": "com.amazonaws.batch#QuotaSharePolicy", "traits": { "smithy.api#documentation": "The quota share scheduling policy details. Only one of fairsharePolicy or quotaSharePolicy can be set.\n Once set, this policy type cannot be removed or changed to a fairSharePolicy.
" } }, "fairsharePolicy": { "target": "com.amazonaws.batch#FairsharePolicy", "traits": { "smithy.api#documentation": "The fair-share scheduling policy details. Only one of fairsharePolicy or quotaSharePolicy can be set.\n Once set, this policy type cannot be removed or changed to a quotaSharePolicy.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags that you apply to the scheduling policy to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services\n Resources in Amazon Web Services General Reference.
\nThese tags can be updated or removed using the TagResource and UntagResource API operations.
" } } }, "traits": { "smithy.api#documentation": "Contains the parameters for CreateSchedulingPolicy.
The name of the scheduling policy.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduling policy. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.
", "smithy.api#http": { "method": "POST", "uri": "/v1/createserviceenvironment", "code": 200 } } }, "com.amazonaws.batch#CreateServiceEnvironmentRequest": { "type": "structure", "members": { "serviceEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name for the service environment. It can be up to 128 characters long and can contain letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "serviceEnvironmentType": { "target": "com.amazonaws.batch#ServiceEnvironmentType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of service environment. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.
The state of the service environment. Valid values are ENABLED and DISABLED. The default value is ENABLED.
The capacity limits for the service environment. The number of instances a job consumes is the total number of instances requested in the submit training job request resource configuration.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags that you apply to the service environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#CreateServiceEnvironmentResponse": { "type": "structure", "members": { "serviceEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the service environment.
", "smithy.api#required": {} } }, "serviceEnvironmentArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service environment.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#DeleteComputeEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.batch#DeleteComputeEnvironmentRequest" }, "output": { "target": "com.amazonaws.batch#DeleteComputeEnvironmentResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Deletes an Batch compute environment.
\nBefore you can delete a compute environment, you must set its state to\n DISABLED with the UpdateComputeEnvironment API operation and\n disassociate it from any job queues with the UpdateJobQueue API operation.\n Compute environments that use Fargate resources must terminate all active jobs on that\n compute environment before deleting the compute environment. If this isn't done, the compute\n environment enters an invalid state.
The name or Amazon Resource Name (ARN) of the compute environment to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for DeleteComputeEnvironment.
Deletes the specified consumable resource.
", "smithy.api#examples": [ { "title": "To delete a consumable resource", "documentation": "Deletes the specified consumable resource.", "input": { "consumableResource": "myConsumableResource" }, "output": {} } ], "smithy.api#http": { "method": "POST", "uri": "/v1/deleteconsumableresource", "code": 200 } } }, "com.amazonaws.batch#DeleteConsumableResourceRequest": { "type": "structure", "members": { "consumableResource": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or ARN of the consumable resource that will be deleted.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#DeleteConsumableResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#DeleteJobQueue": { "type": "operation", "input": { "target": "com.amazonaws.batch#DeleteJobQueueRequest" }, "output": { "target": "com.amazonaws.batch#DeleteJobQueueResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Deletes the specified job queue. You must first disable submissions for a queue with the\n UpdateJobQueue operation. All jobs in the queue are eventually terminated\n when you delete a job queue.
\nIt's not necessary to disassociate compute environments from a queue before submitting a\n DeleteJobQueue request.
The short name or full Amazon Resource Name (ARN) of the queue to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for DeleteJobQueue.
Deletes the specified quota share. You must first disable submissions for the share by\n updating the state to DISABLED using the UpdateQuotaShare operation.\n All jobs in the share are eventually terminated when you delete a quota share.
The Amazon Resource Name (ARN) of the quota share.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#DeleteQuotaShareResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#DeleteSchedulingPolicy": { "type": "operation", "input": { "target": "com.amazonaws.batch#DeleteSchedulingPolicyRequest" }, "output": { "target": "com.amazonaws.batch#DeleteSchedulingPolicyResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Deletes the specified scheduling policy.
\nYou can't delete a scheduling policy that's used in any job queues.
", "smithy.api#http": { "method": "POST", "uri": "/v1/deleteschedulingpolicy", "code": 200 } } }, "com.amazonaws.batch#DeleteSchedulingPolicyRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduling policy to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for DeleteSchedulingPolicy.
Deletes a Service environment. Before you can delete a service environment, you must first set its state to DISABLED with the UpdateServiceEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.
The name or ARN of the service environment to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#DeleteServiceEnvironmentResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#DeregisterJobDefinition": { "type": "operation", "input": { "target": "com.amazonaws.batch#DeregisterJobDefinitionRequest" }, "output": { "target": "com.amazonaws.batch#DeregisterJobDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Deregisters an Batch job definition. Job definitions are permanently deleted after 180\n days.
", "smithy.api#examples": [ { "title": "To deregister a job definition", "documentation": "This example deregisters a job definition called sleep10.", "input": { "jobDefinition": "sleep10" }, "output": {} } ], "smithy.api#http": { "method": "POST", "uri": "/v1/deregisterjobdefinition", "code": 200 } } }, "com.amazonaws.batch#DeregisterJobDefinitionRequest": { "type": "structure", "members": { "jobDefinition": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition\n to deregister.
Describes one or more of your compute environments.
\nIf you're using an unmanaged compute environment, you can use the\n DescribeComputeEnvironment operation to determine the\n ecsClusterArn that you launch your Amazon ECS container instances into.
A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
" } }, "maxResults": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The maximum number of cluster results returned by DescribeComputeEnvironments\n in paginated output. When this parameter is used, DescribeComputeEnvironments\n only returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial request can be\n seen by sending another DescribeComputeEnvironments request with the returned\n nextToken value. This value can be between 1 and\n 100. If this parameter isn't used, then DescribeComputeEnvironments\n returns up to 100 results and a nextToken value if\n applicable.
The nextToken value returned from a previous paginated\n DescribeComputeEnvironments request where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nContains the parameters for DescribeComputeEnvironments.
The list of compute environments.
" } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n DescribeComputeEnvironments request. When the results of a\n DescribeComputeEnvironments request exceed maxResults, this value\n can be used to retrieve the next page of results. This value is null when there\n are no more results to return.
Returns a description of the specified consumable resource.
", "smithy.api#examples": [ { "title": "To get a description of a consumable resource", "documentation": "Returns a description of the specified consumable resource.", "input": { "consumableResource": "myConsumableResource" }, "output": { "consumableResourceName": "myConsumableResource", "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource", "totalQuantity": 123, "inUseQuantity": 123, "availableQuantity": 123, "resourceType": "REPLENISHABLE", "createdAt": 123, "tags": { "Department": "Engineering", "User": "JaneDoe" } } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/describeconsumableresource", "code": 200 } } }, "com.amazonaws.batch#DescribeConsumableResourceRequest": { "type": "structure", "members": { "consumableResource": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or ARN of the consumable resource whose description will be returned.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#DescribeConsumableResourceResponse": { "type": "structure", "members": { "consumableResourceName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the consumable resource.
", "smithy.api#required": {} } }, "consumableResourceArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumable resource.
", "smithy.api#required": {} } }, "totalQuantity": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The total amount of the consumable resource that is available.
" } }, "inUseQuantity": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The amount of the consumable resource that is currently in use.
" } }, "availableQuantity": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The amount of the consumable resource that is currently available to use.
" } }, "resourceType": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Indicates whether the resource is available to be re-used after a job completes. Can be \n one of:
\n\n REPLENISHABLE\n
\n NON_REPLENISHABLE\n
The Unix timestamp (in milliseconds) for when the consumable resource was created.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags that you apply to the consumable resource to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#DescribeJobDefinitions": { "type": "operation", "input": { "target": "com.amazonaws.batch#DescribeJobDefinitionsRequest" }, "output": { "target": "com.amazonaws.batch#DescribeJobDefinitionsResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Describes a list of job definitions. You can specify a status (such as\n ACTIVE) to only return job definitions that match that status.
A list of up to 100 job definitions. Each entry in the list can either be an ARN in the\n format\n arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}\n or a short version using the form ${JobDefinitionName}:${Revision}. This\n parameter can't be used with other parameters.
The maximum number of results returned by DescribeJobDefinitions in paginated\n output. When this parameter is used, DescribeJobDefinitions only returns\n maxResults results in a single page and a nextToken response\n element. The remaining results of the initial request can be seen by sending another\n DescribeJobDefinitions request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter isn't\n used, then DescribeJobDefinitions returns up to 100 results and\n a nextToken value if applicable.
The name of the job definition to describe.
" } }, "status": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The status used to filter job definitions.
" } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value returned from a previous paginated\n DescribeJobDefinitions request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nContains the parameters for DescribeJobDefinitions.
The list of job definitions.
" } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n DescribeJobDefinitions request. When the results of a\n DescribeJobDefinitions request exceed maxResults, this value can\n be used to retrieve the next page of results. This value is null when there are\n no more results to return.
Describes one or more of your job queues.
", "smithy.api#examples": [ { "title": "To describe a job queue", "documentation": "This example describes the HighPriority job queue.", "input": { "jobQueues": [ "HighPriority" ] }, "output": { "jobQueues": [ { "jobQueueName": "HighPriority", "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", "state": "ENABLED", "status": "VALID", "statusReason": "JobQueue Healthy", "priority": 1, "computeEnvironmentOrder": [ { "order": 1, "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand" } ] } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/describejobqueues", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "jobQueues", "pageSize": "maxResults" } } }, "com.amazonaws.batch#DescribeJobQueuesRequest": { "type": "structure", "members": { "jobQueues": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
" } }, "maxResults": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The maximum number of results returned by DescribeJobQueues in paginated\n output. When this parameter is used, DescribeJobQueues only returns\n maxResults results in a single page and a nextToken response\n element. The remaining results of the initial request can be seen by sending another\n DescribeJobQueues request with the returned nextToken value. This\n value can be between 1 and 100. If this parameter isn't used,\n then DescribeJobQueues returns up to 100 results and a\n nextToken value if applicable.
The nextToken value returned from a previous paginated\n DescribeJobQueues request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nContains the parameters for DescribeJobQueues.
The list of job queues.
" } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future DescribeJobQueues\n request. When the results of a DescribeJobQueues request exceed\n maxResults, this value can be used to retrieve the next page of results. This\n value is null when there are no more results to return.
Describes a list of Batch jobs.
", "smithy.api#examples": [ { "title": "To describe a specific job", "documentation": "This example describes a job with the specified job ID.", "input": { "jobs": [ "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9" ] }, "output": { "jobs": [ { "jobName": "example", "jobId": "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9", "jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", "status": "SUCCEEDED", "createdAt": 1480460782010, "startedAt": 1480460816500, "stoppedAt": 1480460880699, "dependsOn": [], "jobDefinition": "sleep60", "parameters": {}, "container": { "image": "busybox", "vcpus": 1, "memory": 128, "command": [ "sleep", "60" ], "volumes": [], "environment": [], "mountPoints": [], "ulimits": [], "exitCode": 0, "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c" } } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/describejobs", "code": 200 } } }, "com.amazonaws.batch#DescribeJobsRequest": { "type": "structure", "members": { "jobs": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of up to 100 job IDs.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for DescribeJobs.
The list of jobs.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#DescribeQuotaShare": { "type": "operation", "input": { "target": "com.amazonaws.batch#DescribeQuotaShareRequest" }, "output": { "target": "com.amazonaws.batch#DescribeQuotaShareResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Returns a description of the specified quota share.
", "smithy.api#http": { "method": "POST", "uri": "/v1/describequotashare", "code": 200 } } }, "com.amazonaws.batch#DescribeQuotaShareRequest": { "type": "structure", "members": { "quotaShareArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the quota share.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#DescribeQuotaShareResponse": { "type": "structure", "members": { "quotaShareName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the quota share.
" } }, "quotaShareArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the quota share.
" } }, "jobQueueArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The ARN of the job queue associated with the quota share.
" } }, "capacityLimits": { "target": "com.amazonaws.batch#QuotaShareCapacityLimits", "traits": { "smithy.api#documentation": "A list that specifies the quantity and type of compute capacity allocated to the quota share.
" } }, "resourceSharingConfiguration": { "target": "com.amazonaws.batch#QuotaShareResourceSharingConfiguration", "traits": { "smithy.api#documentation": "Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
" } }, "preemptionConfiguration": { "target": "com.amazonaws.batch#QuotaSharePreemptionConfiguration", "traits": { "smithy.api#documentation": "Specifies the preemption behavior for jobs in a quota share.
" } }, "state": { "target": "com.amazonaws.batch#QuotaShareState", "traits": { "smithy.api#documentation": "The state of the quota share.
" } }, "status": { "target": "com.amazonaws.batch#QuotaShareStatus", "traits": { "smithy.api#documentation": "The current status of the quota share.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags applied to the quota share.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#DescribeSchedulingPolicies": { "type": "operation", "input": { "target": "com.amazonaws.batch#DescribeSchedulingPoliciesRequest" }, "output": { "target": "com.amazonaws.batch#DescribeSchedulingPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Describes one or more of your scheduling policies.
", "smithy.api#http": { "method": "POST", "uri": "/v1/describeschedulingpolicies", "code": 200 } } }, "com.amazonaws.batch#DescribeSchedulingPoliciesRequest": { "type": "structure", "members": { "arns": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for DescribeSchedulingPolicies.
The list of scheduling policies.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#DescribeServiceEnvironments": { "type": "operation", "input": { "target": "com.amazonaws.batch#DescribeServiceEnvironmentsRequest" }, "output": { "target": "com.amazonaws.batch#DescribeServiceEnvironmentsResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Describes one or more of your service environments.
", "smithy.api#http": { "method": "POST", "uri": "/v1/describeserviceenvironments", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "serviceEnvironments", "pageSize": "maxResults" } } }, "com.amazonaws.batch#DescribeServiceEnvironmentsRequest": { "type": "structure", "members": { "serviceEnvironments": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "An array of service environment names or ARN entries.
" } }, "maxResults": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The maximum number of results returned by DescribeServiceEnvironments in paginated output. When this parameter is used, DescribeServiceEnvironments only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeServiceEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeServiceEnvironments returns up to 100 results and a nextToken value if applicable.
The nextToken value returned from a previous paginated DescribeServiceEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of service environments that match the request.
" } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future DescribeServiceEnvironments request. When the results of a DescribeServiceEnvironments request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The details of a service job.
", "smithy.api#http": { "method": "POST", "uri": "/v1/describeservicejob", "code": 200 } } }, "com.amazonaws.batch#DescribeServiceJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job ID for the service job to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#DescribeServiceJobResponse": { "type": "structure", "members": { "attempts": { "target": "com.amazonaws.batch#ServiceJobAttemptDetails", "traits": { "smithy.api#documentation": "A list of job attempts associated with the service job.
" } }, "capacityUsage": { "target": "com.amazonaws.batch#ServiceJobCapacityUsageDetailList", "traits": { "smithy.api#documentation": "The configured capacity for the service job, such as the number of instances. The\n number of instances should be the same value as the\n serviceRequestPayload.InstanceCount field.
The Unix timestamp (in milliseconds) for when the service job was created.
" } }, "isTerminated": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the service job has been terminated.
" } }, "jobArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service job.
" } }, "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job ID for the service job.
", "smithy.api#required": {} } }, "jobName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the service job.
", "smithy.api#required": {} } }, "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ARN of the job queue that the service job is associated with.
", "smithy.api#required": {} } }, "latestAttempt": { "target": "com.amazonaws.batch#LatestServiceJobAttempt", "traits": { "smithy.api#documentation": "The latest attempt associated with the service job.
" } }, "retryStrategy": { "target": "com.amazonaws.batch#ServiceJobRetryStrategy", "traits": { "smithy.api#documentation": "The retry strategy to use for failed service jobs that are submitted with this service job.
" } }, "scheduledAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job was scheduled. This\n represents when the service job was dispatched to SageMaker and the service job transitioned to the\n SCHEDULED state.
The scheduling priority of the service job.
" } }, "serviceRequestPayload": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The request, in JSON, for the service that the SubmitServiceJob operation is queueing.
The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
The share identifier for the service job. This is used for fair-share scheduling.
" } }, "quotaShareName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the quota share that the service job is associated with.
" } }, "preemptionConfiguration": { "target": "com.amazonaws.batch#ServiceJobPreemptionConfiguration", "traits": { "smithy.api#documentation": "Specifies the service job behavior when preempted.
" } }, "preemptionSummary": { "target": "com.amazonaws.batch#ServiceJobPreemptionSummary", "traits": { "smithy.api#documentation": "Summarizes the preemptions of the service job. This field appears on a service job\n when it has been preempted.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job was started.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.batch#ServiceJobStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The current status of the service job.
", "smithy.api#required": {} } }, "statusReason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short, human-readable string to provide more details for the current status of the service job.
" } }, "stoppedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job stopped running.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags that are associated with the service job. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
" } }, "timeoutConfig": { "target": "com.amazonaws.batch#ServiceJobTimeout", "traits": { "smithy.api#documentation": "The timeout configuration for the service job.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#Device": { "type": "structure", "members": { "hostPath": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The path for the device on the host container instance.
", "smithy.api#required": {} } }, "containerPath": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The path inside the container that's used to expose the host device. By default, the\n hostPath value is used.
The explicit permissions to provide to the container for the device. By default, the\n container has permissions for read, write, and mknod for\n the device.
An object that represents a container instance host device.
\nThis object isn't applicable to jobs that are running on Fargate resources and shouldn't\n be provided.
\nThe Amazon EFS access point ID to use. If an access point is specified, the root directory value\n specified in the EFSVolumeConfiguration must either be omitted or set to\n / which enforces the path set on the EFS access point. If an access point is used,\n transit encryption must be enabled in the EFSVolumeConfiguration. For more\n information, see Working\n with Amazon EFS access points in the Amazon Elastic File System User Guide.
Whether or not to use the Batch job IAM role defined in a job definition when mounting the\n Amazon EFS file system. If enabled, transit encryption must be enabled in the\n EFSVolumeConfiguration. If this parameter is omitted, the default value of\n DISABLED is used. For more information, see Using Amazon EFS access points in\n the Batch User Guide. EFS IAM authorization requires that\n TransitEncryption be ENABLED and that a JobRoleArn is\n specified.
The authorization configuration details for the Amazon EFS file system.
" } }, "com.amazonaws.batch#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.batch#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.batch#EFSVolumeConfiguration": { "type": "structure", "members": { "fileSystemId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon EFS file system ID to use.
", "smithy.api#required": {} } }, "rootDirectory": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The directory within the Amazon EFS file system to mount as the root directory inside the host.\n If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying\n / has the same effect as omitting this parameter. The maximum length is 4,096\n characters.
If an EFS access point is specified in the authorizationConfig, the root\n directory parameter must either be omitted or set to /, which enforces the path set\n on the Amazon EFS access point.
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and\n the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If\n this parameter is omitted, the default value of DISABLED is used. For more\n information, see Encrypting data in transit in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If\n you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS\n mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the\n Amazon Elastic File System User Guide.
" } }, "authorizationConfig": { "target": "com.amazonaws.batch#EFSAuthorizationConfig", "traits": { "smithy.api#documentation": "The authorization configuration details for the Amazon EFS file system.
" } } }, "traits": { "smithy.api#documentation": "This is used when you're using an Amazon Elastic File System file system for job storage. For more\n information, see Amazon EFS\n Volumes in the Batch User Guide.
" } }, "com.amazonaws.batch#Ec2Configuration": { "type": "structure", "members": { "imageType": { "target": "com.amazonaws.batch#ImageType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The image type to match with the instance type to select an AMI. The supported values are\n different for ECS and EKS resources.
If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2023 AMI (ECS_AL2023) is used. If a new image type is\n specified in an update, but neither an imageId nor a imageIdOverride\n parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's\n supported by Batch is used.
Amazon Web Services is ending support for Amazon ECS Amazon Linux 2-optimized and accelerated AMIs on June 30,\n 2026. On January 12, 2026, Batch changed the default AMI for new Amazon ECS compute environments\n from Amazon Linux 2 to Amazon Linux 2023. Effective June 30, 2026, Batch will block creation\n of new Amazon ECS compute environments using Batch-provided Amazon Linux 2 AMIs. We strongly recommend\n migrating your existing Batch Amazon ECS compute environments to Amazon Linux 2023 prior to June 30,\n 2026. For more information on upgrading from AL2 to AL2023, see How to migrate\n from ECS AL2 to ECS AL2023 in the Batch User Guide.
\n\n Amazon Linux\n 2: Used for non-GPU instance families.
\n\n Amazon Linux 2\n (GPU): Used for GPU instance families (for example P4 and\n G4) and non Amazon Web Services Graviton-based instance types.
\n Amazon Linux 2023: Default \n for all non-GPU instance families.
\nAmazon Linux 2023 does not support A1 instances.
\n Amazon Linux 2023\n (GPU): Default for all GPU instance families and can be used for all non Amazon Web Services Graviton-based instance types.
\nECS_AL2023_NVIDIA doesn't support p3 and g3 instance types.
If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux 2023\n AMI (EKS_AL2023) is used. If a new image type is specified in an update,\n but neither an imageId nor a imageIdOverride parameter is specified,\n then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.
Amazon Linux 2023 AMIs are the\n default on Batch for Amazon EKS.
\nAmazon Web Services ended support for Amazon EKS AL2-optimized and AL2-accelerated AMIs on November 26,\n 2025. Batch Amazon EKS compute environments using Amazon Linux 2 will no longer receive software\n updates, security patches, or bug fixes from Amazon Web Services. We recommend migrating to Amazon Linux\n 2023. For more information on upgrading from AL2 to AL2023, see How to upgrade from EKS AL2 to EKS AL2023 in the Batch User Guide.
\n\n Amazon\n Linux 2: Used for non-GPU instance families.
\n\n Amazon\n Linux 2 (accelerated): Used for GPU instance families (for example,\n P4 and G4) and can be used for all non Amazon Web Services Graviton-based\n instance types.
\n Amazon\n Linux 2023: Default for non-GPU instance families.
\nAmazon Linux 2023 does not support A1 instances.
\n Amazon\n Linux 2023 (accelerated): Default for GPU instance families and can be used for all non Amazon Web Services\n Graviton-based instance types.
\nThe AMI ID used for instances launched in the compute environment that match the image type.\n This setting overrides the imageId set in the computeResource\n object.
The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2023 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2023 AMI\n in the Amazon Elastic Container Service Developer Guide.
\nThe status of the Batch-provided default AMIs associated with the imageType.
The field only appears after the compute environment has begun scaling instances using the imageType. The field is not present when an image is specified in\n ComputeResources.imageId (deprecated), the default launch template, or\n Ec2Configuration.imageIdOverride. The field is also not present when the compute environment has a launch template override.\n \n \n For more information on image selection, see AMI selection order.
This field is read-only and only appears in the DescribeComputeEnvironments response.
\n\n LATEST \u2212 Using the most recent AMI supported
\n UPDATE_AVAILABLE \u2212 An updated AMI is available
If a compute environment has multiple AMIs for the imageType and any one AMI has UPDATE_AVAILABLE, the status shows UPDATE_AVAILABLE.
For compute environments that use BEST_FIT as their allocation strategy,\n you can perform a blue/green update to update the AMI.
For all other compute environments, you can perform an\n AMI version update to update the AMI to the latest version.
\nThe Kubernetes version for the compute environment. If you don't specify a value, the latest\n version that Batch supports is used.
" } } }, "traits": { "smithy.api#documentation": "Provides information used to select Amazon Machine Images (AMIs) for instances in the\n compute environment. If Ec2Configuration isn't specified, the default is\n ECS_AL2023 (Amazon ECS-optimized Amazon Linux 2023) for EC2 (ECS) compute environments and EKS_AL2023 (Amazon EKS-optimized Amazon Linux 2023\n AMI) for EKS compute environments.
This object isn't applicable to jobs that are running on Fargate resources.
\nAn object that contains the properties for the Amazon ECS task definition of a job.
\nThis object is currently limited to one task element. However, the task element can run up to 10 containers.
\nAn object that contains the properties for the Amazon ECS resources of a job.
" } }, "com.amazonaws.batch#EcsPropertiesDetail": { "type": "structure", "members": { "taskProperties": { "target": "com.amazonaws.batch#ListEcsTaskDetails", "traits": { "smithy.api#documentation": "The properties for the Amazon ECS task definition of a job.
" } } }, "traits": { "smithy.api#documentation": "An object that contains the details for the Amazon ECS resources of a job.
" } }, "com.amazonaws.batch#EcsPropertiesOverride": { "type": "structure", "members": { "taskProperties": { "target": "com.amazonaws.batch#ListTaskPropertiesOverride", "traits": { "smithy.api#documentation": "The overrides for the Amazon ECS task definition of a job.
\nThis object is currently limited to one element.
\nAn object that contains overrides for the Amazon ECS task definition of a job.
" } }, "com.amazonaws.batch#EcsSettings": { "type": "structure", "members": { "containerInsights": { "target": "com.amazonaws.batch#ContainerInsights", "traits": { "smithy.api#documentation": "Specifies the CloudWatch Container Insights mode for the compute environment. Valid values\n are:
\nTurns on standard Container Insights, which collects CPU, memory, disk, and network\n utilization metrics for the compute environment.
\nTurns on enhanced Container Insights, which collects the standard metrics along with\n additional per-task observability metrics.
\nTurns off Container Insights for the compute environment.
\nIf you don't specify a value, the default is DISABLED. For more information,\n see Container Insights in the\n Batch User Guide.
The Amazon ECS settings for a compute environment, including the CloudWatch Container Insights\n mode. Use this structure with CreateComputeEnvironment and\n UpdateComputeEnvironment.
A list of containers that are included in the taskProperties list.
The Amazon Resource Name (ARN) of the container instance that hosts the task.
" } }, "taskArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The ARN of the Amazon ECS task.
" } }, "ephemeralStorage": { "target": "com.amazonaws.batch#EphemeralStorage", "traits": { "smithy.api#documentation": "The amount of ephemeral storage allocated for the task.
" } }, "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see\n Batch execution IAM\n role in the Batch User Guide.
" } }, "platformVersion": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Fargate platform version where the jobs are running.
" } }, "ipcMode": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. For more information see ipcMode in EcsTaskProperties.
The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more\n information, see IAM roles for tasks in the\n Amazon Elastic Container Service Developer Guide.
\nThis is object is comparable to ContainerProperties:jobRoleArn.
\nThe process namespace to use for the containers in the task. The valid values are\n host, or task. For more information see pidMode in EcsTaskProperties.
The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on Amazon EC2 resources must not specify this parameter.
" } }, "runtimePlatform": { "target": "com.amazonaws.batch#RuntimePlatform", "traits": { "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on\n Fargate or Amazon ECS Managed Instances. Contains the operating system family and CPU architecture\n of the task.
" } }, "volumes": { "target": "com.amazonaws.batch#Volumes", "traits": { "smithy.api#documentation": "A list of data volumes used in a job.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Determines whether execute command functionality is turned on for this task. If true, execute\n command functionality is turned on all the containers in the task.
The network mode configured for the task. This field is populated for jobs running on Amazon ECS\n Managed Instances (MANAGED_INSTANCES platform capability) and always returns\n host.
The details of a task definition that describes the container and volume definitions of an\n Amazon ECS task.
" } }, "com.amazonaws.batch#EcsTaskProperties": { "type": "structure", "members": { "containers": { "target": "com.amazonaws.batch#ListTaskContainerProperties", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "This object is a list of containers.
", "smithy.api#required": {} } }, "ephemeralStorage": { "target": "com.amazonaws.batch#EphemeralStorage", "traits": { "smithy.api#documentation": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand\n the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\n Fargate.
" } }, "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate\n resources, you must provide an execution role. For more information, see Batch execution IAM role\n in the Batch User Guide.
" } }, "platformVersion": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Fargate platform version where the jobs are running. A platform version is specified\n only for jobs that are running on Fargate resources. If one isn't specified, the\n LATEST platform version is used by default. This uses a recent, approved version of\n the Fargate platform for compute resources. For more information, see Fargate\n platform versions in the Amazon Elastic Container Service Developer Guide.
The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none.
If host is specified, all containers within the tasks that specified the\n host IPC mode on the same container instance share the same IPC resources with the\n host Amazon EC2 instance.
If task is specified, all containers within the specified task\n share the same IPC resources.
If none is specified, the IPC resources within the containers of a task are\n private, and are not shared with other containers in a task or on the container instance.
If no value is specified, then the IPC resource namespace sharing depends on the Docker\n daemon setting on the container instance. For more information, see IPC settings in\n the Docker run reference.
\nThis parameter is not supported for jobs that run on Fargate resources.
\nThe Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
\nThis is object is comparable to ContainerProperties:jobRoleArn.
\nThe process namespace to use for the containers in the task. The valid values are\n host or task. For example, monitoring sidecars might need\n pidMode to access information about other containers running in the same\n task.
If host is specified, all containers within the tasks that specified the\n host PID mode on the same container instance share the process namespace with the\n host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same\n process namespace.
If no value is specified, the default is a private namespace for each container. For more\n information, see PID settings in the Docker run reference.
" } }, "networkConfiguration": { "target": "com.amazonaws.batch#NetworkConfiguration", "traits": { "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on Amazon EC2 resources or Amazon ECS Managed Instances must not specify this parameter.
" } }, "runtimePlatform": { "target": "com.amazonaws.batch#RuntimePlatform", "traits": { "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on\n Fargate or Amazon ECS Managed Instances. Use this to specify the operating system family\n (operatingSystemFamily) and CPU architecture\n (cpuArchitecture).
For Amazon ECS Managed Instances, the valid value for operatingSystemFamily is\n LINUX (default). The valid values for cpuArchitecture are\n X86_64 and ARM64.
A list of volumes that are associated with the job.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Determines whether execute command functionality is turned on for this task. If true, execute\n command functionality is turned on all the containers in the task.
The network mode to use for the task. Valid values: host. When not specified,\n the default is host.
With host mode, the container shares the host instance's network stack\n directly. When running tasks that use the host network mode, do not run containers\n using the root user (UID 0). Running as root grants unrestricted access to host resources and\n increases the attack surface.
This parameter only applies to jobs running on Amazon ECS Managed Instances\n (MANAGED_INSTANCES platform capability). It cannot be specified for Fargate or\n Amazon EC2 platform job definitions.
The properties for a task definition that describes the container and volume definitions of\n an Amazon ECS task. You can specify which Docker images to use, the required resources, and other\n configurations related to launching the task definition through an Amazon ECS service or task.
" } }, "com.amazonaws.batch#EksAccessEntry": { "type": "structure", "members": { "desiredState": { "target": "com.amazonaws.batch#EksAccessEntryDesiredState", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The desired access entry state for the compute environment. Valid values:
\nBatch manages an access entry on the cluster for the compute environment.
\nBatch deletes the Batch-managed access entry for the cluster. This value is rejected if the cluster's\n authenticationMode is API, because such a cluster doesn't support\n the aws-auth ConfigMap.
Batch defers to the cluster's current access entry status. On a cluster whose\n authentication mode is API, Batch creates and manages an access entry. On a\n cluster whose authentication mode is API_AND_CONFIG_MAP or\n CONFIG_MAP, Batch neither adds nor removes an access entry.
The observed state of the access entry on the cluster. ACTIVE means that an\n access entry for the compute environment exists on the cluster and takes\n precedence over the aws-auth ConfigMap. INACTIVE means that no\n Batch-managed access entry is present. This is a read-only field returned by\n DescribeComputeEnvironments.
Configures whether Batch manages an Amazon EKS access entry on the cluster for the compute\n environment. For information on how the fields interact with the cluster's\n authenticationMode and with other compute environments that share the cluster,\n see Amazon EKS access entry\n authentication in the Batch User Guide.
Setting desiredState=ENABLED on a single compute environment does not guarantee that Batch creates an access\n entry, and setting desiredState=DISABLED on a single compute environment does not guarantee that Batch deletes\n one. Batch compares the desiredState across all compute environments that\n target the same cluster. The Batch-managed access entry is created only when all compute environments have\n desiredState=ENABLED, and deleted only when all have\n desiredState=DISABLED. If you have multiple compute environments on the same\n cluster, set desiredState consistently across all of them to avoid uncertainty.\n For more information, see Reconciling\n desiredState across compute environments in the\n Batch User Guide.
The desired state for the Batch-managed Amazon EKS access entry on a compute environment.
" } }, "com.amazonaws.batch#EksAccessEntryStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } } }, "traits": { "smithy.api#documentation": "The observed state of the Batch-managed Amazon EKS access entry on a compute environment.
" } }, "com.amazonaws.batch#EksAnnotationsMap": { "type": "map", "key": { "target": "com.amazonaws.batch#String" }, "value": { "target": "com.amazonaws.batch#String" } }, "com.amazonaws.batch#EksAttemptContainerDetail": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of a container.
" } }, "containerID": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The ID for the container.
" } }, "exitCode": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The exit code returned for the job attempt. A non-zero exit code is considered\n failed.
" } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a\n running or stopped container.
" } } }, "traits": { "smithy.api#documentation": "An object that represents the details for an attempt for a job attempt that an Amazon EKS\n container runs.
" } }, "com.amazonaws.batch#EksAttemptContainerDetails": { "type": "list", "member": { "target": "com.amazonaws.batch#EksAttemptContainerDetail" } }, "com.amazonaws.batch#EksAttemptDetail": { "type": "structure", "members": { "containers": { "target": "com.amazonaws.batch#EksAttemptContainerDetails", "traits": { "smithy.api#documentation": "The details for the final status of the containers for this job attempt.
" } }, "initContainers": { "target": "com.amazonaws.batch#EksAttemptContainerDetails", "traits": { "smithy.api#documentation": "The details for the init containers.
" } }, "eksClusterArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EKS cluster.
" } }, "podName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the pod for this job attempt.
" } }, "podNamespace": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The namespace of the Amazon EKS cluster that the pod exists in.
" } }, "nodeName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the node for this job attempt.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt\n transitioned from the STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the\n attempt transitioned from the RUNNING state to a terminal state, such as\n SUCCEEDED or FAILED.
A short, human-readable string to provide additional details for the current status of the\n job attempt.
" } } }, "traits": { "smithy.api#documentation": "An object that represents the details of a job attempt for a job attempt by an Amazon EKS\n container.
" } }, "com.amazonaws.batch#EksAttemptDetails": { "type": "list", "member": { "target": "com.amazonaws.batch#EksAttemptDetail" } }, "com.amazonaws.batch#EksConfiguration": { "type": "structure", "members": { "eksClusterArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is\n arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch\n .\n
The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value\n can't left empty or null. It must be fewer than 64 characters long, can't be set to\n default, can't start with \"kube-,\" and must match this regular\n expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.
The Batch-managed Amazon EKS access entry for the compute environment. Set\n desiredState to declare whether Batch manages an access entry on the cluster. In\n a DescribeComputeEnvironments response, desiredState is the value that\n Batch recorded for the compute environment and status is the observed state of\n the access entry on the cluster. To change the access entry on an existing compute environment,\n use \n EksConfigurationUpdate.accessEntry\n .
Whether the entry is provisioned on the cluster depends on the cluster's\n authenticationMode and the desiredState recorded for each Batch compute\n environment targeting the cluster. For more information,\n see Amazon EKS access entry\n authentication in the Batch User Guide.
If you don't specify this field, Batch doesn't record a desiredState for the\n compute environment and DescribeComputeEnvironments doesn't return one. For the\n purpose of provisioning the access entry, Batch behaves as it does for\n INHERIT_FROM_CLUSTER.
Configuration for the Amazon EKS cluster that supports the Batch compute environment. The\n cluster must exist before the compute environment can be created.
" } }, "com.amazonaws.batch#EksConfigurationUpdate": { "type": "structure", "members": { "accessEntry": { "target": "com.amazonaws.batch#EksAccessEntry", "traits": { "smithy.api#documentation": "The updated access entry configuration for the compute environment. Set\n desiredState to declare whether Batch will manage an access entry on the cluster.\n For the accepted values, see \n EksAccessEntry\n .
An object that represents the attributes of an Batch compute environment's Amazon EKS\n configuration that can be updated. Currently accessEntry is the only attribute that you can\n change after the compute environment is created. For more information, see Amazon EKS access entry\n authentication in the Batch User Guide.
The name of the container. If the name isn't specified, the default name\n \"Default\" is used. Each container in a pod must have a unique name.
The Docker image used to start the container.
", "smithy.api#required": {} } }, "imagePullPolicy": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The image pull policy for the container. Supported values are Always,\n IfNotPresent, and Never. This parameter defaults to\n IfNotPresent. However, if the :latest tag is specified, it defaults to\n Always. For more information, see Updating\n images in the Kubernetes documentation.
The entrypoint for the container. This isn't run within a shell. If this isn't specified,\n the ENTRYPOINT of the container image is used. Environment variable references are\n expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't\n changed. For example, if the reference is to \"$(NAME1)\" and the NAME1\n environment variable doesn't exist, the command string will remain \"$(NAME1).\"\n $$ is replaced with $ and the resulting string isn't expanded. For\n example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the\n VAR_NAME environment variable exists. The entrypoint can't be updated. For more\n information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.
An array of arguments to the entrypoint. If this isn't specified, the CMD of\n the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod\n in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't\n changed. For example, if the reference is to \"$(NAME1)\" and the NAME1\n environment variable doesn't exist, the command string will remain \"$(NAME1).\"\n $$ is replaced with $, and the resulting string isn't expanded. For\n example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the\n VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD\n and Define a command and arguments for a pod in the Kubernetes\n documentation.
The environment variables to pass to a container.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The type and amount of resources to assign to a container. The supported resources include\n memory, cpu, and nvidia.com/gpu. For more information,\n see Resource management for pods and containers in the Kubernetes\n documentation.
The volume mounts for the container. Batch supports emptyDir,\n hostPath, and secret volume types. For more information about volumes\n and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
The security context for a job. For more information, see Configure a\n security context for a pod or container in the Kubernetes\n documentation.
" } } }, "traits": { "smithy.api#documentation": "EKS container properties are used in job definitions for Amazon EKS based job definitions to\n describe the properties for a container node in the pod that's launched as part of a job. This\n can't be specified for Amazon ECS based job definitions.
" } }, "com.amazonaws.batch#EksContainerDetail": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the container. If the name isn't specified, the default name\n \"Default\" is used. Each container in a pod must have a unique name.
The Docker image used to start the container.
" } }, "imagePullPolicy": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The image pull policy for the container. Supported values are Always,\n IfNotPresent, and Never. This parameter defaults to\n Always if the :latest tag is specified, IfNotPresent\n otherwise. For more information, see Updating\n images in the Kubernetes documentation.
The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
" } }, "args": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "An array of arguments to the entrypoint. If this isn't specified, the CMD of\n the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod\n in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't\n changed. For example, if the reference is to \"$(NAME1)\" and the NAME1\n environment variable doesn't exist, the command string will remain \"$(NAME1)\".\n $$ is replaced with $ and the resulting string isn't expanded. For\n example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the\n VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD\n and Define a command and arguments for a pod in the Kubernetes\n documentation.
The environment variables to pass to a container.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The type and amount of resources to assign to a container. The supported resources include\n memory, cpu, and nvidia.com/gpu. For more information,\n see Resource management for pods and containers in the Kubernetes\n documentation.
The exit code returned for the job attempt. A non-zero exit code is considered\n failed.
" } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short human-readable string to provide additional details for a running or stopped\n container. It can be up to 255 characters long.
" } }, "volumeMounts": { "target": "com.amazonaws.batch#EksContainerVolumeMounts", "traits": { "smithy.api#documentation": "The volume mounts for the container. Batch supports emptyDir,\n hostPath, and secret volume types. For more information about volumes\n and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
The security context for a job. For more information, see Configure a\n security context for a pod or container in the Kubernetes\n documentation.
" } } }, "traits": { "smithy.api#documentation": "The details for container properties that are returned by DescribeJobs for jobs\n that use Amazon EKS.
The name of the environment variable.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The value of the environment variable.
" } } }, "traits": { "smithy.api#documentation": "An environment variable.
" } }, "com.amazonaws.batch#EksContainerEnvironmentVariables": { "type": "list", "member": { "target": "com.amazonaws.batch#EksContainerEnvironmentVariable" } }, "com.amazonaws.batch#EksContainerLinuxCapabilities": { "type": "structure", "members": { "add": { "target": "com.amazonaws.batch#EksContainerLinuxCapabilityList", "traits": { "smithy.api#documentation": "The Linux capabilities to add to the default capability set for the container. This\n parameter contains up to 64 values. Specify capability names without the CAP_\n prefix.
The Linux capabilities to remove from the default capability set for the container. This\n parameter contains up to 64 values. Specify capability names without the CAP_\n prefix.
The Linux capabilities for the container. For more information, see Set capabilities for a container in the Kubernetes\n documentation.
" } }, "com.amazonaws.batch#EksContainerLinuxCapability": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.batch#EksContainerLinuxCapabilityList": { "type": "list", "member": { "target": "com.amazonaws.batch#EksContainerLinuxCapability" }, "traits": { "smithy.api#length": { "min": 0, "max": 64 } } }, "com.amazonaws.batch#EksContainerOverride": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A pointer to the container that you want to override. The name must match a unique container\n name that you wish to override.
" } }, "image": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The override of the Docker image that's used to start the container.
" } }, "command": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "The command to send to the container that overrides the default command from the Docker\n image or the job definition.
" } }, "args": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "The arguments to the entrypoint to send to the container that overrides the default\n arguments from the Docker image or the job definition. For more information, see Dockerfile reference: CMD\n and Define a command an arguments for a pod in the Kubernetes\n documentation.
" } }, "env": { "target": "com.amazonaws.batch#EksContainerEnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables to send to the container. You can add new environment variables,\n which are added to the container at launch. Or, you can override the existing environment\n variables from the Docker image or the job definition.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The type and amount of resources to assign to a container. These override the settings in\n the job definition. The supported resources include memory, cpu, and\n nvidia.com/gpu. For more information, see Resource\n management for pods and containers in the Kubernetes\n documentation.
Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API\n operation.
" } }, "com.amazonaws.batch#EksContainerOverrideList": { "type": "list", "member": { "target": "com.amazonaws.batch#EksContainerOverride" } }, "com.amazonaws.batch#EksContainerResourceRequirements": { "type": "structure", "members": { "limits": { "target": "com.amazonaws.batch#EksLimits", "traits": { "smithy.api#documentation": "The type and quantity of the resources to reserve for the container. The values vary based\n on the name that's specified. Resources can be requested using either the\n limits or the requests objects.
The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\"\n suffix. If your container attempts to exceed the memory specified, the container is\n terminated. You must specify at least 4 MiB of memory for a job. memory can be\n specified in limits, requests, or both. If memory is\n specified in both places, then the value that's specified in limits must be equal\n to the value that's specified in requests.
To maximize your resource utilization, provide your jobs with as much memory as possible\n for the specific instance type that you are using. To learn how, see Memory management in the\n Batch User Guide.
\nThe number of CPUs that's reserved for the container. Values must be an even multiple of\n 0.25. cpu can be specified in limits,\n requests, or both. If cpu is specified in both places, then the\n value that's specified in limits must be at least as large as the value that's\n specified in requests.
The number of GPUs that's reserved for the container. Values must be a whole integer.\n memory can be specified in limits, requests, or both.\n If memory is specified in both places, then the value that's specified in\n limits must be equal to the value that's specified in\n requests.
The type and quantity of the resources to request for the container. The values vary based\n on the name that's specified. Resources can be requested by using either the\n limits or the requests objects.
The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\"\n suffix. If your container attempts to exceed the memory specified, the container is\n terminated. You must specify at least 4 MiB of memory for a job. memory can be\n specified in limits, requests, or both. If memory is\n specified in both, then the value that's specified in limits must be equal to the\n value that's specified in requests.
If you're trying to maximize your resource utilization by providing your jobs as much\n memory as possible for a particular instance type, see Memory management in the\n Batch User Guide.
\nThe number of CPUs that are reserved for the container. Values must be an even multiple\n of 0.25. cpu can be specified in limits,\n requests, or both. If cpu is specified in both, then the value\n that's specified in limits must be at least as large as the value that's\n specified in requests.
The number of GPUs that are reserved for the container. Values must be a whole integer.\n nvidia.com/gpu can be specified in limits, requests,\n or both. If nvidia.com/gpu is specified in both, then the value that's specified\n in limits must be equal to the value that's specified in\n requests.
The type and amount of resources to assign to a container. The supported resources include\n memory, cpu, and nvidia.com/gpu. For more information,\n see Resource management for pods and containers in the Kubernetes\n documentation.
When this parameter is specified, the container is run as the specified user ID\n (uid). If this parameter isn't specified, the default is the user that's specified\n in the image metadata. The supported value range is 0 through\n 2147483647. This parameter maps to RunAsUser and\n MustRunAs policy in the Users\n and groups pod security policies in the Kubernetes\n documentation.
When this parameter is specified, the container is run as the specified group ID\n (gid). If this parameter isn't specified, the default is the group that's specified\n in the image metadata. The supported value range is 0 through\n 2147483647. This parameter maps to RunAsGroup and\n MustRunAs policy in the Users\n and groups pod security policies in the Kubernetes\n documentation.
When this parameter is true, the container is given elevated permissions on the\n host container instance. The level of permissions are similar to the root user\n permissions. The default value is false. This parameter maps to\n privileged policy in the Privileged\n pod security policies in the Kubernetes documentation.
Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent\n process. The default value is false.
When this parameter is true, the container is given read-only access to its\n root file system. The default value is false. This parameter maps to\n ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes\n documentation.
When this parameter is specified, the container is run as a user with a uid\n other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to\n RunAsUser and MustRunAsNonRoot policy in the Users\n and groups pod security policies in the Kubernetes\n documentation.
Adds or removes Linux capabilities from the container's default capability set.\n With Linux capabilities, you can grant specific privileges without granting full root\n permissions.
" } }, "seccompProfile": { "target": "com.amazonaws.batch#EksSeccompProfile", "traits": { "smithy.api#documentation": "The seccomp profile for the container. A container-level seccomp profile overrides the\n profile in the pod security context, which defines security settings that apply to all\n containers in the pod unless a container overrides them. If this parameter isn't specified,\n the container uses the pod security context's seccomp profile when one is specified.
" } } }, "traits": { "smithy.api#documentation": "The security context for a job. For more information, see Configure a\n security context for a pod or container in the Kubernetes\n documentation.
" } }, "com.amazonaws.batch#EksContainerVolumeMount": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name the volume mount. This must match the name of one of the volumes in the\n pod.
" } }, "mountPath": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The path on the container where the volume is mounted.
" } }, "subPath": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A sub-path inside the referenced volume instead of its root.
" } }, "readOnly": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "If this value is true, the container has read-only access to the volume.\n Otherwise, the container can write to the volume. The default value is false.
The volume mounts for a container for an Amazon EKS job. For more information about volumes and\n volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
" } }, "com.amazonaws.batch#EksContainerVolumeMounts": { "type": "list", "member": { "target": "com.amazonaws.batch#EksContainerVolumeMount" } }, "com.amazonaws.batch#EksContainers": { "type": "list", "member": { "target": "com.amazonaws.batch#EksContainer" } }, "com.amazonaws.batch#EksEmptyDir": { "type": "structure", "members": { "medium": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The medium to store the volume. The default value is an empty string, which uses the storage\n of the node.
\n\n (Default) Use the disk storage of the node.
\nUse the tmpfs volume that's backed by the RAM of the node. Contents of the\n volume are lost when the node reboots, and any storage on the volume counts against the\n container's memory limit.
The maximum size of the volume. By default, there's no maximum size defined.
" } } }, "traits": { "smithy.api#documentation": "Specifies the configuration of a Kubernetes emptyDir volume. An\n emptyDir volume is first created when a pod is assigned to a node. It exists as\n long as that pod is running on that node. The emptyDir volume is initially empty.\n All containers in the pod can read and write the files in the emptyDir volume.\n However, the emptyDir volume can be mounted at the same or different paths in each\n container. When a pod is removed from a node for any reason, the data in the\n emptyDir is deleted permanently. For more information, see emptyDir in the\n Kubernetes documentation.
The path of the file or directory on the host to mount into containers on the pod.
" } } }, "traits": { "smithy.api#documentation": "Specifies the configuration of a Kubernetes hostPath volume. A hostPath\n volume mounts an existing file or directory from the host node's filesystem into your pod. For\n more information, see hostPath in the Kubernetes documentation.
Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63\n uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be\n added or modified at any time. Each resource can have multiple labels, but each key must be\n unique for a given object.
" } }, "annotations": { "target": "com.amazonaws.batch#EksAnnotationsMap", "traits": { "smithy.api#documentation": "Key-value pairs used to attach arbitrary, non-identifying metadata to Kubernetes objects. \n Valid annotation keys have two segments: an optional prefix and a name, separated by a \n slash (/).
\nThe prefix is optional and must be 253 characters or less. If specified, the prefix \n must be a DNS subdomain\u2212 a series of DNS labels separated by dots (.), and it must \n end with a slash (/).
\nThe name segment is required and must be 63 characters or less. It can include alphanumeric \n characters ([a-z0-9A-Z]), dashes (-), underscores (_), and dots (.), but must begin and end \n with an alphanumeric character.
\nAnnotation values must be 255 characters or less.
\nAnnotations can be added or modified at any time. Each resource can have multiple annotations.
" } }, "namespace": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The namespace of the Amazon EKS cluster. In Kubernetes, namespaces provide a mechanism for isolating \n groups of resources within a single cluster. Names of resources need to be unique within a namespace, \n but not across namespaces. Batch places Batch Job pods in this namespace. If this field is provided, \n the value can't be empty or null. It must meet the following requirements:
\n1-63 characters long
\nCan't be set to default
\nCan't start with kube\n
Must match the following regular expression:\n ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\n
\n For more information, see \n Namespaces in the Kubernetes documentation. This namespace can be \n different from the kubernetesNamespace set in the compute environment's \n EksConfiguration, but must have identical role-based access control (RBAC) roles as \n the compute environment's kubernetesNamespace. For multi-node parallel jobs,\n the same value must be provided across all the node ranges.
Describes and uniquely identifies Kubernetes resources. For example, the compute environment that\n a pod runs in or the jobID for a job running in the pod. For more information, see\n \n Understanding Kubernetes Objects in the Kubernetes documentation.
The name of the persistentVolumeClaim bounded to a persistentVolume. \n For more information, see \n Persistent Volume Claims in the Kubernetes documentation.
An optional boolean value indicating if the mount is read only. Default is false. For more\n information, see \n Read Only Mounts in the Kubernetes documentation.
" } } }, "traits": { "smithy.api#documentation": "A persistentVolumeClaim volume is used to mount a PersistentVolume\n into a Pod. PersistentVolumeClaims are a way for users to \"claim\" durable storage without knowing \n the details of the particular cloud environment. See the information about PersistentVolumes\n in the Kubernetes documentation.
The name of the service account that's used to run the pod. For more information, see\n Kubernetes service\n accounts and Configure a Kubernetes service account\n to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes\n documentation.
" } }, "hostNetwork": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Indicates if the pod uses the hosts' network IP address. The default value is\n true. Setting this to false enables the Kubernetes pod networking model.\n Most Batch workloads are egress-only and don't require the overhead of IP allocation for each\n pod for incoming connections. For more information, see Host\n namespaces and Pod networking\n in the Kubernetes documentation.
The DNS policy for the pod. The default value is ClusterFirst. If the\n hostNetwork parameter is not specified, the default is\n ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query\n that does not match the configured cluster domain suffix is forwarded to the upstream nameserver\n inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst |\n ClusterFirstWithHostNet\n
References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain\n access to pull an images from a private registry.
\n\n ImagePullSecret$name is required when this object is used.
The properties of the container that's used on the Amazon EKS pod.
\nThis object is limited to 10 elements.
\nThese containers run before application containers, always runs to completion, and must\n complete successfully before the next container starts. These containers are registered with the\n Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.\n For more information, see Init\n Containers in the Kubernetes documentation.
\nThis object is limited to 10 elements.
\nSpecifies the volumes for a job definition that uses Amazon EKS resources.
" } }, "metadata": { "target": "com.amazonaws.batch#EksMetadata", "traits": { "smithy.api#documentation": "Metadata about the Kubernetes pod. For more information, see Understanding Kubernetes Objects in the Kubernetes\n documentation.
" } }, "shareProcessNamespace": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Indicates if the processes in a container are shared, or visible, to other containers in the\n same pod. For more information, see Share\n Process Namespace between Containers in a Pod.
" } }, "securityContext": { "target": "com.amazonaws.batch#EksPodSecurityContext", "traits": { "smithy.api#documentation": "The security context to apply to the pod. The settings apply to all containers in the\n pod unless an individual container specifies an overriding value.
" } } }, "traits": { "smithy.api#documentation": "The properties for the pod.
" } }, "com.amazonaws.batch#EksPodPropertiesDetail": { "type": "structure", "members": { "serviceAccountName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the service account that's used to run the pod. For more information, see\n Kubernetes service\n accounts and Configure a Kubernetes service account\n to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes\n documentation.
" } }, "hostNetwork": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Indicates if the pod uses the hosts' network IP address. The default value is\n true. Setting this to false enables the Kubernetes pod networking model.\n Most Batch workloads are egress-only and don't require the overhead of IP allocation for each\n pod for incoming connections. For more information, see Host\n namespaces and Pod networking\n in the Kubernetes documentation.
The DNS policy for the pod. The default value is ClusterFirst. If the\n hostNetwork parameter is not specified, the default is\n ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query\n that does not match the configured cluster domain suffix is forwarded to the upstream nameserver\n inherited from the node. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for\n dnsPolicy by either of DescribeJobDefinitions\n or DescribeJobs API operations. The pod spec setting will contain either\n ClusterFirst or ClusterFirstWithHostNet, depending on the value of the\n hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst |\n ClusterFirstWithHostNet\n
Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain\n access to pull an images from a private registry.
" } }, "containers": { "target": "com.amazonaws.batch#EksContainerDetails", "traits": { "smithy.api#documentation": "The properties of the container that's used on the Amazon EKS pod.
" } }, "initContainers": { "target": "com.amazonaws.batch#EksContainerDetails", "traits": { "smithy.api#documentation": "The container registered with the Amazon EKS Connector agent and persists the registration\n information in the Kubernetes backend data store.
" } }, "volumes": { "target": "com.amazonaws.batch#EksVolumes", "traits": { "smithy.api#documentation": "Specifies the volumes for a job definition using Amazon EKS resources.
" } }, "podName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the pod for this job.
" } }, "nodeName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the node for this job.
" } }, "metadata": { "target": "com.amazonaws.batch#EksMetadata", "traits": { "smithy.api#documentation": "Describes and uniquely identifies Kubernetes resources. For example, the compute environment that\n a pod runs in or the jobID for a job running in the pod. For more information, see\n Understanding Kubernetes Objects in the Kubernetes documentation.
Indicates if the processes in a container are shared, or visible, to other containers in the\n same pod. For more information, see Share\n Process Namespace between Containers in a Pod.
" } }, "securityContext": { "target": "com.amazonaws.batch#EksPodSecurityContext", "traits": { "smithy.api#documentation": "The security context applied to the pod. The settings apply to all containers in the\n pod unless an individual container specifies an overriding value.
" } } }, "traits": { "smithy.api#documentation": "The details for the pod.
" } }, "com.amazonaws.batch#EksPodPropertiesOverride": { "type": "structure", "members": { "containers": { "target": "com.amazonaws.batch#EksContainerOverrideList", "traits": { "smithy.api#documentation": "The overrides for the container that's used on the Amazon EKS pod.
" } }, "initContainers": { "target": "com.amazonaws.batch#EksContainerOverrideList", "traits": { "smithy.api#documentation": "The overrides for the initContainers defined in the Amazon EKS pod. These containers run before\n application containers, always run to completion, and must complete successfully before the next\n container starts. These containers are registered with the Amazon EKS Connector agent and persists the\n registration information in the Kubernetes backend data store. For more information, see Init\n Containers in the Kubernetes documentation.
Metadata about the overrides for the container that's used on the Amazon EKS pod.
" } } }, "traits": { "smithy.api#documentation": "An object that contains overrides for the Kubernetes pod properties of a job.
" } }, "com.amazonaws.batch#EksPodSecurityContext": { "type": "structure", "members": { "runAsUser": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The user ID that runs containers in the pod when a container does not specify its own\n user ID. The supported value range is 0 through\n 2147483647.
The primary group ID that runs containers in the pod when a container does not specify\n its own group ID. The supported value range is 0 through\n 2147483647.
Specifies whether Kubernetes validates that containers in the pod don't run as the root user\n unless a container specifies an overriding value.
" } }, "seccompProfile": { "target": "com.amazonaws.batch#EksSeccompProfile", "traits": { "smithy.api#documentation": "The default seccomp profile for containers in the pod. A container-level seccomp profile\n overrides this value.
" } }, "fsGroup": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "A special supplemental group that is applied to all containers in the pod. Some volume\n types allow Kubernetes to change the ownership and permissions of the volume contents to this group\n when the volume is mounted. The supported value range is 0 through\n 2147483647.
The security context for the pod. The settings apply to all containers in the pod when\n the container does not specify an overriding value. For more information, see Set the security context for a Pod in the Kubernetes\n documentation.
" } }, "com.amazonaws.batch#EksProperties": { "type": "structure", "members": { "podProperties": { "target": "com.amazonaws.batch#EksPodProperties", "traits": { "smithy.api#documentation": "The properties for the Kubernetes pod resources of a job.
" } } }, "traits": { "smithy.api#documentation": "An object that contains the properties for the Kubernetes resources of a job.
" } }, "com.amazonaws.batch#EksPropertiesDetail": { "type": "structure", "members": { "podProperties": { "target": "com.amazonaws.batch#EksPodPropertiesDetail", "traits": { "smithy.api#documentation": "The properties for the Kubernetes pod resources of a job.
" } } }, "traits": { "smithy.api#documentation": "An object that contains the details for the Kubernetes resources of a job.
" } }, "com.amazonaws.batch#EksPropertiesOverride": { "type": "structure", "members": { "podProperties": { "target": "com.amazonaws.batch#EksPodPropertiesOverride", "traits": { "smithy.api#documentation": "The overrides for the Kubernetes pod resources of a job.
" } } }, "traits": { "smithy.api#documentation": "An object that contains overrides for the Kubernetes resources of a job.
" } }, "com.amazonaws.batch#EksRequests": { "type": "map", "key": { "target": "com.amazonaws.batch#String" }, "value": { "target": "com.amazonaws.batch#Quantity" } }, "com.amazonaws.batch#EksSeccompLocalhostProfile": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4095 } } }, "com.amazonaws.batch#EksSeccompProfile": { "type": "structure", "members": { "type": { "target": "com.amazonaws.batch#EksSeccompProfileType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The seccomp profile type can be one of the following values:
\nThe RuntimeDefault value uses the container runtime's default seccomp\n profile.
The Unconfined value doesn't filter the container with seccomp.
The Localhost value uses a custom profile at the path specified by\n localhostProfile.
The path of the profile on the node, relative to the configured seccomp profile location.\n You must specify this parameter when type is Localhost. Don't set this\n parameter for any other type. You are responsible for ensuring that the profile exists on every\n eligible worker node. For information about providing files to Amazon EKS nodes, see Use a launch template with\n Batch on Amazon EKS in the Batch User Guide.
The Linux seccomp profile for a pod or container. For more information, see Restrict a Container's\n Syscalls with seccomp in the Kubernetes documentation.
" } }, "com.amazonaws.batch#EksSeccompProfileType": { "type": "enum", "members": { "RUNTIME_DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RuntimeDefault" } }, "LOCALHOST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Localhost" } }, "UNCONFINED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unconfined" } } } }, "com.amazonaws.batch#EksSecret": { "type": "structure", "members": { "secretName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the secret. The name must be allowed as a DNS subdomain name. For more\n information, see DNS subdomain names in the Kubernetes documentation.
", "smithy.api#required": {} } }, "optional": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the secret or the secret's keys must be defined.
" } } }, "traits": { "smithy.api#documentation": "Specifies the configuration of a Kubernetes secret volume. For more information, see\n secret in the\n Kubernetes documentation.
The name of the volume. The name must be allowed as a DNS subdomain name. For more\n information, see DNS subdomain names in the Kubernetes documentation.
", "smithy.api#required": {} } }, "hostPath": { "target": "com.amazonaws.batch#EksHostPath", "traits": { "smithy.api#documentation": "Specifies the configuration of a Kubernetes hostPath volume. For more information,\n see hostPath\n in the Kubernetes documentation.
Specifies the configuration of a Kubernetes emptyDir volume. For more information,\n see emptyDir\n in the Kubernetes documentation.
Specifies the configuration of a Kubernetes secret volume. For more information, see\n secret in the\n Kubernetes documentation.
Specifies the configuration of a Kubernetes persistentVolumeClaim bounded to a \n persistentVolume. For more information, see \n Persistent Volume Claims in the Kubernetes documentation.
Specifies an Amazon EKS volume for a job definition.
" } }, "com.amazonaws.batch#EksVolumes": { "type": "list", "member": { "target": "com.amazonaws.batch#EksVolume" } }, "com.amazonaws.batch#EnvironmentVariables": { "type": "list", "member": { "target": "com.amazonaws.batch#KeyValuePair" } }, "com.amazonaws.batch#EphemeralStorage": { "type": "structure", "members": { "sizeInGiB": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported\n value is 21 GiB and the maximum supported value is 200 GiB.
The amount of ephemeral storage to allocate for the task. This parameter is used to expand\n the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\n Fargate.
" } }, "com.amazonaws.batch#EvaluateOnExit": { "type": "structure", "members": { "onStatusReason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Contains a glob pattern to match against the StatusReason returned for a job.\n The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.),\n colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) \n so that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the Reason returned for a job. The\n pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons\n (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so\n that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the decimal representation of the\n ExitCode returned for a job. The pattern can be up to 512 characters long. It can\n contain only numbers, and can end with an asterisk (*) so that only the start of the string needs\n to be an exact match.
The string can contain up to 512 characters.
" } }, "action": { "target": "com.amazonaws.batch#RetryAction", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Specifies the action to take if all of the specified conditions\n (onStatusReason, onReason, and onExitCode) are met. The\n values aren't case sensitive.
Specifies an array of up to 5 conditions to be met, and an action to take\n (RETRY or EXIT) if all conditions are met. If none of the\n EvaluateOnExit conditions in a RetryStrategy match, then the job is\n retried.
The unit of measure for the capacity usage. For compute jobs, this is\n VCPU for Amazon EC2 and cpu for Amazon EKS. For service jobs, this is the instance type.
The quantity of capacity being used, measured in the units specified by\n capacityUnit.
The capacity usage for a fairshare scheduling job queue.
" } }, "com.amazonaws.batch#FairshareCapacityUsageList": { "type": "list", "member": { "target": "com.amazonaws.batch#FairshareCapacityUsage" } }, "com.amazonaws.batch#FairshareCapacityUtilization": { "type": "structure", "members": { "shareIdentifier": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The share identifier for the fairshare scheduling job queue.
" } }, "capacityUsage": { "target": "com.amazonaws.batch#FairshareCapacityUsageList", "traits": { "smithy.api#documentation": "The capacity usage information for this share, including the unit of measure and\n quantity being used. This is\n VCPU for Amazon EC2 and cpu for Amazon EKS.
The capacity utilization for a specific share in a fairshare scheduling job queue, including the share identifier and its current usage.
" } }, "com.amazonaws.batch#FairshareCapacityUtilizationList": { "type": "list", "member": { "target": "com.amazonaws.batch#FairshareCapacityUtilization" } }, "com.amazonaws.batch#FairsharePolicy": { "type": "structure", "members": { "shareDecaySeconds": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The amount of time (in seconds) to use to calculate a fair-share percentage for each \n share identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds).\n The maximum supported value is 604800 (1 week).
\nThe decay allows for more recently run jobs to have more weight than jobs that ran earlier. \n Consider adjusting this number if you have jobs that (on average) run longer than ten minutes, \n or a large difference in job count or job run times between share identifiers, and the allocation\n of resources doesn't meet your needs.
" } }, "computeReservation": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "A value used to reserve some of the available maximum vCPU for share identifiers that\n aren't already used.
\nThe reserved ratio is\n (computeReservation/100)^ActiveFairShares\n \n where \n ActiveFairShares\n is the number of active share\n identifiers.
For example, a computeReservation value of 50 indicates that Batch reserves\n 50% of the maximum available vCPU if there's only one share identifier. It reserves 25% if\n there are two share identifiers. It reserves 12.5% if there are three share\n identifiers. A computeReservation value of 25 indicates that Batch should reserve\n 25% of the maximum available vCPU if there's only one share identifier, 6.25% if there are\n two fair share identifiers, and 1.56% if there are three share identifiers.
The minimum value is 0 and the maximum value is 99.
" } }, "shareDistribution": { "target": "com.amazonaws.batch#ShareAttributesList", "traits": { "smithy.api#documentation": "An array of SharedIdentifier objects that contain the weights for the \n share identifiers for the fair-share policy. Share identifiers that aren't included have a\n default weight of 1.0.
The fair-share scheduling policy details.
" } }, "com.amazonaws.batch#FairshareUtilizationDetail": { "type": "structure", "members": { "activeShareCount": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The total number of active shares in the fairshare scheduling job queue that are\n currently utilizing capacity.
" } }, "topCapacityUtilization": { "target": "com.amazonaws.batch#FairshareCapacityUtilizationList", "traits": { "smithy.api#documentation": "A list of the top 20 shares with the highest capacity utilization, ordered by usage\n amount.
" } } }, "traits": { "smithy.api#documentation": "The fairshare utilization for a job queue, including the number\n of active shares and top capacity utilization.
" } }, "com.amazonaws.batch#FargatePlatformConfiguration": { "type": "structure", "members": { "platformVersion": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Fargate platform version where the jobs are running. A platform version is\n specified only for jobs that are running on Fargate resources. If one isn't specified, the\n LATEST platform version is used by default. This uses a recent, approved version of\n the Fargate platform for compute resources. For more information, see Fargate\n platform versions in the Amazon Elastic Container Service Developer Guide.
The platform configuration for jobs that are running on Fargate resources. Jobs that run\n on Amazon EC2 resources must not specify this parameter.
" } }, "com.amazonaws.batch#FirelensConfiguration": { "type": "structure", "members": { "type": { "target": "com.amazonaws.batch#FirelensConfigurationType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The log router to use. The valid values are fluentd or fluentbit.
The options to use when configuring the log router. This field is optional and can be\n used to specify a custom configuration file or to add additional metadata, such as the\n task, task definition, cluster, and container instance details to the log event. If\n specified, the syntax to use is\n \"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}.\n For more information, see Creating a task definition that uses a FireLens configuration\n in the Amazon Elastic Container Service Developer Guide.
The FireLens configuration for the container. This is used to specify and configure a\n log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer\n Guide.
" } }, "com.amazonaws.batch#FirelensConfigurationOptionsMap": { "type": "map", "key": { "target": "com.amazonaws.batch#String" }, "value": { "target": "com.amazonaws.batch#String" } }, "com.amazonaws.batch#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.batch#Float": { "type": "float" }, "com.amazonaws.batch#FrontOfQueueDetail": { "type": "structure", "members": { "jobs": { "target": "com.amazonaws.batch#FrontOfQueueJobSummaryList", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the first 100 RUNNABLE jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.
The Unix timestamp (in milliseconds) for when each of the first 100 RUNNABLE jobs were last updated.
Contains a list of the first 100 RUNNABLE jobs associated to a single job queue.
The ARN for a job in a named job queue.
" } }, "earliestTimeAtPosition": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.
" } } }, "traits": { "smithy.api#documentation": "An object that represents summary details for the first 100 RUNNABLE jobs in a job queue.
The ARN for a job in a named quota share.
" } }, "earliestTimeAtPosition": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the quota share.
" } } }, "traits": { "smithy.api#documentation": "An object that represents summary details for the first RUNNABLE job in a quota share.
Contains a list of the first RUNNABLE job in each named quota share.
The Unix timestamp (in milliseconds) for when the first RUNNABLE job per quota share were all last updated.
An object that represents the details of the first RUNNABLE job in each named quota share associated with a single job queue.
Provides a snapshot of job queue state, including ordering of RUNNABLE jobs, as well as capacity utilization for already dispatched jobs.\n The first 100 RUNNABLE jobs in the job queue are listed in order of dispatch. For job queues with an attached\n quota-share policy, the first RUNNABLE job in each quota share is also listed. Capacity utilization for the job queue is provided, as well as\n break downs by share for job queues with attached fair-share or quota-share scheduling policies.
The job queue\u2019s name or full queue Amazon Resource Name (ARN).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#GetJobQueueSnapshotResponse": { "type": "structure", "members": { "frontOfQueue": { "target": "com.amazonaws.batch#FrontOfQueueDetail", "traits": { "smithy.api#documentation": "The list of the first 100 RUNNABLE jobs in each job queue. For\n first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For job queues with an attached\n fair-share scheduling (FSS) or quota-share policy, jobs are ordered based on their job priority and share\n usage.
The first RUNNABLE job in each quota share. Jobs are ordered based on their job priority and share usage.
The job queue's capacity utilization, including total usage and\n breakdown per given share.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#Host": { "type": "structure", "members": { "sourcePath": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The path on the host container instance that's presented to the container. If this parameter\n is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a\n file location, then the data volume persists at the specified location on the host container\n instance until you delete it manually. If the source path location doesn't exist on the host\n container instance, the Docker daemon creates it. If the location does exist, the contents of the\n source path folder are exported.
\nThis parameter isn't applicable to jobs that run on Fargate resources. Don't provide this\n for these jobs.
\nDetermine whether your data volume persists on the host container instance and where it's\n stored. If this parameter is empty, then the Docker daemon assigns a host path for your data\n volume. However, the data isn't guaranteed to persist after the containers that are associated\n with it stop running.
" } }, "com.amazonaws.batch#ImageIdOverride": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.batch#ImagePullSecret": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Provides a unique identifier for the ImagePullSecret. This object is required\n when EksPodProperties$imagePullSecrets is used.
References a Kubernetes secret resource. This name of the secret must start and end with an\n alphanumeric character, is required to be lowercase, can include periods (.) and hyphens (-), and\n can't contain more than 253 characters.
" } }, "com.amazonaws.batch#ImagePullSecrets": { "type": "list", "member": { "target": "com.amazonaws.batch#ImagePullSecret" } }, "com.amazonaws.batch#ImageType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.batch#InfrastructureOptimization": { "type": "structure", "members": { "scaleInAfter": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The number of seconds an instance can remain idle before it is terminated. Valid\n values are -1 or 0 to 3600. Use -1 as a\n special value to disable scale-in (instances are never terminated for being idle). If not\n specified, a default value applies.
The infrastructure optimization configuration for an Amazon ECS Managed Instances capacity\n provider. Specifies the idle-instance scale-in behavior.
" } }, "com.amazonaws.batch#InstanceLaunchTemplate": { "type": "structure", "members": { "ec2InstanceProfileArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EC2 instance profile for the managed instances. The instance profile\n must use the AmazonECSInstanceRolePolicyForManagedInstances managed policy with a\n trust policy for ec2.amazonaws.com.
The network configuration for the managed instances. Specifies the VPC subnets and security\n groups where instances are launched.
", "smithy.api#required": {} } }, "instanceRequirements": { "target": "com.amazonaws.batch#InstanceRequirementsRequest", "traits": { "smithy.api#documentation": "The instance type requirements for the capacity provider. Use this to constrain which Amazon EC2\n instance types Amazon ECS can launch. If not specified, all available instance types are\n eligible.
" } }, "capacityOptionType": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The capacity pricing model for the managed instances. Valid values:
\n\n ON_DEMAND (default) \u2014 On-Demand pricing.
\n SPOT \u2014 Spot Instances, which can provide significant cost savings\n for fault-tolerant workloads.
The storage configuration for the managed instances. Configures the root EBS volume size.\n If not specified, the service uses the default EBS volume size for the instance type.
" } }, "monitoring": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The level of CloudWatch monitoring for the managed instances. Valid values are\n BASIC and DETAILED.
Specifies whether FIPS 140-2 validated cryptographic modules are enabled on the managed\n instances. Not available in all Regions.
" } }, "capacityReservations": { "target": "com.amazonaws.batch#CapacityReservationRequest", "traits": { "smithy.api#documentation": "The capacity reservation configuration for the managed instances. Use this to target\n On-Demand Capacity Reservations or Reserved Instances for predictable capacity and cost\n optimization.
" } }, "instanceMetadataTagsPropagation": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Specifies whether instance tags are accessible from the instance metadata service (IMDS).\n If not specified, instance tags are not accessible from IMDS.
" } }, "localStorageConfiguration": { "target": "com.amazonaws.batch#ManagedInstancesLocalStorageConfiguration", "traits": { "smithy.api#documentation": "The local storage configuration for the managed instances. If not specified, instance store\n volumes are not available to containers.
" } } }, "traits": { "smithy.api#documentation": "The instance launch configuration for an Amazon ECS Managed Instances capacity provider.\n Specifies the instance profile, networking, instance selection constraints, capacity pricing\n model, storage, and monitoring settings.
" } }, "com.amazonaws.batch#InstanceLaunchTemplateUpdate": { "type": "structure", "members": { "ec2InstanceProfileArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The updated Amazon Resource Name (ARN) of the Amazon EC2 instance profile for the managed instances.
" } }, "networkConfiguration": { "target": "com.amazonaws.batch#ManagedInstancesNetworkConfiguration", "traits": { "smithy.api#documentation": "The updated network configuration for the managed instances.
" } }, "instanceRequirements": { "target": "com.amazonaws.batch#InstanceRequirementsRequest", "traits": { "smithy.api#documentation": "The updated instance type requirements for the capacity provider.
" } }, "storageConfiguration": { "target": "com.amazonaws.batch#ManagedInstancesStorageConfiguration", "traits": { "smithy.api#documentation": "The updated storage configuration for the managed instances.
" } }, "monitoring": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The updated monitoring level. Valid values are BASIC and\n DETAILED.
The updated capacity reservation configuration.
" } }, "instanceMetadataTagsPropagation": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Specifies whether instance tags are accessible from the instance metadata service\n (IMDS).
" } }, "localStorageConfiguration": { "target": "com.amazonaws.batch#ManagedInstancesLocalStorageConfiguration", "traits": { "smithy.api#documentation": "The updated local storage configuration.
" } } }, "traits": { "smithy.api#documentation": "The instance launch configuration for updating an Amazon ECS Managed Instances capacity\n provider. You cannot change capacityOptionType or fipsEnabled after\n the compute environment is created.
A list of specific instance types or instance families that Amazon ECS can launch (for example,\n m5.large or g5). When specified, only these instance types are\n used.
The instance type requirements for the Amazon ECS Managed Instances capacity provider. Use this\n to specify which Amazon EC2 instance types or instance families Amazon ECS can launch.
" } }, "com.amazonaws.batch#Integer": { "type": "integer" }, "com.amazonaws.batch#JQState": { "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.batch#JQStatus": { "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" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "VALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALID" } }, "INVALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID" } } } }, "com.amazonaws.batch#JobCapacityUsageSummary": { "type": "structure", "members": { "capacityUnit": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The unit of measure for the capacity usage. This is\n VCPU for Amazon EC2 and cpu for Amazon EKS.
The quantity of capacity being used by the job, measured in the units specified by\n capacityUnit.
The capacity usage for a job, including the unit of measure\n and quantity of resources being used.
" } }, "com.amazonaws.batch#JobCapacityUsageSummaryList": { "type": "list", "member": { "target": "com.amazonaws.batch#JobCapacityUsageSummary" } }, "com.amazonaws.batch#JobDefinition": { "type": "structure", "members": { "jobDefinitionName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the job definition.
", "smithy.api#required": {} } }, "jobDefinitionArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) for the job definition.
", "smithy.api#required": {} } }, "revision": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The revision of the job definition.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The status of the job definition.
" } }, "type": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of job definition. It's either container or multinode. If\n the job is run on Fargate resources, then multinode isn't supported. For more\n information about multi-node parallel jobs, see Creating a multi-node parallel job definition in\n the Batch User Guide.
The scheduling priority of the job definition. This only affects jobs in job queues with a\n fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority.
" } }, "parameters": { "target": "com.amazonaws.batch#ParametersMap", "traits": { "smithy.api#documentation": "Default parameters or parameter substitution placeholders that are set in the job\n definition. Parameters are specified as a key-value pair mapping. Parameters in a\n SubmitJob request override any corresponding parameter defaults from the job\n definition. For more information about specifying parameters, see Job definition parameters in the\n Batch User Guide.
The retry strategy to use for failed jobs that are submitted with this job\n definition.
" } }, "containerProperties": { "target": "com.amazonaws.batch#ContainerProperties", "traits": { "smithy.api#documentation": "An object with properties specific to Amazon ECS-based jobs. When\n containerProperties is used in the job definition, it can't be used in addition to\n eksProperties, ecsProperties, or nodeProperties.
The timeout time for jobs that are submitted with this job definition. After the amount of\n time you specify passes, Batch terminates your jobs if they aren't finished.
" } }, "nodeProperties": { "target": "com.amazonaws.batch#NodeProperties", "traits": { "smithy.api#documentation": "An object with properties that are specific to multi-node parallel jobs. When\n nodeProperties is used in the job definition, it can't be used in addition to\n containerProperties, ecsProperties, or\n eksProperties.
If the job runs on Fargate resources, don't specify nodeProperties. We\n recommend ecsProperties, which supports both single-container and multi-container\n jobs. containerProperties is also supported for single-container jobs.
The tags that are applied to the job definition.
" } }, "propagateTags": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to propagate the tags from the job or job definition to the corresponding\n Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to\n the tasks when the tasks are created. For tags with the same name, job tags are given priority\n over job definitions tags. If the total number of combined tags from the job and job definition\n is over 50, the job is moved to the FAILED state.
The platform capabilities required by the job definition. If no value is specified, it\n defaults to EC2. Jobs run on Fargate resources specify\n FARGATE. Jobs run on Amazon ECS Managed Instances specify\n MANAGED_INSTANCES.
An object that contains the properties for the Amazon ECS resources of a job.When\n ecsProperties is used in the job definition, it can't be used in addition to\n containerProperties, eksProperties, or\n nodeProperties.
An object with properties that are specific to Amazon EKS-based jobs. When\n eksProperties is used in the job definition, it can't be used in addition to\n containerProperties, ecsProperties, or\n nodeProperties.
The orchestration type of the compute environment. The valid values are ECS\n (default) or EKS.
Contains a list of consumable resources required by the job.
" } } }, "traits": { "smithy.api#documentation": "An object that represents an Batch job definition.
" } }, "com.amazonaws.batch#JobDefinitionList": { "type": "list", "member": { "target": "com.amazonaws.batch#JobDefinition" } }, "com.amazonaws.batch#JobDefinitionType": { "type": "enum", "members": { "Container": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "container" } }, "Multinode": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "multinode" } } } }, "com.amazonaws.batch#JobDependency": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The job ID of the Batch job that's associated with this dependency.
" } }, "type": { "target": "com.amazonaws.batch#ArrayJobDependency", "traits": { "smithy.api#documentation": "The type of the job dependency.
" } } }, "traits": { "smithy.api#documentation": "An object that represents an Batch job dependency.
" } }, "com.amazonaws.batch#JobDependencyList": { "type": "list", "member": { "target": "com.amazonaws.batch#JobDependency" } }, "com.amazonaws.batch#JobDetail": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
" } }, "jobName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job name.
", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job ID.
", "smithy.api#required": {} } }, "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job queue that the job is associated with.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.batch#JobStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The current status for the job.
\nIf your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE\n status in the troubleshooting section of the\n Batch User Guide.
The share identifier for the job.
" } }, "schedulingPriority": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The scheduling policy of the job definition. This only affects jobs in job queues with a\n fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority.
" } }, "attempts": { "target": "com.amazonaws.batch#AttemptDetails", "traits": { "smithy.api#documentation": "A list of job attempts that are associated with this job.
" } }, "statusReason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short, human-readable string to provide more details for the current status of the\n job.
\n\n CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have\n insufficient capacity to service the job.
\n MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments\n have a maxVcpu setting that is smaller than the job requirements.
\n MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no\n connected instances that meet the job requirements.
\n MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have\n problems with the service role permissions.
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and\n parent array jobs, this is when the job entered the SUBMITTED state. This is\n specifically at the time SubmitJob was called. For array child\n jobs, this is when the child job was spawned by its parent and entered the PENDING\n state.
The retry strategy to use for this job if an attempt fails.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's\n when the job transitioned from the STARTING state to the RUNNING state.\n
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's\n when the job transitioned from the RUNNING state to a terminal state, such as\n SUCCEEDED or FAILED.
A list of job IDs that this job depends on.
" } }, "jobDefinition": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job definition that this job uses.
", "smithy.api#required": {} } }, "parameters": { "target": "com.amazonaws.batch#ParametersMap", "traits": { "smithy.api#documentation": "Additional parameters that are passed to the job that replace parameter substitution\n placeholders or override any corresponding parameter defaults from the job definition.
" } }, "container": { "target": "com.amazonaws.batch#ContainerDetail", "traits": { "smithy.api#documentation": "An object that represents the details for the container that's associated with the job. If\n the details are for a multiple-container job, this object will be empty.
" } }, "nodeDetails": { "target": "com.amazonaws.batch#NodeDetails", "traits": { "smithy.api#documentation": "An object that represents the details of a node that's associated with a multi-node parallel\n job.
" } }, "nodeProperties": { "target": "com.amazonaws.batch#NodeProperties", "traits": { "smithy.api#documentation": "An object that represents the node properties of a multi-node parallel job.
\nThis isn't applicable to jobs that are running on Fargate resources.
\nThe array properties of the job, if it's an array job.
" } }, "timeout": { "target": "com.amazonaws.batch#JobTimeout", "traits": { "smithy.api#documentation": "The timeout configuration for the job.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags that are applied to the job.
" } }, "propagateTags": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to propagate the tags from the job or job definition to the corresponding\n Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to\n the tasks when the tasks are created. For tags with the same name, job tags are given priority\n over job definitions tags. If the total number of combined tags from the job and job definition\n is over 50, the job is moved to the FAILED state.
The platform capabilities required by the job definition. If no value is specified, it\n defaults to EC2. Jobs run on Fargate resources specify\n FARGATE. Jobs run on Amazon ECS Managed Instances specify\n MANAGED_INSTANCES.
An object with various properties that are specific to Amazon EKS based jobs.
" } }, "eksAttempts": { "target": "com.amazonaws.batch#EksAttemptDetails", "traits": { "smithy.api#documentation": "A list of job attempts that are associated with this job.
" } }, "ecsProperties": { "target": "com.amazonaws.batch#EcsPropertiesDetail", "traits": { "smithy.api#documentation": "An object with properties that are specific to Amazon ECS-based jobs.
" } }, "isCancelled": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the job is cancelled.
" } }, "isTerminated": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the job is terminated.
" } }, "consumableResourceProperties": { "target": "com.amazonaws.batch#ConsumableResourceProperties", "traits": { "smithy.api#documentation": "Contains a list of consumable resources required by the job.
" } } }, "traits": { "smithy.api#documentation": "An object that represents an Batch job.
" } }, "com.amazonaws.batch#JobDetailList": { "type": "list", "member": { "target": "com.amazonaws.batch#JobDetail" } }, "com.amazonaws.batch#JobExecutionTimeoutMinutes": { "type": "long", "traits": { "smithy.api#range": { "min": 1, "max": 7200 } } }, "com.amazonaws.batch#JobQueueDetail": { "type": "structure", "members": { "jobQueueName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job queue name.
", "smithy.api#required": {} } }, "jobQueueArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job queue.
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.batch#JQState", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Describes the ability of the queue to accept new jobs. If the job queue state is\n ENABLED, it can accept jobs. If the job queue state is DISABLED, new\n jobs can't be added to the queue, but jobs already in the queue can finish.
The Amazon Resource Name (ARN) of the scheduling policy. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
The status of the job queue (for example, CREATING or\n VALID).
A short, human-readable string to provide additional details for the current status of the\n job queue.
" } }, "priority": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The priority of the job queue. Job queue priority determines the order \n that job queues are evaluated when multiple queues dispatch jobs within a \n shared compute environment. A higher value for priority indicates\n a higher priority. Queues are evaluated in cycles, in descending order by\n priority. For example, a job queue with a priority value of 10 is \n evaluated before a queue with a priority value of 1. All of the \n compute environments must be either Amazon EC2 (EC2 or SPOT)\n or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and \n Fargate compute environments can't be mixed.
Job queue priority doesn't guarantee that a particular job executes before \n a job in a lower priority queue. Jobs added to higher priority queues during the \n queue evaluation cycle might not be evaluated until the next cycle. A job is \n dispatched from a queue only if resources are available when the queue is evaluated. \n If there are insufficient resources available at that time, the cycle proceeds to the \n next queue. This means that jobs added to higher priority queues might have to wait \n for jobs in multiple lower priority queues to complete before they are dispatched. \n You can use job dependencies to control the order for jobs from queues with different \n priorities. For more information, see Job Dependencies\n in the Batch User Guide.
\nThe compute environments that are attached to the job queue and the order that job placement\n is preferred. Compute environments are selected for job placement in ascending order.
", "smithy.api#required": {} } }, "serviceEnvironmentOrder": { "target": "com.amazonaws.batch#ServiceEnvironmentOrders", "traits": { "smithy.api#documentation": "The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.
" } }, "jobQueueType": { "target": "com.amazonaws.batch#JobQueueType", "traits": { "smithy.api#documentation": "The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.
The tags that are applied to the job queue. For more information, see Tagging your Batch resources in\n Batch User Guide.
" } }, "jobStateTimeLimitActions": { "target": "com.amazonaws.batch#JobStateTimeLimitActions", "traits": { "smithy.api#documentation": "The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.
An object that represents the details for an Batch job queue.
" } }, "com.amazonaws.batch#JobQueueDetailList": { "type": "list", "member": { "target": "com.amazonaws.batch#JobQueueDetail" } }, "com.amazonaws.batch#JobQueueType": { "type": "enum", "members": { "EKS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS" } }, "ECS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ECS" } }, "ECS_FARGATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ECS_FARGATE" } }, "SAGEMAKER_TRAINING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAGEMAKER_TRAINING" } }, "ECS_MANAGED_INSTANCES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ECS_MANAGED_INSTANCES" } } } }, "com.amazonaws.batch#JobStateTimeLimitAction": { "type": "structure", "members": { "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The reason to log for the action being taken.
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.batch#JobStateTimeLimitActionsState", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The state of the job needed to trigger the action. The only supported value is RUNNABLE.
The approximate amount of time, in seconds, that must pass with the job in the specified state before the action\n is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
", "smithy.api#required": {} } }, "action": { "target": "com.amazonaws.batch#JobStateTimeLimitActionsAction", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The action to take when a job is at the head of the job queue in the specified state for the specified period of\n time. For job queues connected to a ECS, FARGATE or EKS compute environment, the only supported value is CANCEL, which will cancel the job. \n For job queues connected to a SAGEMAKER_TRAINING service environment, the only supported value is TERMINATE, which will terminate the job.
Specifies an action that Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.
" } }, "com.amazonaws.batch#JobStateTimeLimitActions": { "type": "list", "member": { "target": "com.amazonaws.batch#JobStateTimeLimitAction" } }, "com.amazonaws.batch#JobStateTimeLimitActionsAction": { "type": "enum", "members": { "CANCEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCEL" } }, "TERMINATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TERMINATE" } } } }, "com.amazonaws.batch#JobStateTimeLimitActionsState": { "type": "enum", "members": { "RUNNABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNABLE" } } } }, "com.amazonaws.batch#JobStatus": { "type": "enum", "members": { "SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUBMITTED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNABLE" } }, "STARTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.batch#JobSummary": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
" } }, "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job ID.
", "smithy.api#required": {} } }, "jobName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job name.
", "smithy.api#required": {} } }, "capacityUsage": { "target": "com.amazonaws.batch#JobCapacityUsageSummaryList", "traits": { "smithy.api#documentation": "The configured capacity usage information for this job, including the unit of measure and\n quantity of resources.
" } }, "createdAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and\n parent array jobs, this is when the job entered the SUBMITTED state (at the time\n SubmitJob\n was called). For array child jobs, this is when the child job was spawned by its parent and\n entered the PENDING state.
The Unix timestamp (in milliseconds) for when the job was scheduled for\n execution. For more information on job statues, see Service job status in the Batch User Guide.
" } }, "shareIdentifier": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The share identifier for the fairshare scheduling queue that this job is\n associated with.
" } }, "status": { "target": "com.amazonaws.batch#JobStatus", "traits": { "smithy.api#documentation": "The current status for the job.
" } }, "statusReason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short, human-readable string to provide more details for the current status of the\n job.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp for when the job was started. More specifically, it's when the job\n transitioned from the STARTING state to the RUNNING state.
The Unix timestamp for when the job was stopped. More specifically, it's when the job\n transitioned from the RUNNING state to a terminal state, such as\n SUCCEEDED or FAILED.
An object that represents the details of the container that's associated with the\n job.
" } }, "arrayProperties": { "target": "com.amazonaws.batch#ArrayPropertiesSummary", "traits": { "smithy.api#documentation": "The array properties of the job, if it's an array job.
" } }, "nodeProperties": { "target": "com.amazonaws.batch#NodePropertiesSummary", "traits": { "smithy.api#documentation": "The node properties for a single node in a job summary list.
\nThis isn't applicable to jobs that are running on Fargate resources.
\nThe Amazon Resource Name (ARN) of the job definition.
" } }, "isCancelled": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Indicates whether a cancellation request has been accepted for the job. This field is only present when the value is true.
Indicates whether a termination request has been accepted for the job. This field is only present when the value is true.
An object that represents summary details of a job.
" } }, "com.amazonaws.batch#JobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.batch#JobSummary" } }, "com.amazonaws.batch#JobTimeout": { "type": "structure", "members": { "attemptDurationSeconds": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The job timeout time (in seconds) that's measured from the job attempt's\n startedAt timestamp. After this time passes, Batch terminates your jobs if they\n aren't finished. The minimum value for the timeout is 60 seconds.
For array jobs, the timeout applies to the child jobs, not to the parent array job.
\nFor multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the\n individual nodes.
" } } }, "traits": { "smithy.api#documentation": "An object that represents a job timeout configuration.
" } }, "com.amazonaws.batch#KeyValuePair": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the\n environment variable.
" } }, "value": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the\n environment variable.
" } } }, "traits": { "smithy.api#documentation": "A key-value pair object.
" } }, "com.amazonaws.batch#KeyValuesPair": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the filter. Filter names are case sensitive.
" } }, "values": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "The filter values.
" } } }, "traits": { "smithy.api#documentation": "A filter name and value pair that's used to return a more specific list of results from a\n ListJobs or ListJobsByConsumableResource API operation.
The service resource identifier associated with the service job attempt.
" } } }, "traits": { "smithy.api#documentation": "Information about the latest attempt of a service job. A Service job can transition from SCHEDULED back to RUNNABLE state when they encounter capacity constraints.
The ID of the launch template.
" } }, "launchTemplateName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the launch template.
" } }, "version": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The version number of the launch template, \n $Default, or $Latest.
If the value is $Default, the default version of the launch template is used. If the value is $Latest, the latest version of the launch template is used.
If the AMI ID that's used in a compute environment is from the launch template, the AMI\n isn't changed when the compute environment is updated. It's only changed if the\n updateToLatestImageVersion parameter for the compute environment is set to\n true. During an infrastructure update, if either $Default or\n $Latest is specified, Batch re-evaluates the launch template version, and it\n might use a different version of the launch template. This is the case even if the launch\n template isn't specified in the update. When updating a compute environment, changing the launch\n template requires an infrastructure update of the compute environment. For more information, see\n Updating compute\n environments in the Batch User Guide.
Default: $Default\n
Latest: $Latest\n
A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.
\nYou can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.
\nTo unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.
The EKS node initialization process to use. You only need to specify this value if you are\n using a custom AMI. The default value is EKS_BOOTSTRAP_SH. If\n imageType is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you\n must choose EKS_NODEADM.
An object that represents a launch template that's associated with a compute resource. You\n must specify either the launch template ID or launch template name in the request, but not\n both.
\nIf security groups are specified using both the securityGroupIds parameter of\n CreateComputeEnvironment and the launch template, the values in the\n securityGroupIds parameter of CreateComputeEnvironment will be\n used.
This object isn't applicable to jobs that are running on Fargate resources.
\nThe ID of the launch template.
\n\n Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.
The name of the launch template.
\n\n Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.
The version number of the launch template, \n $Default, or $Latest.
If the value is $Default, the default version of the launch template is used. If the value is $Latest, the latest version of the launch template is used.
If the AMI ID that's used in a compute environment is from the launch template, the AMI\n isn't changed when the compute environment is updated. It's only changed if the\n updateToLatestImageVersion parameter for the compute environment is set to\n true. During an infrastructure update, if either $Default or $Latest is specified, Batch re-evaluates the launch template version, and it\n might use a different version of the launch template. This is the case even if the launch\n template isn't specified in the update. When updating a compute environment, changing the launch\n template requires an infrastructure update of the compute environment. For more information, see\n Updating compute\n environments in the Batch User Guide.
Default: $Default\n
Latest: $Latest\n
The instance type or family that this override launch template should be applied to.
\nThis parameter is required when defining a launch template override.
\nInformation included in this parameter must meet the following requirements:
\nMust be a valid Amazon EC2 instance type or family.
\nThe following Batch InstanceTypes are not allowed: optimal, default_x86_64, and default_arm64.
\n targetInstanceTypes can target only instance types and families that are included within the \n ComputeResource.instanceTypes\n set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5], targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large].
\n targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.
The EKS node initialization process to use. You only need to specify this value if you are\n using a custom AMI. The default value is EKS_BOOTSTRAP_SH. If\n imageType is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you\n must choose EKS_NODEADM.
An object that represents a launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not\n both.
\nIf security groups are specified using both the securityGroupIds parameter of\n CreateComputeEnvironment and the launch template, the values in the\n securityGroupIds parameter of CreateComputeEnvironment will be\n used.
You can define up to ten (10) overrides for each compute environment.
\nThis object isn't applicable to jobs that are running on Fargate resources.
\nTo unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.
Any of the host devices to expose to the container. This parameter maps to\n Devices in the Create a container section of the Docker Remote API\n and the --device option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs.
\nIf true, run an init process inside the container that forwards signals and\n reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to\n the --shm-size option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs.
\nThe container path, mount options, and size (in MiB) of the tmpfs mount. This\n parameter maps to the --tmpfs option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide this parameter for this resource type.
\nThe total amount of swap memory (in MiB) a container can use. This parameter is translated\n to the --memory-swap option to docker\n run where the value is the sum of the container memory plus the maxSwap\n value. For more information, see \n --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use\n swap. Accepted values are 0 or any positive integer. If the maxSwap\n parameter is omitted, the container doesn't use the swap configuration for the container instance\n on which it runs. A maxSwap value must be set for the swappiness\n parameter to be used.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs.
\nYou can use this parameter to tune a container's memory swappiness behavior. A\n swappiness value of 0 causes swapping to not occur unless absolutely\n necessary. A swappiness value of 100 causes pages to be swapped\n aggressively. Valid values are whole numbers between 0 and 100. If the\n swappiness parameter isn't specified, a default value of 60 is used.\n If a value isn't specified for maxSwap, then this parameter is ignored. If\n maxSwap is set to 0, the container doesn't use swap. This parameter maps to the\n --memory-swappiness option to docker\n run.
Consider the following when you use a per-container swap configuration.
\nSwap space must be enabled and allocated on the container instance for the containers to\n use.
\nBy default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the\n instance to use this feature. For more information, see Instance store swap\n volumes in the Amazon EC2 User Guide for Linux Instances or How do I\n allocate memory to work as swap space in an Amazon EC2 instance by using a swap\n file?\n
\nThe swap space parameters are only supported for job definitions using EC2\n resources.
\nIf the maxSwap and swappiness parameters are omitted from a job\n definition, each container has a default swappiness value of 60. Moreover, the\n total swap usage is limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs.
\nLinux-specific modifications that are applied to the container, such as details for device\n mappings.
" } }, "com.amazonaws.batch#ListAttemptEcsTaskDetails": { "type": "list", "member": { "target": "com.amazonaws.batch#AttemptEcsTaskDetails" } }, "com.amazonaws.batch#ListAttemptTaskContainerDetails": { "type": "list", "member": { "target": "com.amazonaws.batch#AttemptTaskContainerDetails" } }, "com.amazonaws.batch#ListConsumableResources": { "type": "operation", "input": { "target": "com.amazonaws.batch#ListConsumableResourcesRequest" }, "output": { "target": "com.amazonaws.batch#ListConsumableResourcesResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Returns a list of Batch consumable resources.
", "smithy.api#examples": [ { "title": "To get a list of a consumable resources", "documentation": "Returns a list of the consumable resources for your account.", "input": { "filters": [ { "name": "CONSUMABLE_RESOURCE_NAME", "values": [ "my*" ] } ], "maxResults": 123 }, "output": { "consumableResources": [ { "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource", "consumableResourceName": "myConsumableResource", "inUseQuantity": 12, "resourceType": "REPLENISHABLE", "totalQuantity": 123 } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/listconsumableresources", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "consumableResources", "pageSize": "maxResults" } } }, "com.amazonaws.batch#ListConsumableResourcesFilterList": { "type": "list", "member": { "target": "com.amazonaws.batch#KeyValuesPair" } }, "com.amazonaws.batch#ListConsumableResourcesRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.batch#ListConsumableResourcesFilterList", "traits": { "smithy.api#documentation": "The filters to apply to the consumable resource list query. If used, only those consumable \n resources that match the filter are listed. Filter names and values can be:
\nname: CONSUMABLE_RESOURCE_NAME \n
values: case-insensitive matches for the consumable resource name. If a filter \n value ends with an asterisk (*), it matches any consumable resource name that begins \n with the string before the '*'.
\nThe maximum number of results returned by ListConsumableResources in paginated\n output. When this parameter is used, ListConsumableResources only returns\n maxResults results in a single page and a nextToken response\n element. The remaining results of the initial request can be seen by sending another\n ListConsumableResources request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter isn't\n used, then ListConsumableResources returns up to 100 results and\n a nextToken value if applicable.
The nextToken value returned from a previous paginated \n ListConsumableResources request where maxResults was used and the \n results exceeded the value of that parameter. Pagination continues from the end of the previous \n results that returned the nextToken value. This value is null when \n there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nA list of consumable resources that match the request.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future ListConsumableResources \n request. When the results of a ListConsumableResources request exceed maxResults, \n this value can be used to retrieve the next page of results. This value is null \n when there are no more results to return.
Returns a list of Batch jobs.
\nYou must specify only one of the following items:
\nA job queue ID to return a list of jobs in that job queue
\nA multi-node parallel job ID to return a list of nodes for that job
\nAn array job ID to return a list of the children for that job
\nReturns a list of Batch jobs that require a specific consumable resource.
", "smithy.api#examples": [ { "title": "To get a list of Batch jobs by consumable resource", "documentation": "Returns a list of Batch jobs that require a specific consumable resource.", "input": { "consumableResource": "myConsumableResource", "filters": [ { "name": "CONSUMABLE_RESOURCE_NAME", "values": [ "my*" ] } ], "maxResults": 123 }, "output": { "jobs": [ { "consumableResourceProperties": { "consumableResourceList": [ { "consumableResource": "myConsumableResource", "quantity": 123 } ] }, "createdAt": 1480460782010, "jobArn": "arn:aws:batch:us-east-1:012345678910:job/myJob", "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/myJobDef", "jobName": "myJob", "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/myJobQueue", "jobStatus": "PENDING", "quantity": 123 } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/listjobsbyconsumableresource", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "jobs", "pageSize": "maxResults" } } }, "com.amazonaws.batch#ListJobsByConsumableResourceFilterList": { "type": "list", "member": { "target": "com.amazonaws.batch#KeyValuesPair" } }, "com.amazonaws.batch#ListJobsByConsumableResourceRequest": { "type": "structure", "members": { "consumableResource": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or ARN of the consumable resource.
", "smithy.api#required": {} } }, "filters": { "target": "com.amazonaws.batch#ListJobsByConsumableResourceFilterList", "traits": { "smithy.api#documentation": "The filters to apply to the job list query. If used, only those jobs requiring the specified \n consumable resource (consumableResource) and that match the value of the filters\n are listed. The filter names and values can be:
name: JOB_STATUS\n
values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED\n
name: JOB_NAME \n
The values are case-insensitive matches for the job name. If a filter value ends \n with an asterisk (*), it matches any job name that begins with the string before \n the '*'.
\nThe maximum number of results returned by ListJobsByConsumableResource in paginated\n output. When this parameter is used, ListJobsByConsumableResource only returns\n maxResults results in a single page and a nextToken response\n element. The remaining results of the initial request can be seen by sending another\n ListJobsByConsumableResource request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter isn't\n used, then ListJobsByConsumableResource returns up to 100 results \n and a nextToken value if applicable.
The nextToken value returned from a previous paginated \n ListJobsByConsumableResource request where maxResults was used and the \n results exceeded the value of that parameter. Pagination continues from the end of the previous \n results that returned the nextToken value. This value is null when \n there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of jobs that require the specified consumable resources.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future ListJobsByConsumableResource \n request. When the results of a ListJobsByConsumableResource request exceed \n maxResults, this value can be used to retrieve the next page of results. This \n value is null when there are no more results to return.
The Amazon Resource Name (ARN) of the job.
", "smithy.api#required": {} } }, "jobQueueArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job queue.
", "smithy.api#required": {} } }, "jobName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the job.
", "smithy.api#required": {} } }, "jobDefinitionArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job definition.
" } }, "shareIdentifier": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The fair-share scheduling identifier for the job.
" } }, "jobStatus": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The status of the job. Can be one of:
\n\n SUBMITTED\n
\n PENDING\n
\n RUNNABLE\n
\n STARTING\n
\n RUNNING\n
\n SUCCEEDED\n
\n FAILED\n
The total amount of the consumable resource that is available.
", "smithy.api#required": {} } }, "statusReason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short, human-readable string to provide more details for the current status of the job.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp for when the job was started. More specifically, it's when the job transitioned \n from the STARTING state to the RUNNING state.
The Unix timestamp (in milliseconds) for when the consumable resource was created.
", "smithy.api#required": {} } }, "consumableResourceProperties": { "target": "com.amazonaws.batch#ConsumableResourceProperties", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Contains a list of consumable resources required by the job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Current information about a consumable resource required by a job.
" } }, "com.amazonaws.batch#ListJobsByConsumableResourceSummaryList": { "type": "list", "member": { "target": "com.amazonaws.batch#ListJobsByConsumableResourceSummary" } }, "com.amazonaws.batch#ListJobsFilterList": { "type": "list", "member": { "target": "com.amazonaws.batch#KeyValuesPair" } }, "com.amazonaws.batch#ListJobsRequest": { "type": "structure", "members": { "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
" } }, "arrayJobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The job ID for an array job. Specifying an array job ID with this parameter lists all\n child jobs from within the specified array.
" } }, "multiNodeJobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with\n this parameter lists all nodes that are associated with the specified job.
" } }, "jobStatus": { "target": "com.amazonaws.batch#JobStatus", "traits": { "smithy.api#documentation": "The job status used to filter jobs in the specified queue. If the filters\n parameter is specified, the jobStatus parameter is ignored and jobs with any\n status are returned. The exception is the SHARE_IDENTIFIER filter and jobStatus can be used together. If you don't specify a status, only RUNNING jobs are\n returned.
Array job parents are updated to PENDING when any child job is updated to RUNNABLE and remain in PENDING status while child jobs are running. To view these jobs, filter by PENDING status until all child jobs reach a terminal state.
The maximum number of results returned by ListJobs in a paginated output. When this parameter is used, ListJobs returns up to maxResults results in a single page and a nextToken response element, if applicable. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value.
The following outlines key parameters and limitations:
\nThe minimum value is 1.
\nWhen --job-status is used, Batch returns up to 1000 values.
When --filters is used, Batch returns up to 100 values.
If neither parameter is used, then ListJobs returns up to\n 1000 results (jobs that are in the RUNNING status) and a nextToken value, if applicable.
The nextToken value returned from a previous paginated ListJobs\n request where maxResults was used and the results exceeded the value of that\n parameter. Pagination continues from the end of the previous results that returned the\n nextToken value. This value is null when there are no more results\n to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe filter to apply to the query. Only one filter can be used at a time. When the filter\n is used, jobStatus is ignored with the exception that SHARE_IDENTIFIER and jobStatus can be used together. The filter doesn't apply to child jobs in an array\n or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field,\n with the most recent jobs being first.
The SHARE_IDENTIFIER filter and the jobStatus field can be used together to filter results.
The value of the filter is a case-insensitive match for the job name. If the value\n ends with an asterisk (*), the filter matches any job name that begins with the string\n before the '*'. This corresponds to the jobName value. For example,\n test1 matches both Test1 and test1, and\n test1* matches both test1 and Test10. When the\n JOB_NAME filter is used, the results are grouped by the job name and\n version.
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This\n corresponds to the jobDefinition value. The value is case sensitive. When\n the value for the filter is the job definition name, the results include all the jobs\n that used any revision of that job definition name. If the value ends with an asterisk\n (*), the filter matches any job definition name that begins with the string before the\n '*'. For example, jd1 matches only jd1, and jd1*\n matches both jd1 and jd1A. The version of the job definition\n that's used doesn't affect the sort order. When the JOB_DEFINITION filter\n is used and the ARN is used (which is in the form\n arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}),\n the results include jobs that used the specified revision of the job definition.\n Asterisk (*) isn't supported when the ARN is used.
The value for the filter is the time that's before the job was created. This\n corresponds to the createdAt value. The value is a string representation of\n the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
The value for the filter is the time that's after the job was created. This\n corresponds to the createdAt value. The value is a string representation of\n the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
The value for the filter is the fairshare scheduling share identifier.
\nContains the parameters for ListJobs.
A list of job summaries that match the request.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future ListJobs request.\n When the results of a ListJobs request exceed maxResults, this value\n can be used to retrieve the next page of results. This value is null when there\n are no more results to return.
Returns a list of Batch quota shares associated with a job queue.
", "smithy.api#http": { "method": "POST", "uri": "/v1/listquotashares", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "quotaShares", "pageSize": "maxResults" } } }, "com.amazonaws.batch#ListQuotaSharesRequest": { "type": "structure", "members": { "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or full Amazon Resource Name (ARN) of the job queue used to list quota shares.
", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The maximum number of results returned by ListQuotaShares in\n paginated output. When this parameter is used, ListQuotaShares only\n returns maxResults results in a single page and a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListQuotaShares request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter isn't\n used, ListQuotaShares returns up to 100 results and a\n nextToken value if applicable.
The nextToken value that's returned from a previous paginated\n ListQuotaShares request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nA list of quota shares that match the request.
" } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n ListQuotaShares request. When the results of a\n ListQuotaShares request exceed maxResults, this value can\n be used to retrieve the next page of results. This value is null when there are\n no more results to return.
Returns a list of Batch scheduling policies.
", "smithy.api#http": { "method": "POST", "uri": "/v1/listschedulingpolicies", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "schedulingPolicies", "pageSize": "maxResults" } } }, "com.amazonaws.batch#ListSchedulingPoliciesRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The maximum number of results that's returned by ListSchedulingPolicies in\n paginated output. When this parameter is used, ListSchedulingPolicies only\n returns maxResults results in a single page and a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListSchedulingPolicies request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter isn't\n used, ListSchedulingPolicies returns up to 100 results and a\n nextToken value if applicable.
The nextToken value that's returned from a previous paginated\n ListSchedulingPolicies request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nContains the parameters for ListSchedulingPolicies.
A list of scheduling policies that match the request.
" } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n ListSchedulingPolicies request. When the results of a\n ListSchedulingPolicies request exceed maxResults, this value can\n be used to retrieve the next page of results. This value is null when there are\n no more results to return.
Returns a list of service jobs for a specified job queue.
", "smithy.api#http": { "method": "POST", "uri": "/v1/listservicejobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "jobSummaryList", "pageSize": "maxResults" } } }, "com.amazonaws.batch#ListServiceJobsRequest": { "type": "structure", "members": { "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name or ARN of the job queue with which to list service jobs.
" } }, "jobStatus": { "target": "com.amazonaws.batch#ServiceJobStatus", "traits": { "smithy.api#documentation": "The job status used to filter service jobs in the specified queue. If the filters\n\t parameter is specified, the jobStatus parameter is ignored and jobs with any\n\t status are returned. The exceptions are the SHARE_IDENTIFIER filter and QUOTA_SHARE_NAME filter, which\n can be used with jobStatus. If you don't specify a status, only RUNNING jobs are\n\t returned.
The SHARE_IDENTIFIER filter or QUOTA_SHARE_NAME filter can be used with the jobStatus field to filter results.
The maximum number of results returned by ListServiceJobs in paginated output. When this parameter is used, ListServiceJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceJobs returns up to 100 results and a nextToken value if applicable.
The nextToken value returned from a previous paginated ListServiceJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe filter to apply to the query. Only one filter can be used at a time. When the\n\t filter is used, jobStatus is ignored with the exception that SHARE_IDENTIFIER or QUOTA_SHARE_NAME and jobStatus can be used together. The results are sorted by the\n\t createdAt field, with the most recent jobs being first.
The SHARE_IDENTIFIER or QUOTA_SHARE_NAME filter and the jobStatus field can be used together to filter results.
The value of the filter is a case-insensitive match for the job name. If the value\n ends with an asterisk (*), the filter matches any job name that begins with the string\n before the '*'. This corresponds to the jobName value. For example,\n test1 matches both Test1 and test1, and\n test1* matches both test1 and Test10. When the\n JOB_NAME filter is used, the results are grouped by the job name and\n version.
The value for the filter is the time that's before the job was created. This\n corresponds to the createdAt value. The value is a string representation of\n the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
The value for the filter is the time that's after the job was created. This\n corresponds to the createdAt value. The value is a string representation of\n the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
The value for the filter is the fairshare scheduling share identifier.
\nThe value for the filter is the quota management share name.
\nA list of service job summaries.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The nextToken value to include in a future ListServiceJobs request. When the results of a ListServiceJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
", "smithy.api#examples": [ { "title": "ListTagsForResource Example", "documentation": "This demonstrates calling the ListTagsForResource action.", "input": { "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1" }, "output": { "tags": { "Stage": "Alpha", "Department": "Engineering", "User": "JaneDoe" } } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.batch#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for ListTagsForResource.
The tags for the resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#ListTaskContainerDetails": { "type": "list", "member": { "target": "com.amazonaws.batch#TaskContainerDetails" } }, "com.amazonaws.batch#ListTaskContainerOverrides": { "type": "list", "member": { "target": "com.amazonaws.batch#TaskContainerOverrides" } }, "com.amazonaws.batch#ListTaskContainerProperties": { "type": "list", "member": { "target": "com.amazonaws.batch#TaskContainerProperties" } }, "com.amazonaws.batch#ListTaskPropertiesOverride": { "type": "list", "member": { "target": "com.amazonaws.batch#TaskPropertiesOverride" } }, "com.amazonaws.batch#LogConfiguration": { "type": "structure", "members": { "logDriver": { "target": "com.amazonaws.batch#LogDriver", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The log driver to use for the container. The valid values that are listed for this parameter\n are log drivers that the Amazon ECS container agent can communicate with by default.
\nThe supported log drivers are awsfirelens, awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.
Jobs that are running on Fargate resources are restricted to the awslogs and\n splunk log drivers.
Specifies the firelens logging driver. For more information on configuring Firelens, see\n Send\n Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner in the\n Amazon Elastic Container Service Developer Guide.
\nSpecifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver\n in the Batch User Guide and Amazon CloudWatch Logs logging\n driver in the Docker documentation.
\nSpecifies the Fluentd logging driver. For more information including usage and options,\n see Fluentd logging\n driver in the Docker documentation.
\nSpecifies the Graylog Extended Format (GELF) logging driver. For more information\n including usage and options, see Graylog Extended Format logging\n driver in the Docker documentation.
\nSpecifies the journald logging driver. For more information including usage and options,\n see Journald logging\n driver in the Docker documentation.
\nSpecifies the JSON file logging driver. For more information including usage and options,\n see JSON File\n logging driver in the Docker documentation.
\nSpecifies the Splunk logging driver. For more information including usage and options,\n see Splunk logging\n driver in the Docker documentation.
\nSpecifies the syslog logging driver. For more information including usage and options,\n see Syslog logging\n driver in the Docker documentation.
\nIf you have a custom driver that's not listed earlier that you want to work with the Amazon ECS\n container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to\n work with that driver. We encourage you to submit pull requests for changes that you want to\n have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The secrets to pass to the log configuration. For more information, see Specifying sensitive\n data in the Batch User Guide.
" } } }, "traits": { "smithy.api#documentation": "Log configuration options to send to a custom log driver for the container.
" } }, "com.amazonaws.batch#LogConfigurationOptionsMap": { "type": "map", "key": { "target": "com.amazonaws.batch#String" }, "value": { "target": "com.amazonaws.batch#String" } }, "com.amazonaws.batch#LogDriver": { "type": "enum", "members": { "JSON_FILE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "json-file" } }, "SYSLOG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "syslog" } }, "JOURNALD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "journald" } }, "GELF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gelf" } }, "FLUENTD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fluentd" } }, "AWSLOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "awslogs" } }, "SPLUNK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "splunk" } }, "AWSFIRELENS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "awsfirelens" } } } }, "com.amazonaws.batch#Long": { "type": "long" }, "com.amazonaws.batch#ManagedInstancesLocalStorageConfiguration": { "type": "structure", "members": { "useLocalStorage": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Specifies whether instance store volumes (local NVMe SSDs) are available to containers.\n When enabled, containers can use the instance store for high-performance temporary\n storage.
" } } }, "traits": { "smithy.api#documentation": "The local storage configuration for Amazon ECS Managed Instances.
" } }, "com.amazonaws.batch#ManagedInstancesNetworkConfiguration": { "type": "structure", "members": { "subnets": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The VPC subnets where managed instances are launched. If your subnets don't provide public\n IP addresses, they must have a NAT gateway for outbound internet access.
", "smithy.api#required": {} } }, "securityGroups": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The VPC security groups to associate with the managed instances.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The network configuration for Amazon ECS Managed Instances. Specifies the VPC subnets and\n security groups where instances are launched.
" } }, "com.amazonaws.batch#ManagedInstancesProvider": { "type": "structure", "members": { "propagateTags": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Specifies whether tags on the capacity provider are propagated to the Amazon EC2 instances it\n launches. Valid values:
\n\n CAPACITY_PROVIDER \u2014 Propagates tags to instances.
\n NONE (default) \u2014 Does not propagate tags to instances.
The Amazon Resource Name (ARN) of the IAM role that Amazon ECS assumes to manage Amazon EC2 instances on your behalf.\n This role must have a trust policy for ecs.amazonaws.com. You must have the\n iam:PassRole permission for this role with the condition\n iam:PassedToService: ecs.amazonaws.com.
The instance launch configuration for the Amazon ECS Managed Instances capacity provider.\n Contains networking, instance profile, instance requirements, capacity type, storage, and\n monitoring configuration.
", "smithy.api#required": {} } }, "infrastructureOptimization": { "target": "com.amazonaws.batch#InfrastructureOptimization", "traits": { "smithy.api#documentation": "The infrastructure optimization configuration for the capacity provider. Specifies the\n idle-instance scale-in behavior.
" } } }, "traits": { "smithy.api#documentation": "The configuration for an Amazon ECS Managed Instances capacity provider. This object is required\n when creating a compute environment with computeResources.type set to\n ECS_MANAGED_INSTANCES.
The size of the root EBS volume in GiB for the managed instances.
" } } }, "traits": { "smithy.api#documentation": "The storage configuration for Amazon ECS Managed Instances.
" } }, "com.amazonaws.batch#MountPoint": { "type": "structure", "members": { "containerPath": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The path on the container where the host volume is mounted.
" } }, "readOnly": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "If this value is true, the container has read-only access to the volume.\n Otherwise, the container can write to the volume. The default value is false.
The name of the volume to mount.
" } } }, "traits": { "smithy.api#documentation": "Details for a Docker volume mount point that's used in a job's container properties. This\n parameter maps to Volumes in the Create a\n container section of the Docker Remote API and the\n --volume option to docker run.
Indicates whether the job has a public IP address. For a job that's running on Fargate\n resources in a private subnet to send outbound traffic to the internet (for example, to pull\n container images), the private subnet requires a NAT gateway be attached to route requests to the\n internet. For more information, see Amazon ECS task networking in the\n Amazon Elastic Container Service Developer Guide. The default value is \"DISABLED\".
The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on Amazon EC2 resources must not specify this parameter.
" } }, "com.amazonaws.batch#NetworkInterface": { "type": "structure", "members": { "attachmentId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The attachment ID for the network interface.
" } }, "ipv6Address": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The private IPv6 address for the network interface.
" } }, "privateIpv4Address": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The private IPv4 address for the network interface.
" } } }, "traits": { "smithy.api#documentation": "An object that represents the elastic network interface for a multi-node parallel job\n node.
" } }, "com.amazonaws.batch#NetworkInterfaceList": { "type": "list", "member": { "target": "com.amazonaws.batch#NetworkInterface" } }, "com.amazonaws.batch#NodeDetails": { "type": "structure", "members": { "nodeIndex": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The node index for the node. Node index numbering starts at zero. This index is also\n available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
Specifies whether the current node is the main node for a multi-node parallel job.
" } } }, "traits": { "smithy.api#documentation": "An object that represents the details of a multi-node parallel job node.
" } }, "com.amazonaws.batch#NodeOverrides": { "type": "structure", "members": { "numNodes": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The number of nodes to use with a multi-node parallel job. This value overrides the number\n of nodes that are specified in the job definition. To use this override, you must meet the\n following conditions:
\nThere must be at least one node range in your job definition that has an open upper\n boundary, such as : or n:.
The lower boundary of the node range that's specified in the job definition must be fewer\n than the number of nodes specified in the override.
\nThe main node index that's specified in the job definition must be fewer than the number\n of nodes specified in the override.
\nThe node property overrides for the job.
" } } }, "traits": { "smithy.api#documentation": "An object that represents any node overrides to a job definition that's used in a SubmitJob API\n operation.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs. Rather, use containerOverrides instead.
The number of nodes that are associated with a multi-node parallel job.
", "smithy.api#required": {} } }, "mainNode": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Specifies the node index for the main node of a multi-node parallel job. This node index\n value must be fewer than the number of nodes.
", "smithy.api#required": {} } }, "nodeRangeProperties": { "target": "com.amazonaws.batch#NodeRangeProperties", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of node ranges and their properties that are associated with a multi-node parallel\n job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that represents the node properties of a multi-node parallel job.
\nNode properties can't be specified for Amazon EKS based job definitions.
\nSpecifies whether the current node is the main node for a multi-node parallel job.
" } }, "numNodes": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The number of nodes that are associated with a multi-node parallel job.
" } }, "nodeIndex": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The node index for the node. Node index numbering begins at zero. This index is also\n available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
An object that represents the properties of a node that's associated with a multi-node\n parallel job.
" } }, "com.amazonaws.batch#NodePropertyOverride": { "type": "structure", "members": { "targetNodes": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The range of nodes, using node index values, that's used to override. A range of\n 0:3 indicates nodes with index values of 0 through 3. If\n the starting range value is omitted (:n), then 0 is used to start the\n range. If the ending range value is omitted (n:), then the highest possible node\n index is used to end the range.
The overrides that are sent to a node range.
" } }, "ecsPropertiesOverride": { "target": "com.amazonaws.batch#EcsPropertiesOverride", "traits": { "smithy.api#documentation": "An object that contains the properties that you want to replace for the existing Amazon ECS\n resources of a job.
" } }, "instanceTypes": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "An object that contains the instance types that you want to replace for the existing\n resources of a job.
" } }, "eksPropertiesOverride": { "target": "com.amazonaws.batch#EksPropertiesOverride", "traits": { "smithy.api#documentation": "An object that contains the properties that you want to replace for the existing Amazon EKS resources of a job.
" } }, "consumableResourcePropertiesOverride": { "target": "com.amazonaws.batch#ConsumableResourceProperties", "traits": { "smithy.api#documentation": "An object that contains overrides for the consumable resources of a job.
" } } }, "traits": { "smithy.api#documentation": "The object that represents any node overrides to a job definition that's used in a SubmitJob API\n operation.
" } }, "com.amazonaws.batch#NodePropertyOverrides": { "type": "list", "member": { "target": "com.amazonaws.batch#NodePropertyOverride" } }, "com.amazonaws.batch#NodeRangeProperties": { "type": "list", "member": { "target": "com.amazonaws.batch#NodeRangeProperty" } }, "com.amazonaws.batch#NodeRangeProperty": { "type": "structure", "members": { "targetNodes": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The range of nodes, using node index values. A range of 0:3 indicates nodes\n with index values of 0 through 3. If the starting range value is\n omitted (:n), then 0 is used to start the range. If the ending range\n value is omitted (n:), then the highest possible node index is used to end the\n range. Your accumulative node ranges must account for all nodes (0:n). You can nest\n node ranges (for example, 0:10 and 4:5). In this case, the\n 4:5 range properties override the 0:10 properties.
The container details for the node range.
" } }, "instanceTypes": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "The instance types of the underlying host infrastructure of a multi-node parallel\n job.
\nThis parameter isn't applicable to jobs that are running on Fargate resources.
\nIn addition, this list object is currently limited to one element.
\nThis is an object that represents the properties of the node range for a multi-node parallel\n job.
" } }, "eksProperties": { "target": "com.amazonaws.batch#EksProperties", "traits": { "smithy.api#documentation": "This is an object that represents the properties of the node range for a multi-node parallel job.
" } }, "consumableResourceProperties": { "target": "com.amazonaws.batch#ConsumableResourceProperties", "traits": { "smithy.api#documentation": "Contains a list of consumable resources required by a job.
" } } }, "traits": { "smithy.api#documentation": "This is an object that represents the properties of the node range for a multi-node parallel\n job.
" } }, "com.amazonaws.batch#OrchestrationType": { "type": "enum", "members": { "ECS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ECS" } }, "EKS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS" } } } }, "com.amazonaws.batch#ParametersMap": { "type": "map", "key": { "target": "com.amazonaws.batch#String" }, "value": { "target": "com.amazonaws.batch#String" } }, "com.amazonaws.batch#PlatformCapability": { "type": "enum", "members": { "EC2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EC2" } }, "FARGATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FARGATE" } }, "MANAGED_INSTANCES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGED_INSTANCES" } } } }, "com.amazonaws.batch#PlatformCapabilityList": { "type": "list", "member": { "target": "com.amazonaws.batch#PlatformCapability" } }, "com.amazonaws.batch#Quantity": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.batch#QueueSnapshotCapacityUsage": { "type": "structure", "members": { "capacityUnit": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The unit of measure for the capacity usage. For compute jobs, this is\n VCPU for Amazon EC2 and cpu for Amazon EKS. For service jobs, this is the instance type.
The quantity of capacity being used in the queue snapshot, measured in the units\n specified by capacityUnit.
The configured capacity usage for a job queue snapshot, including the unit of\n measure and quantity of resources being used.
" } }, "com.amazonaws.batch#QueueSnapshotCapacityUsageList": { "type": "list", "member": { "target": "com.amazonaws.batch#QueueSnapshotCapacityUsage" } }, "com.amazonaws.batch#QueueSnapshotUtilizationDetail": { "type": "structure", "members": { "totalCapacityUsage": { "target": "com.amazonaws.batch#QueueSnapshotCapacityUsageList", "traits": { "smithy.api#documentation": "The total capacity usage for the entire job queue.
" } }, "fairshareUtilization": { "target": "com.amazonaws.batch#FairshareUtilizationDetail", "traits": { "smithy.api#documentation": "The utilization information for a fairshare scheduling job queues, including\n active share count and top capacity utilization by share.
" } }, "quotaShareUtilization": { "target": "com.amazonaws.batch#QuotaShareUtilizationDetail", "traits": { "smithy.api#documentation": "The utilization information for a job queue with a quota share scheduling policy.
" } }, "lastUpdatedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the queue utilization information was\n last updated.
" } } }, "traits": { "smithy.api#documentation": "The job queue utilization at a specific point in time,\n including total capacity usage, and quota share or fairshare utilization breakdown\n depending on the job queue scheduling policy.
" } }, "com.amazonaws.batch#QuotaShareCapacityLimit": { "type": "structure", "members": { "maxCapacity": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share\n without borrowing.
", "smithy.api#required": {} } }, "capacityUnit": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
Defines the capacity limit for a quota share, or the type and maximum quantity of a particular resource that can be allocated to jobs in the quota share\n without borrowing.
" } }, "com.amazonaws.batch#QuotaShareCapacityLimits": { "type": "list", "member": { "target": "com.amazonaws.batch#QuotaShareCapacityLimit" } }, "com.amazonaws.batch#QuotaShareCapacityUsage": { "type": "structure", "members": { "capacityUnit": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The unit of compute capacity for the capacity usage.
" } }, "quantity": { "target": "com.amazonaws.batch#Double", "traits": { "smithy.api#documentation": "The quantity of capacity being used.
" } } }, "traits": { "smithy.api#documentation": "The capacity usage for a quota share, including units of compute capacity and quantity of resources being used.
" } }, "com.amazonaws.batch#QuotaShareCapacityUsageList": { "type": "list", "member": { "target": "com.amazonaws.batch#QuotaShareCapacityUsage" } }, "com.amazonaws.batch#QuotaShareCapacityUtilization": { "type": "structure", "members": { "quotaShareName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the quota share.
" } }, "capacityUsage": { "target": "com.amazonaws.batch#QuotaShareCapacityUsageList", "traits": { "smithy.api#documentation": "The capacity usage information for this quota share, including the units of compute capacity and quantity being used.
" } } }, "traits": { "smithy.api#documentation": "The capacity utilization for a specific quota share, including the quota share name and its current usage.
" } }, "com.amazonaws.batch#QuotaShareCapacityUtilizationList": { "type": "list", "member": { "target": "com.amazonaws.batch#QuotaShareCapacityUtilization" } }, "com.amazonaws.batch#QuotaShareDetail": { "type": "structure", "members": { "quotaShareName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the quota share.
" } }, "quotaShareArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the quota share.
" } }, "jobQueueArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job queue associated with the quota share.
" } }, "capacityLimits": { "target": "com.amazonaws.batch#QuotaShareCapacityLimits", "traits": { "smithy.api#documentation": "A list that specifies the quantity and type of compute capacity allocated to the quota share.
" } }, "resourceSharingConfiguration": { "target": "com.amazonaws.batch#QuotaShareResourceSharingConfiguration", "traits": { "smithy.api#documentation": "Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
" } }, "preemptionConfiguration": { "target": "com.amazonaws.batch#QuotaSharePreemptionConfiguration", "traits": { "smithy.api#documentation": "Specifies the preemption behavior for jobs in a quota share.
" } }, "state": { "target": "com.amazonaws.batch#QuotaShareState", "traits": { "smithy.api#documentation": "The state of the quota share.
" } }, "status": { "target": "com.amazonaws.batch#QuotaShareStatus", "traits": { "smithy.api#documentation": "The current status of the quota share.
" } } }, "traits": { "smithy.api#documentation": "Detailed information about a quota share, including its configuration, state, and capacity limits.
" } }, "com.amazonaws.batch#QuotaShareIdleResourceAssignmentStrategy": { "type": "enum", "members": { "FIFO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FIFO" } } } }, "com.amazonaws.batch#QuotaShareInSharePreemptionState": { "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.batch#QuotaShareList": { "type": "list", "member": { "target": "com.amazonaws.batch#QuotaShareDetail" } }, "com.amazonaws.batch#QuotaSharePolicy": { "type": "structure", "members": { "idleResourceAssignmentStrategy": { "target": "com.amazonaws.batch#QuotaShareIdleResourceAssignmentStrategy", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The strategy that determines how idle resources are assigned to quota shares\n that are borrowing capacity. Currently, only FIFO is supported.
The quota share scheduling policy details for a job queue.
" } }, "com.amazonaws.batch#QuotaSharePreemptionConfiguration": { "type": "structure", "members": { "inSharePreemption": { "target": "com.amazonaws.batch#QuotaShareInSharePreemptionState", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the preemption behavior for jobs in a quota share.
" } }, "com.amazonaws.batch#QuotaShareResourceSharingConfiguration": { "type": "structure", "members": { "strategy": { "target": "com.amazonaws.batch#QuotaShareResourceSharingStrategy", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself.\n LEND configures the share to lend its idle capacity to another share in need of capacity.\n The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
The maximum percentage of additional capacity that the quota share can borrow from other shares. borrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW.\n This value is expressed as a percentage of the quota share's configured CapacityLimits.
The borrowLimit is applied uniformly across all capacity units. \n For example, if the borrowLimit is 200, the quota \n share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default borrowLimit is -1, which indicates unlimited borrowing.
Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
" } }, "com.amazonaws.batch#QuotaShareResourceSharingStrategy": { "type": "enum", "members": { "RESERVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESERVE" } }, "LEND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LEND" } }, "LEND_AND_BORROW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LEND_AND_BORROW" } } } }, "com.amazonaws.batch#QuotaShareState": { "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.batch#QuotaShareStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "VALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALID" } }, "INVALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } } }, "com.amazonaws.batch#QuotaShareUtilizationDetail": { "type": "structure", "members": { "topCapacityUtilization": { "target": "com.amazonaws.batch#QuotaShareCapacityUtilizationList", "traits": { "smithy.api#documentation": "A list of the top capacity utilizations across quota shares associated with a job queue.
" } } }, "traits": { "smithy.api#documentation": "An object that represents the capacity utilization details of all quota shares associated with a single job queue.
" } }, "com.amazonaws.batch#RegisterJobDefinition": { "type": "operation", "input": { "target": "com.amazonaws.batch#RegisterJobDefinitionRequest" }, "output": { "target": "com.amazonaws.batch#RegisterJobDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Registers an Batch job definition.
", "smithy.api#examples": [ { "title": "RegisterJobDefinition with tags", "documentation": "This demonstrates calling the RegisterJobDefinition action, including tags.", "input": { "jobDefinitionName": "sleep30", "type": "container", "containerProperties": { "image": "busybox", "command": [ "sleep", "30" ], "resourceRequirements": [ { "type": "MEMORY", "value": "128" }, { "type": "VCPU", "value": "1" } ] }, "tags": { "Department": "Engineering", "User": "JaneDoe" } }, "output": { "jobDefinitionName": "sleep30", "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", "revision": 1 } }, { "title": "To register a GPU job definition on ECS Managed Instances", "documentation": "This example registers a job definition that requests GPU resources on ECS Managed Instances.", "input": { "jobDefinitionName": "my-gpu-managed-instances-job-def", "type": "container", "platformCapabilities": [ "MANAGED_INSTANCES" ], "ecsProperties": { "taskProperties": [ { "containers": [ { "image": "123456789012.dkr.ecr.us-east-1.amazonaws.com/my-gpu-image:latest", "name": "main", "command": [ "nvidia-smi" ], "resourceRequirements": [ { "type": "VCPU", "value": "4" }, { "type": "MEMORY", "value": "16384" }, { "type": "GPU", "value": "1" } ] } ], "executionRoleArn": "arn:aws:iam::123456789012:role/ecsTaskExecutionRole" } ] } }, "output": { "jobDefinitionName": "my-gpu-managed-instances-job-def", "jobDefinitionArn": "arn:aws:batch:us-east-1:123456789012:job-definition/my-gpu-managed-instances-job-def:1", "revision": 1 } }, { "title": "To register a job definition", "documentation": "This example registers a job definition for a simple container job.", "input": { "containerProperties": { "image": "busybox", "command": [ "sleep", "10" ], "resourceRequirements": [ { "type": "MEMORY", "value": "128" }, { "type": "VCPU", "value": "1" } ] }, "type": "container", "jobDefinitionName": "sleep10" }, "output": { "jobDefinitionName": "sleep10", "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1", "revision": 1 } }, { "title": "To register a job definition on ECS Managed Instances", "documentation": "This example registers a job definition that runs on ECS Managed Instances using ecsProperties with the MANAGED_INSTANCES platform capability.", "input": { "jobDefinitionName": "my-managed-instances-job-def", "type": "container", "platformCapabilities": [ "MANAGED_INSTANCES" ], "ecsProperties": { "taskProperties": [ { "containers": [ { "image": "public.ecr.aws/amazonlinux/amazonlinux:2023", "name": "main", "command": [ "echo", "hello managed instances" ], "resourceRequirements": [ { "type": "VCPU", "value": "1" }, { "type": "MEMORY", "value": "1024" } ] } ], "executionRoleArn": "arn:aws:iam::123456789012:role/ecsTaskExecutionRole" } ] } }, "output": { "jobDefinitionName": "my-managed-instances-job-def", "jobDefinitionArn": "arn:aws:batch:us-east-1:123456789012:job-definition/my-managed-instances-job-def:1", "revision": 1 } }, { "title": "To register a multi-container job definition on ECS Managed Instances", "documentation": "This example registers a job definition with a main container and a sidecar logging container on ECS Managed Instances.", "input": { "jobDefinitionName": "my-sidecar-managed-instances-job-def", "type": "container", "platformCapabilities": [ "MANAGED_INSTANCES" ], "ecsProperties": { "taskProperties": [ { "containers": [ { "image": "public.ecr.aws/amazonlinux/amazonlinux:2023", "name": "main", "command": [ "echo", "processing data" ], "essential": true, "resourceRequirements": [ { "type": "VCPU", "value": "2" }, { "type": "MEMORY", "value": "4096" } ] }, { "image": "public.ecr.aws/amazonlinux/amazonlinux:2023", "name": "sidecar", "command": [ "echo", "logging sidecar" ], "essential": false, "resourceRequirements": [ { "type": "VCPU", "value": "1" }, { "type": "MEMORY", "value": "512" } ] } ], "executionRoleArn": "arn:aws:iam::123456789012:role/ecsTaskExecutionRole" } ] } }, "output": { "jobDefinitionName": "my-sidecar-managed-instances-job-def", "jobDefinitionArn": "arn:aws:batch:us-east-1:123456789012:job-definition/my-sidecar-managed-instances-job-def:1", "revision": 1 } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/registerjobdefinition", "code": 200 } } }, "com.amazonaws.batch#RegisterJobDefinitionRequest": { "type": "structure", "members": { "jobDefinitionName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the job definition to register. It can be up to 128 letters long. It can\n contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.batch#JobDefinitionType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of job definition. For more information about multi-node parallel jobs, see\n Creating a multi-node\n parallel job definition in the Batch User Guide.
\nIf the value is container, then one of the following is required: containerProperties, ecsProperties, or eksProperties.
If the value is multinode, then nodeProperties is required.
If the job is run on Fargate resources, then multinode isn't supported.
Default parameter substitution placeholders to set in the job definition. Parameters are\n specified as a key-value pair mapping. Parameters in a SubmitJob request override\n any corresponding parameter defaults from the job definition.
The scheduling priority for jobs that are submitted with this job definition. This only\n affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority\n are scheduled before jobs with a lower scheduling priority.
\nThe minimum supported value is 0 and the maximum supported value is 9999.
" } }, "containerProperties": { "target": "com.amazonaws.batch#ContainerProperties", "traits": { "smithy.api#documentation": "An object with properties specific to Amazon ECS-based single-node container-based jobs. If the\n job definition's type parameter is container, then you must specify\n either containerProperties or nodeProperties. This must not be\n specified for Amazon EKS-based job definitions.
If the job runs on Fargate resources, then you must not specify\n nodeProperties. We recommend ecsProperties, which supports both\n single-container and multi-container jobs. containerProperties is also\n supported for single-container jobs. For more information, see Multi-container jobs in the\n Batch User Guide.
An object with properties specific to multi-node parallel jobs. If you specify node\n properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel\n Jobs in the Batch User Guide.
\nIf the job runs on Fargate resources, then you must not specify\n nodeProperties. We recommend ecsProperties, which supports both\n single-container and multi-container jobs. containerProperties is also\n supported for single-container jobs.
If the job runs on Amazon EKS resources, then you must not specify\n nodeProperties.
The retry strategy to use for failed jobs that are submitted with this job definition. Any\n retry strategy that's specified during a SubmitJob operation overrides the\n retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
" } }, "propagateTags": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to propagate the tags from the job or job definition to the\n corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only\n be propagated to the tasks during task creation. For tags with the same name, job tags are\n given priority over job definitions tags. If the total number of combined tags from the job\n and job definition is over 50, the job is moved to the FAILED state.
If the job runs on Amazon EKS resources, then you must not specify\n propagateTags.
The timeout configuration for jobs that are submitted with this job definition, after\n which Batch terminates your jobs if they have not finished. If a job is terminated due to a\n timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout\n configuration that's specified during a SubmitJob operation overrides the\n timeout configuration defined here. For more information, see Job Timeouts in the\n Batch User Guide.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags that you apply to the job definition to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in\n Batch User Guide.
" } }, "platformCapabilities": { "target": "com.amazonaws.batch#PlatformCapabilityList", "traits": { "smithy.api#documentation": "The platform capabilities required by the job definition. If no value is specified, it\n defaults to EC2. To run the job on Fargate resources, specify\n FARGATE. To run the job on Amazon ECS Managed Instances, specify\n MANAGED_INSTANCES.
Jobs with the MANAGED_INSTANCES platform capability must use\n ecsProperties (not containerProperties) and do not support\n multi-node parallel jobs.
If the job runs on Amazon EKS resources, then you must not specify\n platformCapabilities.
An object with properties that are specific to Amazon EKS-based jobs. This must not be\n specified for Amazon ECS based job definitions.
" } }, "ecsProperties": { "target": "com.amazonaws.batch#EcsProperties", "traits": { "smithy.api#documentation": "An object with properties that are specific to Amazon ECS-based jobs. This must not be\n specified for Amazon EKS-based job definitions.
" } }, "consumableResourceProperties": { "target": "com.amazonaws.batch#ConsumableResourceProperties", "traits": { "smithy.api#documentation": "Contains a list of consumable resources required by the job.
" } } }, "traits": { "smithy.api#documentation": "Contains the parameters for RegisterJobDefinition.
The name of the job definition.
", "smithy.api#required": {} } }, "jobDefinitionArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job definition.
", "smithy.api#required": {} } }, "revision": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The revision of the job definition.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#RepositoryCredentials": { "type": "structure", "members": { "credentialsParameter": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret containing the private repository\n credentials.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The repository credentials for private registry authentication.
" } }, "com.amazonaws.batch#ResourceRequirement": { "type": "structure", "members": { "value": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The quantity of the specified resource to reserve for the container. The values vary based\n on the type specified.
The number of physical GPUs to reserve for the container. Make sure that the number of\n GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the\n compute resource that the job is launched on.
\nGPUs aren't available for jobs that are running on Fargate resources.
\nThe memory hard limit (in MiB) present to the container. This parameter is supported for\n jobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory\n specified, the container is terminated. This parameter maps to Memory in the\n Create a container section of the Docker Remote API and the\n --memory option to docker run. You\n must specify at least 4 MiB of memory for a job. This is required but can be specified in\n several places for multi-node parallel (MNP) jobs. It must be specified for each node at least\n once. This parameter maps to Memory in the Create a container\n section of the Docker Remote API and the --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much\n memory as possible for a particular instance type, see Memory management in the\n Batch User Guide.
\nFor jobs that are running on Fargate resources, then value is the hard\n limit (in MiB), and must match one of the supported values and the VCPU values\n must be one of the values supported for that memory value.
\n VCPU = 0.25
\n VCPU = 0.25 or 0.5
\n VCPU = 0.25, 0.5, or 1
\n VCPU = 0.5, or 1
\n VCPU = 0.5, 1, or 2
\n VCPU = 1 or 2
\n VCPU = 1, 2, or 4
\n VCPU = 2 or 4
\n VCPU = 2, 4, or 8
\n VCPU = 4
\n VCPU = 4 or 8
\n VCPU = 8
\n VCPU = 8 or 32
\n VCPU = 8 or 16
\n VCPU = 16
\n VCPU = 16 or 32
\n VCPU = 32
The number of vCPUs reserved for the container. This parameter maps to\n CpuShares in the Create a container section of the\n Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares.\n For Amazon EC2 resources, you must specify at least one vCPU. This is required but can be specified\n in several places; it must be specified for each node at least once.
The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more\n information about Fargate quotas, see Fargate quotas\n in the Amazon Web Services General Reference.
\nFor jobs that are running on Fargate resources, then value must match one\n of the supported values and the MEMORY values must be one of the values supported\n for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, 16, and\n 32.
\n MEMORY = 512, 1024, or 2048
\n MEMORY = 1024, 2048, 3072, or 4096
\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440\n
\n MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880\n
\n MEMORY = 61440, 122880, or 249856
The type of resource to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.
The type and amount of a resource to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.
The number of times to move a job to the RUNNABLE status. You can specify\n between 1 and 10 attempts. If the value of attempts is greater than one, the job is\n retried on failure the same number of attempts as the value.
Array of up to 5 objects that specify the conditions where jobs are retried or failed. If\n this parameter is specified, then the attempts parameter must also be specified. If\n none of the listed conditions match, then the job is retried.
The retry strategy that's associated with a job. For more information, see Automated job retries in the\n Batch User Guide.
" } }, "com.amazonaws.batch#RuntimePlatform": { "type": "structure", "members": { "operatingSystemFamily": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The operating system for the compute environment. Valid values are:\n LINUX (default), WINDOWS_SERVER_2019_CORE,\n WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and\n WINDOWS_SERVER_2022_FULL.
The following parameters can\u2019t be set for Windows containers: linuxParameters,\n privileged, user, ulimits,\n readonlyRootFilesystem, and efsVolumeConfiguration.
The Batch Scheduler checks the compute environments that are attached to the job queue before \n registering a task definition with Fargate. In this scenario, the job queue is where the job is \n submitted. If the job requires a Windows container and the first compute environment is LINUX, \n the compute environment is skipped and the next compute environment is checked until a Windows-based \n compute environment is found.
Fargate Spot is not supported on Windows-based containers on Fargate. \n A job queue will be blocked if a Windows job is submitted to a job \n queue with only Fargate Spot compute environments. However, you can attach both FARGATE and\n FARGATE_SPOT compute environments to the same job queue.
The vCPU architecture. The default value is X86_64. Valid values are\n X86_64 and ARM64.
This parameter must be set to X86_64 for Windows containers.
Fargate Spot is not supported on Windows-based containers on\n Fargate. A job queue will be blocked if a Windows job is\n submitted to a job queue with only Fargate Spot compute environments. However, you can attach\n both FARGATE and FARGATE_SPOT compute environments to the same job\n queue.
An object that represents the compute environment architecture for Batch jobs on\n Fargate.
" } }, "com.amazonaws.batch#S3FilesVolumeConfiguration": { "type": "structure", "members": { "fileSystemArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3Files file system to use.
", "smithy.api#required": {} } }, "rootDirectory": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The directory within the S3Files file system to mount as the root directory.
" } }, "transitEncryptionPort": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The port to use when sending encrypted data between the Amazon ECS host and the S3Files file system\n server.
" } }, "accessPointArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3Files access point to use.
" } } }, "traits": { "smithy.api#documentation": "This is used when you're using an S3Files file system for job storage.
" } }, "com.amazonaws.batch#SchedulingPolicyDetail": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the fair-share scheduling policy.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduling policy. An example is\n arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority\n .
The quota share scheduling policy details.
" } }, "fairsharePolicy": { "target": "com.amazonaws.batch#FairsharePolicy", "traits": { "smithy.api#documentation": "The fair-share scheduling policy details.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags that you apply to the fair-share scheduling policy to categorize and organize your resources.\n Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services resources in\n Amazon Web Services General Reference.
" } } }, "traits": { "smithy.api#documentation": "An object that represents a scheduling policy.
" } }, "com.amazonaws.batch#SchedulingPolicyDetailList": { "type": "list", "member": { "target": "com.amazonaws.batch#SchedulingPolicyDetail" } }, "com.amazonaws.batch#SchedulingPolicyListingDetail": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Amazon Resource Name (ARN) of the scheduling policy.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that contains the details of a scheduling policy that's returned in a\n ListSchedulingPolicy action.
The name of the secret.
", "smithy.api#required": {} } }, "valueFrom": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of\n the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
\nIf the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're\n launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter\n exists in a different Region, then the full ARN must be specified.
\nAn object that represents the secret to expose to your container. Secrets can be exposed to\n a container in the following ways:
\nTo inject sensitive data into your containers as environment variables, use the\n secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the\n secretOptions container definition parameter.
For more information, see Specifying sensitive data in the\n Batch User Guide.
" } }, "com.amazonaws.batch#SecretList": { "type": "list", "member": { "target": "com.amazonaws.batch#Secret" } }, "com.amazonaws.batch#ServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.batch#String" } }, "traits": { "smithy.api#documentation": "These errors are usually caused by a server issue.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.batch#ServiceEnvironmentDetail": { "type": "structure", "members": { "serviceEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the service environment.
", "smithy.api#required": {} } }, "serviceEnvironmentArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service environment.
", "smithy.api#required": {} } }, "serviceEnvironmentType": { "target": "com.amazonaws.batch#ServiceEnvironmentType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
The state of the service environment. Valid values are ENABLED and DISABLED.
The current status of the service environment.
" } }, "capacityLimits": { "target": "com.amazonaws.batch#CapacityLimits", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
" } } }, "traits": { "smithy.api#documentation": "Detailed information about a service environment, including its configuration, state, and capacity limits.
" } }, "com.amazonaws.batch#ServiceEnvironmentDetailList": { "type": "list", "member": { "target": "com.amazonaws.batch#ServiceEnvironmentDetail" } }, "com.amazonaws.batch#ServiceEnvironmentOrder": { "type": "structure", "members": { "order": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The order of the service environment. Job queues with a higher priority are evaluated first when associated with the same service environment.
", "smithy.api#required": {} } }, "serviceEnvironment": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or ARN of the service environment.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the order of a service environment for a job queue. This determines the priority order when multiple service environments are associated with the same job queue.
" } }, "com.amazonaws.batch#ServiceEnvironmentOrders": { "type": "list", "member": { "target": "com.amazonaws.batch#ServiceEnvironmentOrder" } }, "com.amazonaws.batch#ServiceEnvironmentState": { "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.batch#ServiceEnvironmentStatus": { "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" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "VALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALID" } }, "INVALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID" } } } }, "com.amazonaws.batch#ServiceEnvironmentType": { "type": "enum", "members": { "SAGEMAKER_TRAINING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAGEMAKER_TRAINING" } } } }, "com.amazonaws.batch#ServiceJobAttemptDetail": { "type": "structure", "members": { "serviceResourceId": { "target": "com.amazonaws.batch#ServiceResourceId", "traits": { "smithy.api#documentation": "The service resource identifier associated with the service job attempt.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job attempt was started.
" } }, "stoppedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job attempt stopped running.
" } }, "statusReason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A string that provides additional details for the current status of the service job attempt.
" } } }, "traits": { "smithy.api#documentation": "Detailed information about an attempt to run a service job.
" } }, "com.amazonaws.batch#ServiceJobAttemptDetails": { "type": "list", "member": { "target": "com.amazonaws.batch#ServiceJobAttemptDetail" } }, "com.amazonaws.batch#ServiceJobCapacityUsageDetail": { "type": "structure", "members": { "capacityUnit": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The unit of measure for the service job capacity usage. For service jobs, this is the\n instance type.
" } }, "quantity": { "target": "com.amazonaws.batch#Double", "traits": { "smithy.api#documentation": "The quantity of capacity being used by the service job, measured in the units\n specified by capacityUnit.
The capacity usage for a service job, including the unit of\n measure and quantity of resources being consumed.
" } }, "com.amazonaws.batch#ServiceJobCapacityUsageDetailList": { "type": "list", "member": { "target": "com.amazonaws.batch#ServiceJobCapacityUsageDetail" } }, "com.amazonaws.batch#ServiceJobCapacityUsageSummary": { "type": "structure", "members": { "capacityUnit": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The unit of measure for the service job capacity usage. For service jobs, this is the\n instance type.
" } }, "quantity": { "target": "com.amazonaws.batch#Double", "traits": { "smithy.api#documentation": "The quantity of capacity being used by the service job, measured in the units\n specified by capacityUnit.
The capacity usage for a service job, including the unit of\n measure and quantity of resources being used.
" } }, "com.amazonaws.batch#ServiceJobCapacityUsageSummaryList": { "type": "list", "member": { "target": "com.amazonaws.batch#ServiceJobCapacityUsageSummary" } }, "com.amazonaws.batch#ServiceJobEvaluateOnExit": { "type": "structure", "members": { "action": { "target": "com.amazonaws.batch#ServiceJobRetryAction", "traits": { "smithy.api#documentation": "The action to take if the service job exits with the specified condition. Valid values are RETRY and EXIT.
Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters and can contain all printable characters. It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
" } } }, "traits": { "smithy.api#documentation": "Specifies conditions for when to exit or retry a service job based on the exit status or status reason.
" } }, "com.amazonaws.batch#ServiceJobEvaluateOnExitList": { "type": "list", "member": { "target": "com.amazonaws.batch#ServiceJobEvaluateOnExit" } }, "com.amazonaws.batch#ServiceJobPreemptedAttempt": { "type": "structure", "members": { "serviceResourceId": { "target": "com.amazonaws.batch#ServiceResourceId", "traits": { "smithy.api#documentation": "The service resource identifier associated with the service job attempt.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job attempt was started.
" } }, "stoppedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job attempt stopped running.
" } }, "statusReason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A string that provides additional details for the current status of the service job attempt.
" } } }, "traits": { "smithy.api#documentation": "Detailed information about a preempted attempt of a service job.
" } }, "com.amazonaws.batch#ServiceJobPreemptionConfiguration": { "type": "structure", "members": { "preemptionRetriesBeforeTermination": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The number of times a service job can be retried after it is preempted. A job will be terminated when preemption retries have been exhausted.\n If this field is unset, preempted jobs will be requeued an unlimited number of times.
" } } }, "traits": { "smithy.api#documentation": "Specifies the service job behavior when preempted.
" } }, "com.amazonaws.batch#ServiceJobPreemptionSummary": { "type": "structure", "members": { "preemptedAttemptCount": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The total number of times the service job has been preempted.
" } }, "recentPreemptedAttempts": { "target": "com.amazonaws.batch#ServiceJobRecentPreemptedAttemptList", "traits": { "smithy.api#documentation": "A list of the most recent preemption attempts for the service job.
" } } }, "traits": { "smithy.api#documentation": "Summarizes the preemptions of the service job. This field appears on a service job\n when it has been preempted.
" } }, "com.amazonaws.batch#ServiceJobRecentPreemptedAttemptList": { "type": "list", "member": { "target": "com.amazonaws.batch#ServiceJobPreemptedAttempt" } }, "com.amazonaws.batch#ServiceJobRetryAction": { "type": "enum", "members": { "RETRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETRY" } }, "EXIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXIT" } } } }, "com.amazonaws.batch#ServiceJobRetryStrategy": { "type": "structure", "members": { "attempts": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The number of times to move a service job to RUNNABLE status. You can specify between 1 and 10 attempts.
Array of ServiceJobEvaluateOnExit objects that specify conditions under which the service job should be retried or failed.
The retry strategy for service jobs. This defines how many times to retry a failed service job and under what conditions. For more information, see Service job retry strategies in the Batch User Guide.
" } }, "com.amazonaws.batch#ServiceJobStatus": { "type": "enum", "members": { "SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUBMITTED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNABLE" } }, "SCHEDULED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCHEDULED" } }, "STARTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.batch#ServiceJobSummary": { "type": "structure", "members": { "latestAttempt": { "target": "com.amazonaws.batch#LatestServiceJobAttempt", "traits": { "smithy.api#documentation": "Information about the latest attempt for the service job.
" } }, "capacityUsage": { "target": "com.amazonaws.batch#ServiceJobCapacityUsageSummaryList", "traits": { "smithy.api#documentation": "The capacity usage information for this service job, including the unit of measure and\n quantity of resources being used.
" } }, "createdAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job was created.
" } }, "jobArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service job.
" } }, "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job ID for the service job.
", "smithy.api#required": {} } }, "jobName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the service job.
", "smithy.api#required": {} } }, "scheduledAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job was scheduled for\n execution.
" } }, "serviceJobType": { "target": "com.amazonaws.batch#ServiceJobType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
The share identifier for the job.
" } }, "quotaShareName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The quota share for the service job.
" } }, "status": { "target": "com.amazonaws.batch#ServiceJobStatus", "traits": { "smithy.api#documentation": "The current status of the service job.
" } }, "statusReason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short string to provide more details on the current status of the service job.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job was started.
" } }, "stoppedAt": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the service job stopped running.
" } }, "isTerminated": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Indicates whether a termination request has been accepted for the service job. This field is only present when the value is true.
Summary information about a service job.
" } }, "com.amazonaws.batch#ServiceJobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.batch#ServiceJobSummary" } }, "com.amazonaws.batch#ServiceJobTimeout": { "type": "structure", "members": { "attemptDurationSeconds": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The maximum duration in seconds that a service job attempt can run. After this time is reached, Batch terminates the service job attempt.
" } } }, "traits": { "smithy.api#documentation": "The timeout configuration for service jobs.
" } }, "com.amazonaws.batch#ServiceJobType": { "type": "enum", "members": { "SAGEMAKER_TRAINING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAGEMAKER_TRAINING" } } } }, "com.amazonaws.batch#ServiceResourceId": { "type": "structure", "members": { "name": { "target": "com.amazonaws.batch#ServiceResourceIdName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the resource identifier.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The value of the resource identifier.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The Batch unique identifier.
" } }, "com.amazonaws.batch#ServiceResourceIdName": { "type": "enum", "members": { "SAGEMAKER_TRAINING_JOB_ARN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TrainingJobArn" } } } }, "com.amazonaws.batch#ShareAttributes": { "type": "structure", "members": { "shareIdentifier": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A share identifier or share identifier prefix. If the string ends with an asterisk\n (*), this entry specifies the weight factor to use for share identifiers that start with\n that prefix. The list of share identifiers in a fair-share policy can't overlap. For\n example, you can't have one that specifies a shareIdentifier of UserA*\n and another that specifies a shareIdentifier of UserA1.
There can be no more than 500 share identifiers active in a job queue.
\nThe string is limited to 255 alphanumeric characters, and can be followed by an asterisk\n (*).
", "smithy.api#required": {} } }, "weightFactor": { "target": "com.amazonaws.batch#Float", "traits": { "smithy.api#documentation": "The weight factor for the share identifier. The default value is 1.0. A lower value has\n a higher priority for compute resources. For example, jobs that use a share identifier with a\n weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share\n identifier with a weight factor of 1.
\nThe smallest supported value is 0.0001, and the largest supported value is 999.9999.
" } } }, "traits": { "smithy.api#documentation": "Specifies the weights for the share identifiers for the fair-share policy. Share\n identifiers that aren't included have a default weight of 1.0.
Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory\n requirements that are specified in the resourceRequirements objects in the job\n definition are the exception. They can't be overridden this way using the memory\n and vcpus parameters. Rather, you must specify updates to job definition\n parameters in a resourceRequirements object that's included in the\n containerOverrides parameter.
Job queues with a scheduling policy are limited to 500 active share identifiers at\n a time.
\nJobs that run on Fargate resources can't be guaranteed to run for more than 14 days.\n This is because, after 14 days, Fargate resources might become unavailable and job might be\n terminated.
\nThe name of the job. It can be up to 128 letters long. The first character must be\n alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and\n underscores (_).
", "smithy.api#required": {} } }, "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN)\n of the queue.
", "smithy.api#required": {} } }, "shareIdentifier": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The share identifier for the job. Don't specify this parameter if the job queue doesn't\n have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must\n be specified.
\nThis string is limited to 255 alphanumeric characters, and can be followed by an asterisk\n (*).
" } }, "schedulingPriorityOverride": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The scheduling priority for the job. This only affects jobs in job queues with a \n fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority. This overrides any scheduling priority in the job definition and works only \n within a single share identifier.
\nThe minimum supported value is 0 and the maximum supported value is 9999.
" } }, "arrayProperties": { "target": "com.amazonaws.batch#ArrayProperties", "traits": { "smithy.api#documentation": "The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. For more information, see Array Jobs in the Batch User Guide.
" } }, "dependsOn": { "target": "com.amazonaws.batch#JobDependencyList", "traits": { "smithy.api#documentation": "A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can\n specify a SEQUENTIAL type dependency without specifying a job ID for array jobs\n so that each child array job completes sequentially, starting at index 0. You can also specify\n an N_TO_N type dependency with a job ID for array jobs. In that case, each index\n child of this job must wait for the corresponding index child of each dependency to complete\n before it can begin.
The job definition used by this job. This value can be one of\n definition-name, definition-name:revision, or the Amazon Resource Name (ARN) for the\n job definition, with or without the revision\n (arn:aws:batch:region:account:job-definition/definition-name:revision\n ,\n or\n arn:aws:batch:region:account:job-definition/definition-name\n ).
If the revision is not specified, then the latest active revision is used.
", "smithy.api#required": {} } }, "parameters": { "target": "com.amazonaws.batch#ParametersMap", "traits": { "smithy.api#documentation": "Additional parameters passed to the job that replace parameter substitution placeholders\n that are set in the job definition. Parameters are specified as a key and value pair mapping.\n Parameters in a SubmitJob request override any corresponding parameter defaults\n from the job definition.
An object with properties that override the defaults for the job definition that specify\n the name of a container in the specified job definition and the overrides it should receive.\n You can override the default command for a container, which is specified in the job definition\n or the Docker image, with a command override. You can also override existing\n environment variables on a container or add new environment variables to it with an\n environment override.
A list of node overrides in JSON format that specify the node range to target and the\n container overrides for that node range.
\nThis parameter isn't applicable to jobs that are running on Fargate resources; use\n containerOverrides instead.
The retry strategy to use for failed jobs from this SubmitJob operation.\n When a retry strategy is specified here, it overrides the retry strategy defined in the job\n definition.
" } }, "propagateTags": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to propagate the tags from the job or job definition to the\n corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only\n be propagated to the tasks during task creation. For tags with the same name, job tags are\n given priority over job definitions tags. If the total number of combined tags from the job\n and job definition is over 50, the job is moved to the FAILED state. When\n specified, this overrides the tag propagation setting in the job definition.
The timeout configuration for this SubmitJob operation. You can specify\n a timeout duration after which Batch terminates your jobs if they haven't finished. If a job\n is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60\n seconds. This configuration overrides any timeout configuration specified in the job\n definition. For array jobs, child jobs have the same timeout configuration as the parent job.\n For more information, see Job Timeouts in the\n Amazon Elastic Container Service Developer Guide.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags that you apply to the job request to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services\n Resources in Amazon Web Services General Reference.
" } }, "eksPropertiesOverride": { "target": "com.amazonaws.batch#EksPropertiesOverride", "traits": { "smithy.api#documentation": "An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.
" } }, "ecsPropertiesOverride": { "target": "com.amazonaws.batch#EcsPropertiesOverride", "traits": { "smithy.api#documentation": "An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.
" } }, "consumableResourcePropertiesOverride": { "target": "com.amazonaws.batch#ConsumableResourceProperties", "traits": { "smithy.api#documentation": "An object that contains overrides for the consumable resources of a job.
" } } }, "traits": { "smithy.api#documentation": "Contains the parameters for SubmitJob.
The Amazon Resource Name (ARN) for the job.
" } }, "jobName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the job.
", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique identifier for the job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#SubmitServiceJob": { "type": "operation", "input": { "target": "com.amazonaws.batch#SubmitServiceJobRequest" }, "output": { "target": "com.amazonaws.batch#SubmitServiceJobResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Submits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.
", "smithy.api#http": { "method": "POST", "uri": "/v1/submitservicejob", "code": 200 } } }, "com.amazonaws.batch#SubmitServiceJobRequest": { "type": "structure", "members": { "jobName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING.
The retry strategy to use for failed service jobs that are submitted with this service job request.
" } }, "schedulingPriority": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "The scheduling priority of the service job. Valid values are integers between 0 and 9999.
" } }, "serviceRequestPayload": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The request, in JSON, for the service that the SubmitServiceJob operation is queueing.
", "smithy.api#required": {} } }, "serviceJobType": { "target": "com.amazonaws.batch#ServiceJobType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.
The share identifier for the service job. Don't specify this parameter if the job\n queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share\n scheduling policy, then this parameter must be specified.
" } }, "quotaShareName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The quota share for the service job. Don't specify this parameter if the job queue\n doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy,\n then this parameter must be specified.
" } }, "preemptionConfiguration": { "target": "com.amazonaws.batch#ServiceJobPreemptionConfiguration", "traits": { "smithy.api#documentation": "Specifies the service job behavior when preempted.
" } }, "timeoutConfig": { "target": "com.amazonaws.batch#ServiceJobTimeout", "traits": { "smithy.api#documentation": "The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#documentation": "The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
" } }, "clientToken": { "target": "com.amazonaws.batch#ClientRequestToken", "traits": { "smithy.api#documentation": "A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected.
The Amazon Resource Name (ARN) for the service job.
" } }, "jobName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the service job.
", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique identifier for the service job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.batch#TagKeysList": { "type": "list", "member": { "target": "com.amazonaws.batch#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.batch#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.batch#TagResourceRequest" }, "output": { "target": "com.amazonaws.batch#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Associates the specified tags to a resource with the specified resourceArn.\n If existing tags on a resource aren't specified in the request parameters, they aren't\n changed. When a resource is deleted, the tags that are associated with that resource are\n deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The tags that you apply to the resource to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services\n Resources in Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for TagResource.
A unique identifier for the container.
" } }, "condition": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The dependency condition of the container. The following are the available conditions and\n their behavior:
\n\n START - This condition emulates the behavior of links and volumes today. It\n validates that a dependent container is started before permitting other containers to start.\n
\n COMPLETE - This condition validates that a dependent container runs to\n completion (exits) before permitting other containers to start. This can be useful for\n nonessential containers that run a script and then exit. This condition can't be set on an\n essential container.
\n SUCCESS - This condition is the same as COMPLETE, but it also\n requires that the container exits with a zero status. This condition can't be set on an\n essential container.
A list of containers that this task depends on.
" } }, "com.amazonaws.batch#TaskContainerDependencyList": { "type": "list", "member": { "target": "com.amazonaws.batch#TaskContainerDependency" } }, "com.amazonaws.batch#TaskContainerDetails": { "type": "structure", "members": { "command": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "The command that's passed to the container. This parameter maps to Cmd in the\n Create a container section of the Docker Remote API and the COMMAND\n parameter to docker run. For more information, see\n https://docs.docker.com/engine/reference/builder/#cmd.
A list of containers that this container depends on.
" } }, "environment": { "target": "com.amazonaws.batch#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables to pass to a container. This parameter maps to Env in\n the Create a container section of the Docker Remote API and the\n --env option to docker run.
We don't recommend using plaintext environment variables for sensitive information, such as\n credential data.
\nIf the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.
All jobs must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.
" } }, "firelensConfiguration": { "target": "com.amazonaws.batch#FirelensConfiguration", "traits": { "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a\n log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer\n Guide.
" } }, "image": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The image used to start a container. This string is passed directly to the Docker daemon. By\n default, images in the Docker Hub registry are available. Other repositories are specified with\n either repository-url/image:tag or repository-url/image@digest. Up to\n 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward\n slashes, and number signs are allowed. This parameter maps to Image in the Create a\n container section of the Docker\n Remote API and the IMAGE parameter of the \n docker\n run\n .
Linux-specific modifications that are applied to the container, such as Linux kernel\n capabilities. For more information, see KernelCapabilities.
\nThis parameter is not supported for Windows containers.
\nThe log configuration specification for the container.
\nThis parameter maps to LogConfig in the Create a\n container section of the Docker\n Remote API and the --log-driver option to docker\n run.
By default, containers use the same logging driver that the Docker daemon uses. However the\n container can use a different logging driver than the Docker daemon by specifying a log driver\n with this parameter in the container definition. To use a different logging driver for a\n container, the log system must be configured properly on the container instance (or on a\n different log server for remote logging options). For more information about the options for\n different supported log drivers, see Configure logging drivers \n in the Docker documentation.
\nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon\n (shown in the LogConfiguration data type). Additional log drivers may be available\n in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container\n instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version --format\n '{{.Server.APIVersion}}'\n
The Amazon ECS container agent running on a container instance must register the logging drivers\n available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment\n variable before containers placed on that instance can use these log configuration options. For\n more information, see Amazon ECS container agent\n configuration in the Amazon Elastic Container Service Developer Guide.
The mount points for data volumes in your container.
\nThis parameter maps to Volumes in the Create a\n container section of the Docker\n Remote API and the --volume option to docker\n run.
Windows containers can mount whole directories on the same drive as\n $env:ProgramData. Windows containers can't mount directories on a different drive,\n and mount point can't be across drives.
The name of a container.
" } }, "privileged": { "target": "com.amazonaws.batch#Boolean", "traits": { "smithy.api#documentation": "When this parameter is true, the container is given elevated privileges on the\n host container instance (similar to the root user). This parameter maps to\n Privileged in the Create a\n container section of the Docker\n Remote API and the --privileged option to docker\n 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 system. This parameter maps to ReadonlyRootfs in the Create a\n container section of the Docker\n Remote API and the --read-only option to docker\n run.
This parameter is not supported for Windows containers.
\nThe private repository authentication credentials to use.
" } }, "resourceRequirements": { "target": "com.amazonaws.batch#ResourceRequirements", "traits": { "smithy.api#documentation": "The type and amount of a resource to assign to a container. The only supported resource is a\n GPU.
" } }, "secrets": { "target": "com.amazonaws.batch#SecretList", "traits": { "smithy.api#documentation": "The secrets to pass to the container. For more information, see Specifying Sensitive\n Data in the Amazon Elastic Container Service Developer Guide.
" } }, "ulimits": { "target": "com.amazonaws.batch#Ulimits", "traits": { "smithy.api#documentation": "A list of ulimits to set in the container. If a ulimit value is\n specified in a task definition, it overrides the default values set by Docker. This parameter\n maps to Ulimits in the Create a\n container section of the Docker\n Remote API and the --ulimit option to docker\n run.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating\n system with the exception of the nofile resource limit parameter which Fargate overrides. The\n nofile resource limit sets a restriction on the number of open files that a\n container can use. The default nofile soft limit is 1024 and the\n default hard limit is 65535.
This parameter requires version 1.18 of the Docker Remote API or greater on your container\n instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version --format\n '{{.Server.APIVersion}}'\n
This parameter is not supported for Windows containers.
\nThe user to use inside the container. This parameter maps to User in the Create a container\n section of the Docker Remote API and the --user option to docker run.
\nWhen running tasks using the host network mode, don't run containers using the\n root user (UID 0). We recommend using a non-root user for better security.
You can specify the user using the following formats. If specifying a UID or\n 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:gi\n
\n uid:group\n
\n \n
This parameter is not supported for Windows containers.
\nTime duration (in seconds) to wait before giving up on resolving dependencies for a\n container. The minimum value is 2 seconds and the maximum value for Fargate is 120\n seconds.
" } }, "stopTimeout": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't\n exit normally on its own. The minimum value is 2 seconds and the maximum value for Fargate is\n 120 seconds. If the parameter is not specified, the default value of 30 seconds is used. For\n tasks that use the EC2 launch type, if the stopTimeout parameter isn't specified,\n the value set for the Amazon ECS container agent configuration variable\n ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout\n parameter nor the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set,\n then the default value of 30 seconds is used.
The exit code returned upon completion.
" } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a\n running or stopped container.
" } }, "logStreamName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the CloudWatch Logs log stream that's associated with the container. The log group for\n Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach\n the RUNNING status.
The network interfaces that are associated with the job.
" } } }, "traits": { "smithy.api#documentation": "The details for the container in this task attempt.
" } }, "com.amazonaws.batch#TaskContainerOverrides": { "type": "structure", "members": { "command": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "The command to send to the container that overrides the default command from the Docker\n image or the job definition.
\nThis parameter can't contain an empty string.
\nThe environment variables to send to the container. You can add new environment variables,\n which are added to the container at launch, or you can override the existing environment\n variables from the Docker image or the job definition.
\nEnvironment variables cannot start with AWS_BATCH. This naming convention is\n reserved for variables that Batch sets.
A pointer to the container that you want to override. The container's name provides a unique\n identifier for the container being used.
" } }, "resourceRequirements": { "target": "com.amazonaws.batch#ResourceRequirements", "traits": { "smithy.api#documentation": "The type and amount of resources to assign to a container. This overrides the settings in\n the job definition. The supported resources include GPU, MEMORY, and\n VCPU.
The overrides that should be sent to a container.
\nFor information about using Batch overrides when you connect event sources to targets, see\n BatchContainerOverrides.
" } }, "com.amazonaws.batch#TaskContainerProperties": { "type": "structure", "members": { "command": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#documentation": "The command that's passed to the container. This parameter maps to Cmd in the\n Create a\n container section of the Docker\n Remote API and the COMMAND parameter to docker run. For more information,\n see Dockerfile reference:\n CMD.
A list of containers that this container depends on.
" } }, "environment": { "target": "com.amazonaws.batch#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables to pass to a container. This parameter maps to Env in the Create a container\n section of the Docker Remote API\n and the --env parameter to docker run.
We don't recommend using plaintext environment variables for sensitive information, such as\n credential data.
\nEnvironment variables cannot start with AWS_BATCH. This naming convention is\n reserved for variables that Batch sets.
If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.
All jobs must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.
" } }, "firelensConfiguration": { "target": "com.amazonaws.batch#FirelensConfiguration", "traits": { "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a\n log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer\n Guide.
" } }, "image": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The image used to start a container. This string is passed directly to the Docker daemon. By\n default, images in the Docker Hub registry are available. Other repositories are specified with\n either repository-url/image:tag or repository-url/image@digest. Up to\n 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward\n slashes, and number signs are allowed. This parameter maps to Image in the Create a\n container section of the Docker\n Remote API and the IMAGE parameter of the \n docker\n run\n .
Linux-specific modifications that are applied to the container, such as Linux kernel\n capabilities. For more information, see KernelCapabilities.
" } }, "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { "smithy.api#documentation": "The log configuration specification for the container.
\nThis parameter maps to LogConfig in the Create a\n container section of the Docker\n Remote API and the --log-driver option to docker\n run.
By default, containers use the same logging driver that the Docker daemon uses. However the\n container can use a different logging driver than the Docker daemon by specifying a log driver\n with this parameter in the container definition. To use a different logging driver for a\n container, the log system must be configured properly on the container instance (or on a\n different log server for remote logging options). For more information about the options for\n different supported log drivers, see Configure logging drivers \n in the Docker documentation.
\nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon\n (shown in the LogConfiguration data type). Additional log drivers may be available\n in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container\n instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version --format\n '{{.Server.APIVersion}}'\n
The Amazon ECS container agent running on a container instance must register the logging drivers\n available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment\n variable before containers placed on that instance can use these log configuration options. For\n more information, see Amazon ECS container agent\n configuration in the Amazon Elastic Container Service Developer Guide.
The mount points for data volumes in your container.
\nThis parameter maps to Volumes in the Create a\n container section of the Docker\n Remote API and the --volume option to docker\n run.
Windows containers can mount whole directories on the same drive as\n $env:ProgramData. Windows containers can't mount directories on a different drive,\n and mount point can't be across drives.
The name of a container. The name can be used as a unique identifier to target your\n dependsOn and Overrides objects.
When this parameter is true, the container is given elevated privileges on the\n host container instance (similar to the root user). This parameter maps to\n Privileged in the Create a\n container section of the Docker\n Remote API and the --privileged option to docker\n 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 system. This parameter maps to ReadonlyRootfs in the Create a\n container section of the Docker\n Remote API and the --read-only option to docker\n run.
This parameter is not supported for Windows containers.
\nThe private repository authentication credentials to use.
" } }, "resourceRequirements": { "target": "com.amazonaws.batch#ResourceRequirements", "traits": { "smithy.api#documentation": "The type and amount of a resource to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.
The secrets to pass to the container. For more information, see Specifying Sensitive\n Data in the Amazon Elastic Container Service Developer Guide.
" } }, "ulimits": { "target": "com.amazonaws.batch#Ulimits", "traits": { "smithy.api#documentation": "A list of ulimits to set in the container. If a ulimit value is\n specified in a task definition, it overrides the default values set by Docker. This parameter\n maps to Ulimits in the Create a\n container section of the Docker\n Remote API and the --ulimit option to docker\n run.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating\n system with the exception of the nofile resource limit parameter which Fargate overrides. The\n nofile resource limit sets a restriction on the number of open files that a\n container can use. The default nofile soft limit is 1024 and the\n default hard limit is 65535.
This parameter requires version 1.18 of the Docker Remote API or greater on your container\n instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version --format\n '{{.Server.APIVersion}}'\n
This parameter is not supported for Windows containers.
\nThe user to use inside the container. This parameter maps to User in the Create a container\n section of the Docker Remote API and the --user option to docker run.
\nWhen running tasks using the host network mode, don't run containers using the\n root user (UID 0). We recommend using a non-root user for better security.
You can specify the user using the following formats. If specifying a UID or\n 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:gi\n
\n uid:group\n
This parameter is not supported for Windows containers.
\nTime duration (in seconds) to wait before giving up on resolving dependencies for a\n container. The minimum value is 2 seconds and the maximum value for Fargate is 120\n seconds.
" } }, "stopTimeout": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#documentation": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't\n exit normally on its own. The minimum value is 2 seconds and the maximum value for Fargate is\n 120 seconds. If the parameter is not specified, the default value of 30 seconds is used. For\n tasks that use the EC2 launch type, if the stopTimeout parameter isn't specified,\n the value set for the Amazon ECS container agent configuration variable\n ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout\n parameter nor the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set,\n then the default value of 30 seconds is used.
Container properties are used for Amazon ECS-based job definitions. These properties to describe\n the container that's launched as part of a job.
" } }, "com.amazonaws.batch#TaskPropertiesOverride": { "type": "structure", "members": { "containers": { "target": "com.amazonaws.batch#ListTaskContainerOverrides", "traits": { "smithy.api#documentation": "The overrides for the container definition of a job.
" } } }, "traits": { "smithy.api#documentation": "An object that contains overrides for the task definition of a job.
" } }, "com.amazonaws.batch#TerminateJob": { "type": "operation", "input": { "target": "com.amazonaws.batch#TerminateJobRequest" }, "output": { "target": "com.amazonaws.batch#TerminateJobResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Terminates a job in a job queue. Jobs that are in the STARTING or\n RUNNING state are terminated, which causes them to transition to\n FAILED. Jobs that have not progressed to the STARTING state are\n cancelled.
The Batch job ID of the job to terminate.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A message to attach to the job that explains the reason for terminating it. This message is\n returned by future DescribeJobs operations on the job. It is also\n recorded in the Batch activity logs.
\nThis parameter has a limit of 1024 characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for TerminateJob.
Terminates up to 50 jobs in a job queue. This is a bulk version of TerminateJob. Jobs that are in the STARTING or\n RUNNING state are terminated, which causes them to transition to\n FAILED. Jobs that have not progressed to the STARTING state are\n cancelled.
Batch reports the result for each job individually in the response. Jobs that\n were processed successfully are reported in the successful list. Jobs that\n encountered errors are reported in the errors list. The response returns an\n HTTP status code of 200 even when some jobs encountered errors, so check the\n errors list. Jobs that can't be found are treated as successfully\n processed.
This operation requires batch:TerminateJob permission for each job in the\n request. There is no separate batch:TerminateJobs IAM action. If a caller's IAM\n policy grants batch:TerminateJob, they can use both the singular\n TerminateJob and bulk TerminateJobs operations.
The Batch job ID of the job that couldn't be terminated.
", "smithy.api#required": {} } }, "code": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "An error code that identifies the reason the job couldn't be terminated. Valid values are:
\n\n ValidationException \u2013 A job identifier in the request is malformed or isn't valid.
\n ClientException \u2013 The request failed because of a client error.
\n ThrottlingException \u2013 The request was throttled. Retry the request.
\n ServerException \u2013 An internal error occurred. Retry the request.
\n AccessDenied \u2013 The caller isn't authorized to perform the action on the specified job.
A message that describes the reason the job couldn't be terminated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that contains the details of a job that couldn't be terminated by a\n TerminateJobs operation.
An array of up to 50 Batch job IDs of the jobs to terminate.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A message to attach to the job that explains the reason for terminating it. This message is\n returned by future DescribeJobs operations on the job. It is also\n recorded in the Batch activity logs.
\nThis parameter has a limit of 1024 characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the jobs to terminate and the reason for the termination.
", "smithy.api#input": {} } }, "com.amazonaws.batch#TerminateJobsResponse": { "type": "structure", "members": { "successful": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of the job IDs whose termination request was accepted.
", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.batch#TerminateJobsErrorDetailList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of TerminateJobsErrorDetail items, one for each job that couldn't be\n terminated. Each item includes the job ID along with a code and message that describe why the\n job wasn't terminated.
The result of a TerminateJobs request, including the jobs whose termination\n request was accepted and the errors for jobs that couldn't be terminated.
Terminates a service job in a job queue.
", "smithy.api#http": { "method": "POST", "uri": "/v1/terminateservicejob", "code": 200 } } }, "com.amazonaws.batch#TerminateServiceJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The service job ID of the service job to terminate.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A message to attach to the service job that explains the reason for terminating it. This message is returned by DescribeServiceJob operations on the service job.
Terminates up to 50 service jobs in a job queue. This is a bulk version of TerminateServiceJob.
\nBatch reports the result for each service job individually in the response. Service jobs that were processed successfully are reported in the successful list. Service jobs that encountered errors are reported in the errors list. The response returns an HTTP status code of 200 even when some service jobs encountered errors, so check the errors list. Service jobs that can't be found are treated as successfully processed.
This operation requires batch:TerminateServiceJob permission for each service job in the\n request. There is no separate batch:TerminateServiceJobs IAM action. If a caller's IAM\n policy grants batch:TerminateServiceJob, they can use both the singular\n TerminateServiceJob and bulk TerminateServiceJobs operations.
The service job ID of the service job that couldn't be terminated.
", "smithy.api#required": {} } }, "code": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "An error code that identifies the reason the service job couldn't be terminated. Valid values are:
\n\n ValidationException \u2013 A service job identifier in the request is malformed or isn't valid.
\n ClientException \u2013 The request failed because of a client error.
\n ThrottlingException \u2013 The request was throttled. Retry the request.
\n ServerException \u2013 An internal error occurred. Retry the request.
\n AccessDenied \u2013 The caller isn't authorized to perform the action on the specified service job.
A message that describes the reason the service job couldn't be terminated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that contains the details of a service job that couldn't be terminated by a TerminateServiceJobs operation.
An array of up to 50 service job IDs of the service jobs to terminate.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A message to attach to the service job that explains the reason for terminating it. This message is returned by DescribeServiceJob operations on the service job.
Specifies the service jobs to terminate and the reason for the termination.
", "smithy.api#input": {} } }, "com.amazonaws.batch#TerminateServiceJobsResponse": { "type": "structure", "members": { "successful": { "target": "com.amazonaws.batch#StringList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of the service job IDs whose termination request was accepted.
", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.batch#TerminateServiceJobsErrorDetailList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of TerminateServiceJobsErrorDetail items, one for each service job that couldn't be terminated. Each item includes the service job ID along with a code and message that describe why the service job wasn't terminated.
The result of a TerminateServiceJobs request, including the service jobs whose termination request was accepted and the errors for service jobs that couldn't be terminated.
The absolute file path in the container where the tmpfs volume is\n mounted.
The size (in MiB) of the tmpfs volume.
The list of tmpfs volume mount options.
Valid values: \"defaults\" | \"ro\" | \"rw\" |\n \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n \"exec\" | \"noexec\" | \"sync\" | \"async\" |\n \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n \"atime\" | \"noatime\" | \"diratime\" |\n \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" |\n \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" |\n \"norelatime\" | \"strictatime\" | \"nostrictatime\" |\n \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" |\n \"nr_blocks\" | \"mpol\"
The container path, mount options, and size of the tmpfs mount.
This object isn't applicable to jobs that are running on Fargate resources.
\nThe hard limit for the ulimit type.
The type of the ulimit. Valid values are: core |\n cpu | data | fsize | locks |\n memlock | msgqueue | nice | nofile |\n nproc | rss | rtprio | rttime |\n sigpending | stack.
The soft limit for the ulimit type.
The ulimit settings to pass to the container. For more information, see Ulimit.
This object isn't applicable to jobs that are running on Fargate resources.
\nDeletes specified tags from an Batch resource.
", "smithy.api#examples": [ { "title": "UntagResource Example", "documentation": "This demonstrates calling the UntagResource action.", "input": { "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1", "tagKeys": [ "Stage" ] }, "output": {} } ], "smithy.api#http": { "method": "DELETE", "uri": "/v1/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.batch#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.batch#TagKeysList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The keys of the tags to be removed.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the parameters for UntagResource.
Updates an Batch compute environment.
", "smithy.api#examples": [ { "title": "To update a compute environment", "documentation": "This example disables the P2OnDemand compute environment so it can be deleted.", "input": { "computeEnvironment": "P2OnDemand", "state": "DISABLED" }, "output": { "computeEnvironmentName": "P2OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand" } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/updatecomputeenvironment", "code": 200 } } }, "com.amazonaws.batch#UpdateComputeEnvironmentRequest": { "type": "structure", "members": { "computeEnvironment": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or full Amazon Resource Name (ARN) of the compute environment to update.
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.batch#CEState", "traits": { "smithy.api#documentation": "The state of the compute environment. Compute environments in the ENABLED\n state can accept jobs from a queue and scale in or out automatically based on the workload\n demand of its associated queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs\n from an associated job queue on the compute resources within the environment. If the compute\n environment is managed, then it can scale its instances out or in automatically, based on the\n job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place\n jobs within the environment. Jobs in a STARTING or RUNNING state\n continue to progress normally. Managed compute environments in the DISABLED state\n don't scale out.
Compute environments in a DISABLED state may continue to incur billing\n charges, for example, if they have running instances due to jobs that are still executing or a non-zero minvCpus setting. To prevent additional charges, disable and delete the compute environment.
When an instance is idle, the instance scales down to the minvCpus value.\n However, the instance size doesn't change. For example, consider a c5.8xlarge\n instance with a minvCpus value of 4 and a desiredvCpus\n value of 36. This instance doesn't scale down to a c5.large\n instance.
The maximum number of vCPUs expected to be used for an unmanaged compute environment.\n Don't specify this parameter for a managed compute environment. This parameter is only used\n for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this\n parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.
" } }, "computeResources": { "target": "com.amazonaws.batch#ComputeResourceUpdate", "traits": { "smithy.api#documentation": "Details of the compute resources managed by the compute environment. Required for a\n managed compute environment. For more information, see Compute Environments in the\n Batch User Guide.
" } }, "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services\n services on your behalf. For more information, see Batch service IAM role in the\n Batch User Guide.
\nIf the compute environment has a service-linked role, it can't be changed to use a\n regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't\n be changed to use a service-linked role. To update the parameters for the compute\n environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information,\n see Updating\n compute environments in the Batch User Guide.
\nIf your specified role has a path other than /, then you must either specify\n the full role ARN (recommended) or prefix the role name with the path.
Depending on how you created your Batch service role, its ARN might contain the\n service-role path prefix. When you only specify the name of the service role,\n Batch assumes that your ARN doesn't use the service-role path prefix. Because\n of this, we recommend that you specify the full ARN of your service role when you create\n compute environments.
Specifies the updated infrastructure update policy for the compute environment. For more\n information about infrastructure updates, see Updating compute environments in\n the Batch User Guide.
" } }, "context": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Reserved.
" } }, "ecsSettings": { "target": "com.amazonaws.batch#EcsSettings", "traits": { "smithy.api#documentation": "The Amazon ECS settings for the compute environment. These settings control CloudWatch\n Container Insights collection for the compute environment.
" } }, "eksConfiguration": { "target": "com.amazonaws.batch#EksConfigurationUpdate", "traits": { "smithy.api#documentation": "Updates the Amazon EKS configuration for the compute environment. Only specify this\n parameter if the compute environment's containerOrchestrationType is\n EKS. Currently, the accessEntry setting is the only Amazon EKS configuration that\n you can change after the compute environment is created. For more information, see Amazon EKS access entry\n authentication in the Batch User Guide.
Contains the parameters for UpdateComputeEnvironment.
The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
" } }, "computeEnvironmentArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the compute environment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#UpdateConsumableResource": { "type": "operation", "input": { "target": "com.amazonaws.batch#UpdateConsumableResourceRequest" }, "output": { "target": "com.amazonaws.batch#UpdateConsumableResourceResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Updates a consumable resource.
", "smithy.api#examples": [ { "title": "To update a consumable resource", "documentation": "Updates a consumable resource.", "input": { "consumableResource": "myConsumableResource", "operation": "ADD", "quantity": 12 }, "output": { "consumableResourceName": "myConsumableResource", "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource", "totalQuantity": 135 } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/updateconsumableresource", "code": 200 } } }, "com.amazonaws.batch#UpdateConsumableResourceRequest": { "type": "structure", "members": { "consumableResource": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or ARN of the consumable resource to be updated.
", "smithy.api#required": {} } }, "operation": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Indicates how the quantity of the consumable resource will be updated. Must be one of:
\n\n SET\n
Sets the quantity of the resource to the value specified by the quantity\n parameter.
\n ADD\n
Increases the quantity of the resource by the value specified by the quantity\n parameter.
\n REMOVE\n
Reduces the quantity of the resource by the value specified by the quantity\n parameter.
The change in the total quantity of the consumable resource. The operation\n parameter determines whether the value specified here will be the new total quantity, or\n the amount by which the total quantity will be increased or reduced. Must be a non-negative \n value.
If this parameter is specified and two update requests with identical payloads and \n clientTokens are received, these requests are considered the same request. Both requests will succeed, but the update will only happen once. A clientToken is valid for 8 hours.
The name of the consumable resource to be updated.
", "smithy.api#required": {} } }, "consumableResourceArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the consumable resource.
", "smithy.api#required": {} } }, "totalQuantity": { "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#documentation": "The total amount of the consumable resource that is available.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#UpdateJobQueue": { "type": "operation", "input": { "target": "com.amazonaws.batch#UpdateJobQueueRequest" }, "output": { "target": "com.amazonaws.batch#UpdateJobQueueResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Updates a job queue.
", "smithy.api#examples": [ { "title": "To update a job queue", "documentation": "This example disables a job queue so that it can be deleted.", "input": { "state": "DISABLED", "jobQueue": "GPGPU" }, "output": { "jobQueueName": "GPGPU", "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU" } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/updatejobqueue", "code": 200 } } }, "com.amazonaws.batch#UpdateJobQueueRequest": { "type": "structure", "members": { "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the job queue.
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.batch#JQState", "traits": { "smithy.api#documentation": "Describes the queue's ability to accept new jobs. If the job queue state is\n ENABLED, it can accept jobs. If the job queue state is DISABLED,\n new jobs can't be added to the queue, but jobs already in the queue can finish.
Amazon Resource Name (ARN) of the fair-share scheduling policy. Once a job queue is created, the fair-share\n scheduling policy can be replaced but not removed. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
The priority of the job queue. Job queues with a higher priority (or a higher integer\n value for the priority parameter) are evaluated first when associated with the\n same compute environment. Priority is determined in descending order. For example, a job queue\n with a priority value of 10 is given scheduling preference over a job queue with\n a priority value of 1. All of the compute environments must be either EC2\n (EC2 or SPOT) or Fargate (FARGATE or\n FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.
Details the set of compute environments mapped to a job queue and their order relative to\n each other. This is one of the parameters used by the job scheduler to determine which compute\n environment runs a given job. Compute environments must be in the VALID state\n before you can associate them with a job queue. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or\n FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same\n architecture. Batch doesn't support mixing compute environment architecture types in a\n single job queue.
\nThe order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.
" } }, "jobStateTimeLimitActions": { "target": "com.amazonaws.batch#JobStateTimeLimitActions", "traits": { "smithy.api#documentation": "The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)
Contains the parameters for UpdateJobQueue.
The name of the job queue.
" } }, "jobQueueArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job queue.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#UpdateManagedInstancesProviderConfiguration": { "type": "structure", "members": { "propagateTags": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "Specifies whether tags on the capacity provider are propagated to the Amazon EC2 instances it\n launches. Valid values:
\n\n CAPACITY_PROVIDER \u2014 Propagates tags to instances.
\n NONE \u2014 Does not propagate tags to instances.
The updated Amazon Resource Name (ARN) of the IAM role that Amazon ECS assumes to manage Amazon EC2 instances on\n your behalf.
" } }, "instanceLaunchTemplate": { "target": "com.amazonaws.batch#InstanceLaunchTemplateUpdate", "traits": { "smithy.api#documentation": "The updated instance launch configuration for the Amazon ECS Managed Instances capacity\n provider.
" } }, "infrastructureOptimization": { "target": "com.amazonaws.batch#InfrastructureOptimization", "traits": { "smithy.api#documentation": "The updated infrastructure optimization configuration.
" } } }, "traits": { "smithy.api#documentation": "The configuration for updating an Amazon ECS Managed Instances capacity provider. Used in\n UpdateComputeEnvironment requests. The capacityOptionType and\n fipsEnabled fields cannot be changed on update.
Specifies whether jobs are automatically terminated when the compute environment\n infrastructure is updated. The default value is false.
Specifies the job timeout (in minutes) when the compute environment infrastructure is\n updated. The default value is 30. The maximum value is 7200.
\nIncreasing jobExecutionTimeoutMinutes during infrastructure updates delays \n the replacement of instances with new instances that include updates such as security patches, \n but provides more time for jobs to execute. Consider the security implications of this tradeoff \n when setting timeout values.
Specifies the infrastructure update policy for the Amazon EC2 compute environment. For more information\n about infrastructure updates, see Updating compute environments in the\n Batch User Guide.
\nThe updatePolicy property applies only to Amazon EC2 managed compute environments.\n Batch doesn't support updatePolicy for Fargate compute environments. If you\n specify it for a Fargate compute environment, Batch ignores it.
Updates a quota share.
", "smithy.api#http": { "method": "POST", "uri": "/v1/updatequotashare", "code": 200 } } }, "com.amazonaws.batch#UpdateQuotaShareRequest": { "type": "structure", "members": { "quotaShareArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the quota share to update.
", "smithy.api#required": {} } }, "capacityLimits": { "target": "com.amazonaws.batch#QuotaShareCapacityLimits", "traits": { "smithy.api#documentation": "A list that specifies the quantity and type of compute capacity allocated to the quota share.
" } }, "resourceSharingConfiguration": { "target": "com.amazonaws.batch#QuotaShareResourceSharingConfiguration", "traits": { "smithy.api#documentation": "Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
" } }, "preemptionConfiguration": { "target": "com.amazonaws.batch#QuotaSharePreemptionConfiguration", "traits": { "smithy.api#documentation": "Specifies the preemption behavior for jobs in a quota share.
" } }, "state": { "target": "com.amazonaws.batch#QuotaShareState", "traits": { "smithy.api#documentation": "The state of the quota share. If the quota share is ENABLED, it is able to accept jobs.\n If the quota share is DISABLED, new jobs won't be accepted but jobs already submitted can finish.
The name of the quota share.
" } }, "quotaShareArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the quota share.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#UpdateSchedulingPolicy": { "type": "operation", "input": { "target": "com.amazonaws.batch#UpdateSchedulingPolicyRequest" }, "output": { "target": "com.amazonaws.batch#UpdateSchedulingPolicyResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Updates a scheduling policy.
", "smithy.api#http": { "method": "POST", "uri": "/v1/updateschedulingpolicy", "code": 200 } } }, "com.amazonaws.batch#UpdateSchedulingPolicyRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduling policy to update.
", "smithy.api#required": {} } }, "quotaSharePolicy": { "target": "com.amazonaws.batch#QuotaSharePolicy", "traits": { "smithy.api#documentation": "The quota share scheduling policy details. Once set during creation, a quotaSharePolicy cannot be removed or changed to a fairsharePolicy.
" } }, "fairsharePolicy": { "target": "com.amazonaws.batch#FairsharePolicy", "traits": { "smithy.api#documentation": "The fair-share policy scheduling details. Once set during creation, a fairsharePolicy cannot be removed or changed to a quotaSharePolicy.
" } } }, "traits": { "smithy.api#documentation": "Contains the parameters for UpdateSchedulingPolicy.
Updates a service environment. You can update the state of a service environment from ENABLED to DISABLED to prevent new service jobs from being placed in the service environment.
The name or ARN of the service environment to update.
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.batch#ServiceEnvironmentState", "traits": { "smithy.api#documentation": "The state of the service environment.
" } }, "capacityLimits": { "target": "com.amazonaws.batch#CapacityLimits", "traits": { "smithy.api#documentation": "The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#UpdateServiceEnvironmentResponse": { "type": "structure", "members": { "serviceEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the service environment that was updated.
", "smithy.api#required": {} } }, "serviceEnvironmentArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service environment that was updated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#UpdateServiceJob": { "type": "operation", "input": { "target": "com.amazonaws.batch#UpdateServiceJobRequest" }, "output": { "target": "com.amazonaws.batch#UpdateServiceJobResponse" }, "errors": [ { "target": "com.amazonaws.batch#ClientException" }, { "target": "com.amazonaws.batch#ServerException" } ], "traits": { "smithy.api#documentation": "Updates the priority of a specified service job in an Batch job queue.
", "smithy.api#http": { "method": "POST", "uri": "/v1/updateservicejob", "code": 200 } } }, "com.amazonaws.batch#UpdateServiceJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Batch job ID of the job to update.
", "smithy.api#required": {} } }, "schedulingPriority": { "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The scheduling priority for the job. This only affects jobs in job queues with a\n quota-share or fair-share scheduling policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority within a share.
\nThe minimum supported value is 0 and the maximum supported value is 9999.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.batch#UpdateServiceJobResponse": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the job.
" } }, "jobName": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The name of the job.
" } }, "jobId": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "The unique identifier for the job.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.batch#UserdataType": { "type": "enum", "members": { "EKS_BOOTSTRAP_SH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_BOOTSTRAP_SH" } }, "EKS_NODEADM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_NODEADM" } } } }, "com.amazonaws.batch#Volume": { "type": "structure", "members": { "host": { "target": "com.amazonaws.batch#Host", "traits": { "smithy.api#documentation": "The contents of the host parameter determine whether your data volume persists\n on the host container instance and where it's stored. If the host parameter is empty, then the\n Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to\n persist after the containers that are associated with it stop running.
This parameter isn't applicable to jobs that are running on Fargate resources and\n shouldn't be provided.
\nThe name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters,\n numbers, hyphens (-), and underscores (_). This name is referenced in the\n sourceVolume parameter of container definition mountPoints.
This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs\n that are running on Fargate resources must specify a platformVersion of at least\n 1.4.0.
This parameter is specified when you're using an S3Files file system for job storage.
" } } }, "traits": { "smithy.api#documentation": "A data volume that's used in a job's container properties.
" } }, "com.amazonaws.batch#Volumes": { "type": "list", "member": { "target": "com.amazonaws.batch#Volume" } } } }